SearchModelFactory.KnowledgeBaseRetrievalResponse Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
SearchModelFactory.cs
Source:
SearchModelFactory.cs

The output contract for the retrieval response.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse KnowledgeBaseRetrievalResponse(System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMessage> response = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord> activity = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference> references = default);
static member KnowledgeBaseRetrievalResponse : seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMessage> * seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord> * seq<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference> -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse
Public Shared Function KnowledgeBaseRetrievalResponse (Optional response As IEnumerable(Of KnowledgeBaseMessage) = Nothing, Optional activity As IEnumerable(Of KnowledgeBaseActivityRecord) = Nothing, Optional references As IEnumerable(Of KnowledgeBaseReference) = Nothing) As KnowledgeBaseRetrievalResponse

Parameters

response
IEnumerable<KnowledgeBaseMessage>

The response messages.

activity
IEnumerable<KnowledgeBaseActivityRecord>

The activity records for tracking progress and billing implications.

references
IEnumerable<KnowledgeBaseReference>

The references for the retrieval data used in the response.

Returns

KnowledgeBaseRetrievalResponse

A new KnowledgeBaseRetrievalResponse instance for mocking.

Applies to