AzureCosmosDBChatExtensionConfiguration interface

Pacote:

@azure/openai

Uma representação específica das opções configuráveis para o Azure Cosmos DB ao usá-lo como uma extensão de chat do OpenAI do Azure.

Propriedades

authentication	O método de autenticação a ser usado ao acessar a fonte de dados definida. Cada tipo de fonte de dados dá suporte a um conjunto específico de métodos de autenticação disponíveis; consulte a documentação da fonte de dados para obter mecanismos com suporte. Se não for fornecido de outra forma, On Your Data tentará usar a autenticação de Identidade Gerenciada do Sistema (credencial padrão).
containerName	O nome do contêiner de recursos do Azure Cosmos DB.
databaseName	O nome do banco de dados vCore do MongoDB a ser usado com o Azure Cosmos DB.
embeddingDependency	A dependência de inserção para pesquisa de vetor.
fieldsMapping	Comportamento de mapeamento de campo personalizado a ser usado ao interagir com o índice de pesquisa.
indexName	O nome do índice vCore do MongoDB a ser usado com o Azure Cosmos DB.
inScope	Se as consultas devem ser restritas ao uso de dados indexados.
roleInformation	Forneça ao modelo instruções sobre como ele deve se comportar e qualquer contexto que ele deve referenciar ao gerar uma resposta. Você pode descrever a personalidade do assistente e dizer como formatar respostas. Há um limite de 100 tokens para ele e ele conta com relação ao limite geral do token.
strictness	A restrição configurada da filtragem de relevância de pesquisa. Quanto maior a restrição, maior a precisão, mas menor o recall da resposta.
topNDocuments	O número superior configurado de documentos a serem apresentados para a consulta configurada.
type	O rótulo de tipo a ser usado ao configurar extensões de chat do OpenAI do Azure. Normalmente, isso não deve ser alterado de seu valor padrão para o Azure Cosmos DB.

Detalhes da propriedade

authentication

O método de autenticação a ser usado ao acessar a fonte de dados definida. Cada tipo de fonte de dados dá suporte a um conjunto específico de métodos de autenticação disponíveis; consulte a documentação da fonte de dados para obter mecanismos com suporte. Se não for fornecido de outra forma, On Your Data tentará usar a autenticação de Identidade Gerenciada do Sistema (credencial padrão).

authentication?: OnYourDataAuthenticationOptionsUnion

Valor da propriedade

OnYourDataAuthenticationOptionsUnion

containerName

O nome do contêiner de recursos do Azure Cosmos DB.

containerName: string

Valor da propriedade

string

databaseName

O nome do banco de dados vCore do MongoDB a ser usado com o Azure Cosmos DB.

databaseName: string

Valor da propriedade

string

embeddingDependency

A dependência de inserção para pesquisa de vetor.

embeddingDependency: OnYourDataVectorizationSourceUnion

Valor da propriedade

OnYourDataVectorizationSourceUnion

fieldsMapping

Comportamento de mapeamento de campo personalizado a ser usado ao interagir com o índice de pesquisa.

fieldsMapping: AzureCosmosDBFieldMappingOptions

Valor da propriedade

AzureCosmosDBFieldMappingOptions

indexName

O nome do índice vCore do MongoDB a ser usado com o Azure Cosmos DB.

indexName: string

Valor da propriedade

string

inScope

Se as consultas devem ser restritas ao uso de dados indexados.

inScope?: boolean

Valor da propriedade

boolean

roleInformation

Forneça ao modelo instruções sobre como ele deve se comportar e qualquer contexto que ele deve referenciar ao gerar uma resposta. Você pode descrever a personalidade do assistente e dizer como formatar respostas. Há um limite de 100 tokens para ele e ele conta com relação ao limite geral do token.

roleInformation?: string

Valor da propriedade

string

strictness

A restrição configurada da filtragem de relevância de pesquisa. Quanto maior a restrição, maior a precisão, mas menor o recall da resposta.

strictness?: number

Valor da propriedade

number

topNDocuments

O número superior configurado de documentos a serem apresentados para a consulta configurada.

topNDocuments?: number

Valor da propriedade

number

type

O rótulo de tipo a ser usado ao configurar extensões de chat do OpenAI do Azure. Normalmente, isso não deve ser alterado de seu valor padrão para o Azure Cosmos DB.

type: "azure_cosmos_db"

Valor da propriedade

"azure_cosmos_db"