Package version:

Interface KnowledgeBaseRetrievalRequest

The input contract for the retrieval request.

interface KnowledgeBaseRetrievalRequest {
    includeActivity?: boolean;
    intents?: BaseKnowledgeRetrievalIntent[];
    knowledgeSourceParams?: KnowledgeSourceParams[];
    maxOutputSize?: number;
    maxRuntimeInSeconds?: number;
    messages?: KnowledgeBaseMessage[];
    outputMode?: string;
    retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;
}

Properties

includeActivity? intents? knowledgeSourceParams? maxOutputSize? maxRuntimeInSeconds? messages? outputMode? retrievalReasoningEffort?

Properties

OptionalincludeActivity

includeActivity?: boolean

Indicates retrieval results should include activity information.

Optionalintents

intents?: BaseKnowledgeRetrievalIntent[]

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

OptionalknowledgeSourceParams

knowledgeSourceParams?: KnowledgeSourceParams[]

A list of runtime parameters for the knowledge sources.

OptionalmaxOutputSize

maxOutputSize?: number

Limits the maximum size of the content in the output.

OptionalmaxRuntimeInSeconds

maxRuntimeInSeconds?: number

The maximum runtime in seconds.

Optionalmessages

messages?: KnowledgeBaseMessage[]

A list of chat message style input.

OptionaloutputMode

outputMode?: string

The output configuration for this retrieval.

OptionalretrievalReasoningEffort

retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion

Settings

Member Visibility