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

Explicit Interface Implementations

IJsonModel<ChatCitation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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 JSON reader.

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

Returns

ChatCitation

IJsonModel<ChatCitation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

void IJsonModel<ChatCitation>.Write (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.

IPersistableModel<ChatCitation>.Create(BinaryData, ModelReaderWriterOptions)

Declaration

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

IPersistableModel<ChatCitation>.GetFormatFromOptions(ModelReaderWriterOptions)

Declaration

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

Parameters

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

Returns

System.String

IPersistableModel<ChatCitation>.Write(ModelReaderWriterOptions)

Declaration

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

Parameters

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

Returns

System.BinaryData