MongoDBChatDataSource Class

Definition

Namespace:

Azure.AI.OpenAI.Chat

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v2.0.0-beta.6

The MongoDBChatDataSource.

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

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

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

Inheritance

Object

AzureChatDataSource

MongoDBChatDataSource

Implements

IJsonModel<MongoDBChatDataSource> IPersistableModel<MongoDBChatDataSource> IPersistableModel<T>

Constructors

MongoDBChatDataSource()

Obsolete. Creates a new instance of MongoDBChatDataSource.

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.
AppName	The name of the MongoDB application.
Authentication	The authentication options to use with the MongoDB data source.
CollectionName	The name of the MongoDB collection.
EndpointName	The name of the MongoDB cluster endpoint.
IndexName	The name of the MongoDB index.
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.
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<MongoDBChatDataSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<MongoDBChatDataSource>.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<MongoDBChatDataSource>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<MongoDBChatDataSource>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<MongoDBChatDataSource>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.