Share via

AzureChatExtensionDataSourceResponseCitation Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation

Implements

JsonSerializable<AzureChatExtensionDataSourceResponseCitation>

public final class AzureChatExtensionDataSourceResponseCitation
implements 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 Summary

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

Reads an instance of AzureChatExtensionDataSourceResponseCitation 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.
String getFilepath()

Get the filepath property: The file path of the citation.
Double getRerankScore()

Get the rerankScore property: The rerank score of the retrieved 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 AzureChatExtensionDataSourceResponseCitation fromJson(JsonReader jsonReader)

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:

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.

getFilepath

public String getFilepath()

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

Returns:

the filepath value.

getRerankScore

public Double getRerankScore()

Get the rerankScore property: The rerank score of the retrieved document.

Returns:

the rerankScore 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