CosmosChatDataSource Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Chat
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v2.0.0
Package:
Azure.AI.OpenAI v2.1.0-beta.1

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

public class CosmosChatDataSource : Azure.AI.OpenAI.Chat.ChatDataSource, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.CosmosChatDataSource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.CosmosChatDataSource>
type CosmosChatDataSource = class
    inherit ChatDataSource
    interface IJsonModel<CosmosChatDataSource>
    interface IPersistableModel<CosmosChatDataSource>
Public Class CosmosChatDataSource
Inherits ChatDataSource
Implements IJsonModel(Of CosmosChatDataSource), IPersistableModel(Of CosmosChatDataSource)
Inheritance
Object
ChatDataSource
CosmosChatDataSource
Implements
IJsonModel<CosmosChatDataSource> IPersistableModel<CosmosChatDataSource> IPersistableModel<T>

Constructors

CosmosChatDataSource()
Obsolete.

Initializes a new instance of CosmosChatDataSource.

Properties

AllowPartialResults

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

The include_context flags to request for an On Your Data retrieval result, which control what information will be available on ChatMessageContext instances in the response.
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<ChatDataSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ChatDataSource)
IJsonModel<ChatDataSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ChatDataSource)
IJsonModel<CosmosChatDataSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosChatDataSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ChatDataSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ChatDataSource)
IPersistableModel<ChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from ChatDataSource)
IPersistableModel<ChatDataSource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ChatDataSource)
IPersistableModel<CosmosChatDataSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<CosmosChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosChatDataSource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to