KnowledgeBaseRetrievalResult

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

content

Contains information about the content of the chunk.

Required: Yes

documentId

The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1825.

Pattern: \P{C}*

Required: No

location

Contains information about the location of the data source.

Required: No

metadata

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Type: String to JSON value map

Map Entries: Maximum number of items.

Key Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

score

The level of relevance of the result to the query.

Type: Double

Required: No

Contents