Show / Hide Table of Contents

Class ChatDataSource

A representation of configuration data for a single Azure OpenAI chat data source. This will be used by a chat completions request that should use Azure OpenAI chat extensions to augment the response behavior. The use of this configuration is compatible only with Azure OpenAI. Please note this is the abstract base class. The derived classes available for instantiation are: AzureSearchChatDataSource, CosmosChatDataSource, ElasticsearchChatDataSource, PineconeChatDataSource, and MongoDBChatDataSource.

Inheritance
System.Object
ChatDataSource
AzureSearchChatDataSource
CosmosChatDataSource
ElasticsearchChatDataSource
MongoDBChatDataSource
PineconeChatDataSource
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.AI.OpenAI.dll
Syntax
[OpenAI.CodeGenType("AzureChatDataSource")]
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.Chat.InternalUnknownAzureChatDataSource))]
public abstract class ChatDataSource : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.ChatDataSource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.ChatDataSource>

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)

Declaration
protected virtual Azure.AI.OpenAI.Chat.ChatDataSource 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
ChatDataSource

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

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

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

The System.ClientModel.ClientResult to deserialize the ChatDataSource from.

Returns
ChatDataSource

Implicit(ChatDataSource to BinaryContent)

Declaration
public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.ChatDataSource chatDataSource);
Parameters
ChatDataSource chatDataSource

The ChatDataSource to serialize into System.ClientModel.BinaryContent.

Returns
System.ClientModel.BinaryContent

Explicit Interface Implementations

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

A T representation of the JSON value.

Exceptions
System.FormatException

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

IJsonModel<ChatDataSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

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

Converts the provided System.BinaryData into a model.

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

A T representation of the data.

Exceptions
System.FormatException

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

IPersistableModel<ChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

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

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<ChatDataSource>.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.

Back to top Azure SDK for .NET