ChatDataSource Class

Definition

Namespace:

Azure.AI.OpenAI.Chat

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v2.0.0

Source:

ChatDataSource.cs

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 ChatDataSource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CosmosChatDataSource, AzureSearchChatDataSource, Azure.AI.OpenAI.Chat.ElasticsearchChatDataSource, Azure.AI.OpenAI.Chat.MongoDBChatDataSource and Azure.AI.OpenAI.Chat.PineconeChatDataSource.

[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>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.Chat.InternalUnknownAzureChatDataSource))>]
type ChatDataSource = class
    interface IJsonModel<ChatDataSource>
    interface IPersistableModel<ChatDataSource>

Public MustInherit Class ChatDataSource
Implements IJsonModel(Of ChatDataSource), IPersistableModel(Of ChatDataSource)

Inheritance

Object

ChatDataSource

Derived

Azure.AI.OpenAI.Chat.AzureSearchChatDataSource

Azure.AI.OpenAI.Chat.CosmosChatDataSource

Attributes

PersistableModelProxyAttribute

Implements

IJsonModel<ChatDataSource> IPersistableModel<ChatDataSource> IPersistableModel<T>

Constructors

ChatDataSource()

Initializes a new instance of ChatDataSource.

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.
IJsonModel<ChatDataSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ChatDataSource>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ChatDataSource>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.