ImageEmbeddingsClient Class

Definition

Namespace:

Azure.AI.Inference

Assembly:

Azure.AI.Inference.dll

Package:

Azure.AI.Inference v1.0.0-beta.3

Source:

ImageEmbeddingsClient.cs

The ImageEmbeddings service client.

public class ImageEmbeddingsClient

type ImageEmbeddingsClient = class

Public Class ImageEmbeddingsClient

Inheritance

Object

ImageEmbeddingsClient

Constructors

ImageEmbeddingsClient()	Initializes a new instance of ImageEmbeddingsClient for mocking.
ImageEmbeddingsClient(Uri, AzureKeyCredential, AzureAIInferenceClientOptions)	Initializes a new instance of ImageEmbeddingsClient.
ImageEmbeddingsClient(Uri, AzureKeyCredential)	Initializes a new instance of ImageEmbeddingsClient.
ImageEmbeddingsClient(Uri, TokenCredential, AzureAIInferenceClientOptions)	Initializes a new instance of ImageEmbeddingsClient.
ImageEmbeddingsClient(Uri, TokenCredential)	Initializes a new instance of ImageEmbeddingsClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Embed(ImageEmbeddingsOptions, CancellationToken)	Return the embedding vectors for given images. The method makes a REST API call to the /images/embeddings route on the given endpoint.
EmbedAsync(ImageEmbeddingsOptions, CancellationToken)	Return the embedding vectors for given images. The method makes a REST API call to the /images/embeddings route on the given endpoint.
GetModelInfo(CancellationToken)	Returns information about the AI model. The method makes a REST API call to the /info route on the given endpoint. This method will only work when using Serverless API or Managed Compute endpoint. It will not work for GitHub Models endpoint or Azure OpenAI endpoint.
GetModelInfo(RequestContext)	[Protocol Method] Returns information about the AI model. The method makes a REST API call to the /info route on the given endpoint. This method will only work when using Serverless API or Managed Compute endpoint. It will not work for GitHub Models endpoint or Azure OpenAI endpoint. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetModelInfo(CancellationToken) convenience overload with strongly typed models first.
GetModelInfoAsync(CancellationToken)	Returns information about the AI model. The method makes a REST API call to the /info route on the given endpoint. This method will only work when using Serverless API or Managed Compute endpoint. It will not work for GitHub Models endpoint or Azure OpenAI endpoint.
GetModelInfoAsync(RequestContext)	[Protocol Method] Returns information about the AI model. The method makes a REST API call to the /info route on the given endpoint. This method will only work when using Serverless API or Managed Compute endpoint. It will not work for GitHub Models endpoint or Azure OpenAI endpoint. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetModelInfoAsync(CancellationToken) convenience overload with strongly typed models first.