Share via

AzureChatExtensionRetrievedDocument Class

Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.16
  • java.lang.Object
    • com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument

Implements

JsonSerializable<AzureChatExtensionRetrievedDocument>

public final class AzureChatExtensionRetrievedDocument
implements JsonSerializable<AzureChatExtensionRetrievedDocument>

The retrieved document.

Method Summary

Modifier and Type Method and Description
static AzureChatExtensionRetrievedDocument fromJson(JsonReader jsonReader)

Reads an instance of AzureChatExtensionRetrievedDocument from the JsonReader.
String getChunkId()

Get the chunkId property: The chunk ID of the citation.
String getContent()

Get the content property: The content of the citation.
int getDataSourceIndex()

Get the dataSourceIndex property: The index of the data source.
String getFilepath()

Get the filepath property: The file path of the citation.
AzureChatExtensionRetrieveDocumentFilterReason getFilterReason()

Get the filterReason property: Represents the rationale for filtering the document.
Double getOriginalSearchScore()

Get the originalSearchScore property: The original search score of the retrieved document.
Double getRerankScore()

Get the rerankScore property: The rerank score of the retrieved document.
List<String> getSearchQueries()

Get the searchQueries property: The search queries used to retrieve the document.
String getTitle()

Get the title property: The title of the citation.
String getUrl()

Get the url property: The URL of the citation.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static AzureChatExtensionRetrievedDocument fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getChunkId

public String getChunkId()

Get the chunkId property: The chunk ID of the citation.

Returns:

the chunkId value.

getContent

public String getContent()

Get the content property: The content of the citation.

Returns:

the content value.

getDataSourceIndex

public int getDataSourceIndex()

Get the dataSourceIndex property: The index of the data source.

Returns:

the dataSourceIndex value.

getFilepath

public String getFilepath()

Get the filepath property: The file path of the citation.

Returns:

the filepath 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.

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.

getSearchQueries

public List<String> getSearchQueries()

Get the searchQueries property: The search queries used to retrieve the document.

Returns:

the searchQueries 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to