KnowledgeBaseRetrievalRequest interface
The input contract for the retrieval request.
Properties
| include |
Indicates retrieval results should include activity information. |
| intents | A list of intended queries to execute without model query planning. |
| knowledge |
A list of runtime parameters for the knowledge sources. |
| max |
Limits the maximum number of documents in the output. |
| max |
Limits the maximum size of the content in the output. |
| max |
Limits the maximum size of the content in the output. |
| max |
The maximum runtime in seconds. |
| messages | A list of chat message style input. |
| output |
The output configuration for this retrieval. |
| retrieval |
The retrieval reasoning effort configuration. |
Property Details
includeActivity
Indicates retrieval results should include activity information.
includeActivity?: booleanProperty Value
boolean
intents
A list of intended queries to execute without model query planning.
intents?: KnowledgeRetrievalIntentUnion[]Property Value
knowledgeSourceParams
A list of runtime parameters for the knowledge sources.
knowledgeSourceParams?: KnowledgeSourceParamsUnion[]Property Value
maxOutputDocuments
Limits the maximum number of documents in the output.
maxOutputDocuments?: numberProperty Value
number
maxOutputSize
Limits the maximum size of the content in the output.
maxOutputSize?: numberProperty Value
number
maxOutputSizeInTokens
Limits the maximum size of the content in the output.
maxOutputSizeInTokens?: numberProperty Value
number
maxRuntimeInSeconds
The maximum runtime in seconds.
maxRuntimeInSeconds?: numberProperty Value
number
messages
A list of chat message style input.
messages?: KnowledgeBaseMessage[]Property Value
outputMode
The output configuration for this retrieval.
outputMode?: stringProperty Value
string
retrievalReasoningEffort
The retrieval reasoning effort configuration.
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion