Class ChatRetrievedDocument

The ChatRetrievedDocument.

Inheritance

System.Object

ChatRetrievedDocument

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.OpenAI.dll

Syntax

[OpenAI.CodeGenType("AzureChatMessageContextAllRetrievedDocuments")]
public class ChatRetrievedDocument : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.ChatRetrievedDocument>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.ChatRetrievedDocument>

Properties

ChunkId

The chunk ID for the citation.

Declaration

public string ChunkId { get; }

Property Value

System.String

Content

The content of the citation.

Declaration

public string Content { get; }

Property Value

System.String

DataSourceIndex

The index of the data source used for retrieval.

Declaration

public int DataSourceIndex { get; }

Property Value

System.Int32

FilePath

The file path for the citation.

Declaration

[OpenAI.CodeGenMember("Filepath")]
public string FilePath { get; }

Property Value

System.String

FilterReason

If applicable, an indication of why the document was filtered.

Declaration

public Nullable<Azure.AI.OpenAI.Chat.ChatDocumentFilterReason> FilterReason { get; }

Property Value

System.Nullable<ChatDocumentFilterReason>

OriginalSearchScore

The original search score for the retrieval.

Declaration

public Nullable<double> OriginalSearchScore { get; }

Property Value

System.Nullable<System.Double>

RerankScore

The rerank score for the retrieval.

Declaration

public Nullable<double> RerankScore { get; }

Property Value

System.Nullable<System.Double>

SearchQueries

The search queries executed to retrieve documents.

Declaration

public System.Collections.Generic.IList<string> SearchQueries { get; }

Property Value

System.Collections.Generic.IList<System.String>

Title

The title for the citation.

Declaration

public string Title { get; }

Property Value

System.String

Url

The URL of the citation.

Declaration

public string Url { get; }

Property Value

System.String

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.ChatRetrievedDocument JsonModelCreateCore (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The JSON reader.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

ChatRetrievedDocument

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.ChatRetrievedDocument PersistableModelCreateCore (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The data to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

ChatRetrievedDocument

PersistableModelWriteCore(ModelReaderWriterOptions)

Declaration

protected virtual BinaryData PersistableModelWriteCore (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

System.BinaryData

Operators

Explicit(ClientResult to ChatRetrievedDocument)

Declaration

public static explicit operator Azure.AI.OpenAI.Chat.ChatRetrievedDocument (System.ClientModel.ClientResult result);

Parameters

System.ClientModel.ClientResult result The System.ClientModel.ClientResult to deserialize the ChatRetrievedDocument from.

Returns

ChatRetrievedDocument

Implicit(ChatRetrievedDocument to BinaryContent)

Declaration

public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.ChatRetrievedDocument chatRetrievedDocument);

Parameters

ChatRetrievedDocument chatRetrievedDocument The ChatRetrievedDocument to serialize into System.ClientModel.BinaryContent.

Returns

System.ClientModel.BinaryContent

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.

Declaration

Azure.AI.OpenAI.Chat.ChatRetrievedDocument IJsonModel<ChatRetrievedDocument>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

ChatRetrievedDocument A T representation of the JSON value.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<ChatRetrievedDocument>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

void IJsonModel<ChatRetrievedDocument>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ChatRetrievedDocument>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.AI.OpenAI.Chat.ChatRetrievedDocument IPersistableModel<ChatRetrievedDocument>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

ChatRetrievedDocument A T representation of the data.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ChatRetrievedDocument>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration

string IPersistableModel<ChatRetrievedDocument>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns

System.String The format that the model uses when communicating with the serivce.

IPersistableModel<ChatRetrievedDocument>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<ChatRetrievedDocument>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

System.BinaryData A binary representation of the written model.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.