SearchModelFactory.KnowledgeBaseRetrievalRequest Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.1

Source:

SearchModelFactory.cs

The input contract for the retrieval request.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest KnowledgeBaseRetrievalRequest(System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMessage> messages = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalIntent> intents = default, int? maxRuntimeInSeconds = default, int? maxOutputSize = default, int? maxOutputDocuments = default, int? maxOutputSizeInTokens = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort retrievalReasoningEffort = default, bool? includeActivity = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalOutputMode? outputMode = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams> knowledgeSourceParams = default);

static member KnowledgeBaseRetrievalRequest : seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMessage> * seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalIntent> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int> * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort * Nullable<bool> * Nullable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalOutputMode> * seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams> -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest

Public Shared Function KnowledgeBaseRetrievalRequest (Optional messages As IEnumerable(Of KnowledgeBaseMessage) = Nothing, Optional intents As IEnumerable(Of KnowledgeRetrievalIntent) = Nothing, Optional maxRuntimeInSeconds As Nullable(Of Integer) = Nothing, Optional maxOutputSize As Nullable(Of Integer) = Nothing, Optional maxOutputDocuments As Nullable(Of Integer) = Nothing, Optional maxOutputSizeInTokens As Nullable(Of Integer) = Nothing, Optional retrievalReasoningEffort As KnowledgeRetrievalReasoningEffort = Nothing, Optional includeActivity As Nullable(Of Boolean) = Nothing, Optional outputMode As Nullable(Of KnowledgeRetrievalOutputMode) = Nothing, Optional knowledgeSourceParams As IEnumerable(Of KnowledgeSourceParams) = Nothing) As KnowledgeBaseRetrievalRequest

Parameters

messages

IEnumerable<KnowledgeBaseMessage>

A list of chat message style input.

intents

IEnumerable<KnowledgeRetrievalIntent>

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

maxRuntimeInSeconds

Nullable<Int32>

The maximum runtime in seconds.

maxOutputSize

Nullable<Int32>

Limits the maximum size of the content in the output.

maxOutputDocuments

Nullable<Int32>

Limits the maximum number of documents in the output.

maxOutputSizeInTokens

Nullable<Int32>

Limits the maximum size of the content in the output.

retrievalReasoningEffort

KnowledgeRetrievalReasoningEffort

The retrieval reasoning effort configuration.

includeActivity

Nullable<Boolean>

Indicates retrieval results should include activity information.

outputMode

Nullable<KnowledgeRetrievalOutputMode>

The output configuration for this retrieval.

knowledgeSourceParams

IEnumerable<KnowledgeSourceParams>

A list of runtime parameters for the knowledge sources.

Returns

KnowledgeBaseRetrievalRequest

A new KnowledgeBaseRetrievalRequest instance for mocking.