Package com.azure.ai.openai.models

Class AzureChatExtensionDataSourceResponseCitation

java.lang.Object
com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureChatExtensionDataSourceResponseCitation>
public final class AzureChatExtensionDataSourceResponseCitation extends Object implements com.azure.json.JsonSerializable<AzureChatExtensionDataSourceResponseCitation>
A single instance of additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response. This context information is only populated when using an Azure OpenAI request configured to use a matching extension.

  • Method Details

    • getContent

      public String getContent()
      Get the content property: The content of the citation.
      Returns:
      the content value.

    • getTitle

      public String getTitle()
      Get the title property: The title of the citation.
      Returns:
      the title value.

    • getUrl

      public String getUrl()
      Get the url property: The URL of the citation.
      Returns:
      the url value.

    • getFilepath

      public String getFilepath()
      Get the filepath property: The file path of the citation.
      Returns:
      the filepath value.

    • getChunkId

      public String getChunkId()
      Get the chunkId property: The chunk ID of the citation.
      Returns:
      the chunkId value.

    • toJson

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

    • fromJson

      public static AzureChatExtensionDataSourceResponseCitation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AzureChatExtensionDataSourceResponseCitation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AzureChatExtensionDataSourceResponseCitation 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 AzureChatExtensionDataSourceResponseCitation.

    • getRerankScore

      public Double getRerankScore()
      Get the rerankScore property: The rerank score of the retrieved document.
      Returns:
      the rerankScore value.