InferenceClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Azure Data AI provides semantic reranking operations.
public class InferenceClient
type InferenceClient = class
Public Class InferenceClient
- Inheritance
-
InferenceClient
Constructors
| Name | Description |
|---|---|
| InferenceClient() |
Initializes a new instance of InferenceClient for mocking. |
| InferenceClient(InferenceClientSettings) |
Initializes a new instance of InferenceClient from a InferenceClientSettings. |
| InferenceClient(Uri, AzureKeyCredential, InferenceClientOptions) |
Initializes a new instance of InferenceClient. |
| InferenceClient(Uri, AzureKeyCredential) |
Initializes a new instance of InferenceClient. |
| InferenceClient(Uri, TokenCredential, InferenceClientOptions) |
Initializes a new instance of InferenceClient. |
| InferenceClient(Uri, TokenCredential) |
Initializes a new instance of InferenceClient. |
Properties
| Name | Description |
|---|---|
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
| Name | Description |
|---|---|
| GetEmbeddings(IEnumerable<EmbeddingInput>, String, Nullable<EmbeddingVectorKind>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<EmbeddingOutputDataKind>, Nullable<EmbeddingEncodingFormat>, Nullable<EmbeddingDelivery>, CancellationToken) |
Embeds text, queries and document images and returns dense or multi-vector embeddings as numbers or base64. Text
and queries are sent inline. Images are read from the caller's Azure Blob Storage with a caller-signed user
delegation SAS (Microsoft Entra callers only). Results come back in the response or, with |
| GetEmbeddings(IEnumerable<Object>, String, Nullable<EmbeddingVectorKind>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<EmbeddingOutputDataKind>, Nullable<EmbeddingEncodingFormat>, Nullable<EmbeddingDelivery>, CancellationToken) |
Embeds text, queries and document images using loosely typed items, for example anonymous objects or dictionaries.
Each item is serialized to JSON with JsonSerializer using camelCase property and dictionary key naming and must produce
a JSON object with only the wire properties |
| GetEmbeddings(RequestContent, RequestContext) |
[Protocol Method] Embeds text, queries and document images and returns dense or multi-vector embeddings as numbers or base64. Text
and queries are sent inline. Images are read from the caller's Azure Blob Storage with a caller-signed user
delegation SAS (Microsoft Entra callers only). Results come back in the response or, with
|
| GetEmbeddingsAsync(IEnumerable<EmbeddingInput>, String, Nullable<EmbeddingVectorKind>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<EmbeddingOutputDataKind>, Nullable<EmbeddingEncodingFormat>, Nullable<EmbeddingDelivery>, CancellationToken) |
Embeds text, queries and document images and returns dense or multi-vector embeddings as numbers or base64. Text
and queries are sent inline. Images are read from the caller's Azure Blob Storage with a caller-signed user
delegation SAS (Microsoft Entra callers only). Results come back in the response or, with |
| GetEmbeddingsAsync(IEnumerable<Object>, String, Nullable<EmbeddingVectorKind>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<EmbeddingOutputDataKind>, Nullable<EmbeddingEncodingFormat>, Nullable<EmbeddingDelivery>, CancellationToken) |
Embeds text, queries and document images using loosely typed items, for example anonymous objects or dictionaries.
Each item is serialized to JSON with JsonSerializer using camelCase property and dictionary key naming and must produce
a JSON object with only the wire properties |
| GetEmbeddingsAsync(RequestContent, RequestContext) |
[Protocol Method] Embeds text, queries and document images and returns dense or multi-vector embeddings as numbers or base64. Text
and queries are sent inline. Images are read from the caller's Azure Blob Storage with a caller-signed user
delegation SAS (Microsoft Entra callers only). Results come back in the response or, with
|
| SemanticRerank(RequestContent, RequestContext) |
[Protocol Method] Reranks documents by their relevance to a query.
|
| SemanticRerank(SemanticRerankingContent, CancellationToken) |
Reranks documents by their relevance to a query. |
| SemanticRerankAsync(RequestContent, RequestContext) |
[Protocol Method] Reranks documents by their relevance to a query.
|
| SemanticRerankAsync(SemanticRerankingContent, CancellationToken) |
Reranks documents by their relevance to a query. |