ImageEmbeddingsAsyncClient 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.ImageEmbeddingsAsyncClient

public final class ImageEmbeddingsAsyncClient

Initializes a new instance of the asynchronous ImageEmbeddingsClient type.

Method Summary

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

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 Mono<EmbeddingsResult> embed(List<ImageEmbeddingInput> input)

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

Parameters:

input - Inputs, instances of ImageEmbeddingsInput. 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. Image embeddings measure the relatedness of images and are commonly used for search, clustering, recommendations, and other similar scenarios on successful completion of Mono.

Applies to