Class ChatCitation

The ChatCitation.

Inheritance

System.Object

ChatCitation

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.OpenAI.dll

Syntax

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

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

FilePath

The file path for the citation.

Declaration

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

Property Value

System.String

RerankScore

The rerank score for the retrieval.

Declaration

public Nullable<double> RerankScore { get; }

Property Value

System.Nullable<System.Double>

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

ChatCitation

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

ChatCitation

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 ChatCitation)

Declaration

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

Parameters

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

Returns

ChatCitation

Implicit(ChatCitation to BinaryContent)

Declaration

public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.ChatCitation chatCitation);

Parameters

ChatCitation chatCitation The ChatCitation to serialize into System.ClientModel.BinaryContent.

Returns

System.ClientModel.BinaryContent

Explicit Interface Implementations

IJsonModel<ChatCitation>.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.ChatCitation IJsonModel<ChatCitation>.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

ChatCitation A T representation of the JSON value.

Exceptions

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

IJsonModel<ChatCitation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

Declaration

void IJsonModel<ChatCitation>.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<ChatCitation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.AI.OpenAI.Chat.ChatCitation IPersistableModel<ChatCitation>.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

ChatCitation A T representation of the data.

Exceptions

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

IPersistableModel<ChatCitation>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration

string IPersistableModel<ChatCitation>.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<ChatCitation>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<ChatCitation>.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.