ChatDataSource Class

Reference

Definition

Namespace:: Azure.AI.OpenAI.Chat

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v2.1.0

Package:: Azure.AI.OpenAI v2.2.0-beta.4

Source:: ChatDataSource.cs

Source:: ChatDataSource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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, Azure.AI.OpenAI.Chat.ElasticsearchChatDataSource, Azure.AI.OpenAI.Chat.PineconeChatDataSource, and Azure.AI.OpenAI.Chat.MongoDBChatDataSource.

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

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Explicit(ClientResult to ChatDataSource)
Implicit(ChatDataSource to 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.
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.

Applies to

Dela via