KnowledgeBaseRetrievalRequest interface

Package:

@azure/search-documents

The input contract for the retrieval request.

Properties

includeActivity	Indicates retrieval results should include activity information.
intents	A list of intended queries to execute without model query planning.
knowledgeSourceParams	A list of runtime parameters for the knowledge sources.
maxOutputSizeInTokens	Limits the maximum size of the content in the output.
maxRuntimeInSeconds	The maximum runtime in seconds.

Property Details

includeActivity

Indicates retrieval results should include activity information.

includeActivity?: boolean

Property Value

boolean

intents

A list of intended queries to execute without model query planning.

intents?: KnowledgeRetrievalIntentUnion[]

Property Value

BaseKnowledgeRetrievalIntent[]

knowledgeSourceParams

A list of runtime parameters for the knowledge sources.

knowledgeSourceParams?: KnowledgeSourceParamsUnion[]

Property Value

KnowledgeSourceParams[]

maxOutputSizeInTokens

Limits the maximum size of the content in the output.

maxOutputSizeInTokens?: number

Property Value

number

maxRuntimeInSeconds

The maximum runtime in seconds.

maxRuntimeInSeconds?: number

Property Value

number