AzureCosmosDBChatExtensionConfiguration interface

Pakiet:

@azure/openai

Konkretna reprezentacja konfigurowalnych opcji dla usługi Azure Cosmos DB w przypadku korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.

Właściwości

authentication	Metoda uwierzytelniania używana podczas uzyskiwania dostępu do zdefiniowanego źródła danych. Każdy typ źródła danych obsługuje określony zestaw dostępnych metod uwierzytelniania; Zapoznaj się z dokumentacją źródła danych, aby zapoznać się z obsługiwanymi mechanizmami. Jeśli nie podano inaczej, w danych spróbuje użyć uwierzytelniania tożsamości zarządzanej przez system (poświadczenia domyślne).
containerName	Nazwa kontenera zasobów usługi Azure Cosmos DB.
databaseName	Nazwa bazy danych mongoDB z rdzeniami wirtualnymi do użycia z usługą Azure Cosmos DB.
embeddingDependency	Zależność osadzania dla wyszukiwania wektorowego.
fieldsMapping	Dostosowane zachowanie mapowania pól do użycia podczas interakcji z indeksem wyszukiwania.
indexName	Nazwa indeksu rdzeni wirtualnych bazy danych MongoDB do użycia z usługą Azure Cosmos DB.
inScope	Określa, czy zapytania powinny być ograniczone do używania indeksowanych danych.
roleInformation	Przekaż instrukcje dotyczące sposobu działania modelu i dowolnego kontekstu, do którego powinien się odwoływać podczas generowania odpowiedzi. Możesz opisać osobowość asystent i określić sposób formatowania odpowiedzi. Istnieje limit 100 tokenów i jest liczone względem ogólnego limitu tokenów.
strictness	Skonfigurowano ścisłość filtrowania istotności wyszukiwania. Im wyższa surowość, wyższa precyzja, ale niższa kompletność odpowiedzi.
topNDocuments	Skonfigurowana maksymalna liczba dokumentów, które mają być dostępne dla skonfigurowanego zapytania.
type	Etykieta typu, która ma być używana podczas konfigurowania rozszerzeń czatu usługi Azure OpenAI. Zazwyczaj nie powinno się to zmieniać z wartości domyślnej dla usługi Azure Cosmos DB.

Szczegóły właściwości

authentication

Metoda uwierzytelniania używana podczas uzyskiwania dostępu do zdefiniowanego źródła danych. Każdy typ źródła danych obsługuje określony zestaw dostępnych metod uwierzytelniania; Zapoznaj się z dokumentacją źródła danych, aby zapoznać się z obsługiwanymi mechanizmami. Jeśli nie podano inaczej, w danych spróbuje użyć uwierzytelniania tożsamości zarządzanej przez system (poświadczenia domyślne).

authentication?: OnYourDataAuthenticationOptionsUnion

Wartość właściwości

OnYourDataAuthenticationOptionsUnion

containerName

Nazwa kontenera zasobów usługi Azure Cosmos DB.

containerName: string

Wartość właściwości

string

databaseName

Nazwa bazy danych mongoDB z rdzeniami wirtualnymi do użycia z usługą Azure Cosmos DB.

databaseName: string

Wartość właściwości

string

embeddingDependency

Zależność osadzania dla wyszukiwania wektorowego.

embeddingDependency: OnYourDataVectorizationSourceUnion

Wartość właściwości

OnYourDataVectorizationSourceUnion

fieldsMapping

Dostosowane zachowanie mapowania pól do użycia podczas interakcji z indeksem wyszukiwania.

fieldsMapping: AzureCosmosDBFieldMappingOptions

Wartość właściwości

AzureCosmosDBFieldMappingOptions

indexName

Nazwa indeksu rdzeni wirtualnych bazy danych MongoDB do użycia z usługą Azure Cosmos DB.

indexName: string

Wartość właściwości

string

inScope

Określa, czy zapytania powinny być ograniczone do używania indeksowanych danych.

inScope?: boolean

Wartość właściwości

boolean

roleInformation

Przekaż instrukcje dotyczące sposobu działania modelu i dowolnego kontekstu, do którego powinien się odwoływać podczas generowania odpowiedzi. Możesz opisać osobowość asystent i określić sposób formatowania odpowiedzi. Istnieje limit 100 tokenów i jest liczone względem ogólnego limitu tokenów.

roleInformation?: string

Wartość właściwości

string

strictness

Skonfigurowano ścisłość filtrowania istotności wyszukiwania. Im wyższa surowość, wyższa precyzja, ale niższa kompletność odpowiedzi.

strictness?: number

Wartość właściwości

number

topNDocuments

Skonfigurowana maksymalna liczba dokumentów, które mają być dostępne dla skonfigurowanego zapytania.

topNDocuments?: number

Wartość właściwości

number

type

Etykieta typu, która ma być używana podczas konfigurowania rozszerzeń czatu usługi Azure OpenAI. Zazwyczaj nie powinno się to zmieniać z wartości domyślnej dla usługi Azure Cosmos DB.

type: "azure_cosmos_db"

Wartość właściwości

"azure_cosmos_db"