Package com.azure.ai.inference.models

Class EmbeddingsResult

java.lang.Object
com.azure.ai.inference.models.EmbeddingsResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<EmbeddingsResult>
public final class EmbeddingsResult extends Object implements com.azure.json.JsonSerializable<EmbeddingsResult>
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.

  • Method Summary

    Modifier and Type
    Method
    Description
    static EmbeddingsResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of EmbeddingsResult from the JsonReader.
    List<EmbeddingItem>
    getData()
    Get the data property: Embedding values for the prompts submitted in the request.
    String
    getId()
    Get the id property: Unique identifier for the embeddings result.
    String
    getModel()
    Get the model property: The model ID used to generate this result.
    EmbeddingsUsage
    getUsage()
    Get the usage property: Usage counts for tokens input using the embeddings API.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getData

      public List<EmbeddingItem> getData()
      Get the data property: Embedding values for the prompts submitted in the request.
      Returns:
      the data value.

    • getUsage

      public EmbeddingsUsage getUsage()
      Get the usage property: Usage counts for tokens input using the embeddings API.
      Returns:
      the usage value.

    • getModel

      public String getModel()
      Get the model property: The model ID used to generate this result.
      Returns:
      the model value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<EmbeddingsResult>
      Throws:
      IOException

    • fromJson

      public static EmbeddingsResult fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of EmbeddingsResult from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of EmbeddingsResult if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the EmbeddingsResult.

    • getId

      public String getId()
      Get the id property: Unique identifier for the embeddings result.
      Returns:
      the id value.