KnowledgeBase interface
定义知识库及其存储的检索配置。
属性
| answer |
知识库在生成答案时考虑的指令。 |
| cors |
为知识库提供控制跨原点资源共享(CORS)的选项。 |
| description | 知识库的描述。 |
| encryption |
描述在 Azure 密钥保管库 中创建的加密密钥。 当你希望完全保证没有人(甚至 Microsoft)无法解密它们时,此密钥用于为知识库定义提供额外的静态加密级别。 加密知识库定义后,它将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥,可以根据需要更改此属性;您的知识库定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务,并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。 |
| etag | 知识库的 ETag。 |
| knowledge |
本知识库引用的知识来源。 |
| models | 包含有关如何连接到 AI 模型的配置选项。 |
| name | 知识库的名称。 |
| output |
知识库的输出模式。 |
| retrieval |
知识库在制定查询计划时考虑的指令。 |
| retrieval |
检索推理努力配置在检索时应用。 |
| retrieve |
该知识库的持久请求范围检索默认值。 这些值用于检索省略对应字段的请求;如果存在,请求时间值优先。 |
| tags | 用户自定义元数据用于组织知识库。 标签不控制计费归属或检索行为。 |
属性详细信息
answerInstructions
知识库在生成答案时考虑的指令。
answerInstructions?: string
属性值
string
corsOptions
description
知识库的描述。
description?: string
属性值
string
encryptionKey
描述在 Azure 密钥保管库 中创建的加密密钥。 当你希望完全保证没有人(甚至 Microsoft)无法解密它们时,此密钥用于为知识库定义提供额外的静态加密级别。 加密知识库定义后,它将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥,可以根据需要更改此属性;您的知识库定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务,并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
encryptionKey?: SearchResourceEncryptionKey
属性值
etag
知识库的 ETag。
etag?: string
属性值
string
knowledgeSources
models
name
知识库的名称。
name: string
属性值
string
outputMode
知识库的输出模式。
outputMode?: string
属性值
string
retrievalInstructions
知识库在制定查询计划时考虑的指令。
retrievalInstructions?: string
属性值
string
retrievalReasoningEffort
检索推理努力配置在检索时应用。
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion
属性值
retrieveDefaults
该知识库的持久请求范围检索默认值。 这些值用于检索省略对应字段的请求;如果存在,请求时间值优先。
retrieveDefaults?: KnowledgeBaseRetrieveDefaults
属性值
tags
用户自定义元数据用于组织知识库。 标签不控制计费归属或检索行为。
tags?: Record<string, string>
属性值
Record<string, string>