你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
AzureCosmosDBChatExtensionConfiguration interface
将 Azure Cosmos DB 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。
属性
| authentication | 访问定义的数据源时使用的身份验证方法。 每种数据源类型都支持一组特定的可用身份验证方法;有关支持的机制，请参阅数据源的文档。 如果未提供其他凭据，“你的数据”将尝试使用系统托管标识 (默认凭据) 身份验证。 |
| container |
Azure Cosmos DB 资源容器的名称。 |
| database |
要与 Azure Cosmos DB 配合使用的 MongoDB vCore 数据库名称。 |
| embedding |
矢量搜索的嵌入依赖项。 |
| fields |
与搜索索引交互时要使用的自定义字段映射行为。 |
| index |
要用于 Azure Cosmos DB 的 MongoDB vCore 索引名称。 |
| in |
是否应将查询限制为使用索引数据。 |
| role |
为模型提供有关它应该如何运行以及在生成回复时应引用的任何上下文的说明。 你可以描述助手的个性，并告诉它如何设置响应的格式。 有一个 100 个令牌限制，它计入总体令牌限制。 |
| strictness | 配置的搜索相关性筛选的严格性。 严格性越高，答案的精度越高，但召回率越低。 |
| top |
要为所配置查询提供的文档数。 |
| type | 配置 Azure OpenAI 聊天扩展时要使用的类型标签。 通常不应更改 Azure Cosmos DB 的默认值。 |
属性详细信息
authentication
访问定义的数据源时使用的身份验证方法。 每种数据源类型都支持一组特定的可用身份验证方法;有关支持的机制，请参阅数据源的文档。 如果未提供其他凭据，“你的数据”将尝试使用系统托管标识 (默认凭据) 身份验证。
authentication?: OnYourDataAuthenticationOptionsUnion属性值
containerName
Azure Cosmos DB 资源容器的名称。
containerName: string属性值
string
databaseName
要与 Azure Cosmos DB 配合使用的 MongoDB vCore 数据库名称。
databaseName: string属性值
string
embeddingDependency
矢量搜索的嵌入依赖项。
embeddingDependency: OnYourDataVectorizationSourceUnion属性值
fieldsMapping
与搜索索引交互时要使用的自定义字段映射行为。
fieldsMapping: AzureCosmosDBFieldMappingOptions属性值
indexName
要用于 Azure Cosmos DB 的 MongoDB vCore 索引名称。
indexName: string属性值
string
inScope
是否应将查询限制为使用索引数据。
inScope?: boolean属性值
boolean
roleInformation
为模型提供有关它应该如何运行以及在生成回复时应引用的任何上下文的说明。 你可以描述助手的个性，并告诉它如何设置响应的格式。 有一个 100 个令牌限制，它计入总体令牌限制。
roleInformation?: string属性值
string
strictness
配置的搜索相关性筛选的严格性。 严格性越高，答案的精度越高，但召回率越低。
strictness?: number属性值
number
topNDocuments
要为所配置查询提供的文档数。
topNDocuments?: number属性值
number
type
配置 Azure OpenAI 聊天扩展时要使用的类型标签。 通常不应更改 Azure Cosmos DB 的默认值。
type: "azure_cosmos_db"属性值
"azure_cosmos_db"
