AzureCosmosDBChatDataSource Class

Reference

Definition

Namespace:: Azure.AI.OpenAI.Chat

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v2.0.0-beta.2

Source:: AzureCosmosDBChatDataSource.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.

Represents a data source configuration that will use an Azure CosmosDB resource.

public class AzureCosmosDBChatDataSource : Azure.AI.OpenAI.Chat.AzureChatDataSource, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.AzureCosmosDBChatDataSource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.AzureCosmosDBChatDataSource>

type AzureCosmosDBChatDataSource = class
    inherit AzureChatDataSource
    interface IJsonModel<AzureCosmosDBChatDataSource>
    interface IPersistableModel<AzureCosmosDBChatDataSource>

Public Class AzureCosmosDBChatDataSource
Inherits AzureChatDataSource
Implements IJsonModel(Of AzureCosmosDBChatDataSource), IPersistableModel(Of AzureCosmosDBChatDataSource)

Inheritance: Object

AzureChatDataSource
AzureCosmosDBChatDataSource

Implements: IJsonModel<AzureCosmosDBChatDataSource> IPersistableModel<AzureCosmosDBChatDataSource> IPersistableModel<T>

Constructors

AzureCosmosDBChatDataSource()

Obsolete.

Initializes a new instance of AzureCosmosDBChatDataSource.

Properties

AllowPartialResult	If set to true, the system will allow partial search results to be used and the request will fail if all partial queries fail. If not specified or specified as false, the request will fail if any search query fails.
Authentication	The authentication options to use with the Azure CosmosDB data source.
ContainerName	Gets the container name.
DatabaseName	Gets the database name.
FieldMappings	Gets the index field mappings.
IndexName	Gets the index name.
InScope	Whether queries should be restricted to use of the indexed data.
MaxSearchQueries	The maximum number of rewritten queries that should be sent to the search provider for a single user message. By default, the system will make an automatic determination.
OutputContextFlags	The `include_context` flags to request for an On Your Data retrieval result, which control what information will be available on AzureChatMessageContext instances in the response.
RoleInformation	Additional instructions for the model to inform how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. This is limited to 100 tokens and counts against the overall token limit.
Strictness	The configured strictness of the search relevance filtering. Higher strictness will increase precision but lower recall of the answer.
TopNDocuments	The configured number of documents to feature in the query.
VectorizationSource	The vectorization dependency used for embeddings.

Explicit Interface Implementations

IJsonModel<AzureChatDataSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from AzureChatDataSource)
IJsonModel<AzureChatDataSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from AzureChatDataSource)
IJsonModel<AzureCosmosDBChatDataSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureCosmosDBChatDataSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AzureChatDataSource>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from AzureChatDataSource)
IPersistableModel<AzureChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from AzureChatDataSource)
IPersistableModel<AzureChatDataSource>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from AzureChatDataSource)
IPersistableModel<AzureCosmosDBChatDataSource>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AzureCosmosDBChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureCosmosDBChatDataSource>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via