InferenceModelFactory.SemanticRerankingInferenceContent Method

Definition

Namespace:

Azure.Data.AI

Assembly:

Azure.Data.AI.dll

Package:

Azure.Data.AI v1.0.0-beta.1

Source:

InferenceModelFactory.cs

The input for a semantic reranking operation.

public static Azure.Data.AI.SemanticRerankingInferenceContent SemanticRerankingInferenceContent(string query = default, System.Collections.Generic.IEnumerable<string> documents = default, bool? returnDocuments = default, int? topK = default, int? batchSize = default, bool? sort = default, Azure.Data.AI.SemanticRerankingDocumentType? documentType = default, string targetPaths = default, string model = default, bool? returnSentenceScore = default);

static member SemanticRerankingInferenceContent : string * seq<string> * Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<Azure.Data.AI.SemanticRerankingDocumentType> * string * string * Nullable<bool> -> Azure.Data.AI.SemanticRerankingInferenceContent

Public Shared Function SemanticRerankingInferenceContent (Optional query As String = Nothing, Optional documents As IEnumerable(Of String) = Nothing, Optional returnDocuments As Nullable(Of Boolean) = Nothing, Optional topK As Nullable(Of Integer) = Nothing, Optional batchSize As Nullable(Of Integer) = Nothing, Optional sort As Nullable(Of Boolean) = Nothing, Optional documentType As Nullable(Of SemanticRerankingDocumentType) = Nothing, Optional targetPaths As String = Nothing, Optional model As String = Nothing, Optional returnSentenceScore As Nullable(Of Boolean) = Nothing) As SemanticRerankingInferenceContent

Parameters

query

String

The query used to rank the documents.

documents

IEnumerable<String>

The documents to rank against the query.

returnDocuments

Nullable<Boolean>

Whether the response should include the submitted documents.

topK

Nullable<Int32>

The maximum number of ranked documents to return.

batchSize

Nullable<Int32>

The number of documents processed in each batch.

sort

Nullable<Boolean>

Whether to return documents sorted by relevance score.

documentType

Nullable<SemanticRerankingDocumentType>

The format of the submitted documents.

targetPaths

String

The property containing text to rank when the document type is JSON. This property is required for JSON documents. Use dot notation for a nested property, for example meta.content. You can specify multiple property paths separated by commas, for example meta.content,id.

model

String

The name of the model used for the semantic reranking operation.

returnSentenceScore

Nullable<Boolean>

Whether to return sentence-level scores in the response.

Returns

SemanticRerankingInferenceContent

A new SemanticRerankingInferenceContent instance for mocking.