Package com.azure.ai.inference

Class ImageEmbeddingsAsyncClient

java.lang.Object
com.azure.ai.inference.ImageEmbeddingsAsyncClient
public final class ImageEmbeddingsAsyncClient extends Object
Initializes a new instance of the asynchronous ImageEmbeddingsClient type.

  • 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.