SearchModelFactory.KnowledgeBaseRetrievalRequest Method

Definition

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.KnowledgeRetrievalIntent> intents = default, int? maxRuntimeInSeconds = default, int? maxOutputSizeInTokens = default, bool? includeActivity = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams> knowledgeSourceParams = default);
static member KnowledgeBaseRetrievalRequest : seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalIntent> * Nullable<int> * Nullable<int> * Nullable<bool> * seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams> -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest
Public Shared Function KnowledgeBaseRetrievalRequest (Optional intents As IEnumerable(Of KnowledgeRetrievalIntent) = Nothing, Optional maxRuntimeInSeconds As Nullable(Of Integer) = Nothing, Optional maxOutputSizeInTokens As Nullable(Of Integer) = Nothing, Optional includeActivity As Nullable(Of Boolean) = Nothing, Optional knowledgeSourceParams As IEnumerable(Of KnowledgeSourceParams) = Nothing) As KnowledgeBaseRetrievalRequest

Parameters

intents
IEnumerable<KnowledgeRetrievalIntent>

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

maxRuntimeInSeconds
Nullable<Int32>

The maximum runtime in seconds.

maxOutputSizeInTokens
Nullable<Int32>

Limits the maximum size of the content in the output.

includeActivity
Nullable<Boolean>

Indicates retrieval results should include activity information.

knowledgeSourceParams
IEnumerable<KnowledgeSourceParams>

A list of runtime parameters for the knowledge sources.

Returns

A new KnowledgeBaseRetrievalRequest instance for mocking.

Applies to