ImageEmbeddingsClient Class

Package:
com.azure.ai.inference
Maven Artifact:
com.azure:azure-ai-inference:1.0.0-beta.5
  • java.lang.Object
    • com.azure.ai.inference.ImageEmbeddingsClient

public final class ImageEmbeddingsClient

Initializes a new instance of the synchronous ImageEmbeddingsClient type.

Method Summary

Modifier and Type Method and Description
EmbeddingsResult embed(List<ImageEmbeddingInput> inputs)

Return the embedding vectors for given text prompts.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

embed

public EmbeddingsResult embed(List<ImageEmbeddingInput> inputs)

Return the embedding vectors for given text prompts. The method makes a REST API call to the `/embeddings` route on the given endpoint.

Parameters:

inputs - ImageEmbeddingInput instances to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays.

Returns:

representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.

Applies to