Package com.azure.ai.openai.models

Class AzureChatExtensionRetrievedDocument

java.lang.Object
com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureChatExtensionRetrievedDocument>
public final class AzureChatExtensionRetrievedDocument extends Object implements com.azure.json.JsonSerializable<AzureChatExtensionRetrievedDocument>
The retrieved document.

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

    • getSearchQueries

      public List<String> getSearchQueries()
      Get the searchQueries property: The search queries used to retrieve the document.
      Returns:
      the searchQueries value.

    • getDataSourceIndex

      public int getDataSourceIndex()
      Get the dataSourceIndex property: The index of the data source.
      Returns:
      the dataSourceIndex value.

    • getOriginalSearchScore

      public Double getOriginalSearchScore()
      Get the originalSearchScore property: The original search score of the retrieved document.
      Returns:
      the originalSearchScore value.

    • getRerankScore

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

    • getFilterReason

      public AzureChatExtensionRetrieveDocumentFilterReason getFilterReason()
      Get the filterReason property: Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset.
      Returns:
      the filterReason value.

    • toJson

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

    • fromJson

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