你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ChatRetrievedDocument Class

Reference

Definition

Namespace:: Azure.AI.OpenAI.Chat

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v2.1.0

Package:: Azure.AI.OpenAI v2.2.0-beta.2

Source:: ChatRetrievedDocument.cs

Source:: ChatRetrievedDocument.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The AzureChatMessageContextAllRetrievedDocuments.

public class ChatRetrievedDocument : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.ChatRetrievedDocument>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.ChatRetrievedDocument>

type ChatRetrievedDocument = class
    interface IJsonModel<ChatRetrievedDocument>
    interface IPersistableModel<ChatRetrievedDocument>

Public Class ChatRetrievedDocument
Implements IJsonModel(Of ChatRetrievedDocument), IPersistableModel(Of ChatRetrievedDocument)

Inheritance: Object
ChatRetrievedDocument

Implements: IJsonModel<ChatRetrievedDocument> IPersistableModel<ChatRetrievedDocument> IPersistableModel<T>

Properties

ChunkId	The chunk ID for the citation.
Content	The content of the citation.
DataSourceIndex	The index of the data source used for retrieval.
FilePath	The file path for the citation.
FilterReason	If applicable, an indication of why the document was filtered.
OriginalSearchScore	The original search score for the retrieval.
RerankScore	The rerank score for the retrieval.
SearchQueries	The search queries executed to retrieve documents.
Title	The title for the citation.
Url	The URL of the citation.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ChatRetrievedDocument>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ChatRetrievedDocument>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ChatRetrievedDocument>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ChatRetrievedDocument>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ChatRetrievedDocument>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

通过