通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

KnowledgebaseOperations 类

  • 参考

KnowledgebaseOperations 操作。

继承
builtins.object
KnowledgebaseOperations

构造函数

KnowledgebaseOperations(client, config, serializer, deserializer)

参数

名称 说明
client
必需

用于服务请求的客户端。
config
必需

服务客户端的配置。
serializer
必需

对象模型序列化程序。
deserializer
必需

对象模型反序列化程序。

方法

create

用于创建新知识库的异步操作。
delete

删除知识库及其所有数据。
download

下载知识库。
generate_answer

GenerateAnswer 调用以 (QnA Maker 托管) 查询知识库。
get_details

获取特定知识库的详细信息。
list_all

获取用户的所有知识库。
publish

将知识库测试索引中的所有更改发布到其生产索引。
replace

替换知识库内容。
train

训练调用以 (QnAMaker 托管) 向知识库添加建议。
update

用于修改知识库的异步操作。

create

用于创建新知识库的异步操作。

create(create_kb_payload, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
create_kb_payload
必需
CreateKbDTO

发布请求正文。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
Operation,
<xref:msrest.pipeline.ClientRawResponse>

Operation 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

delete

删除知识库及其所有数据。

delete(kb_id, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

download

下载知识库。

download(kb_id, environment, source=None, changed_since=None, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
environment
必需
str 或 EnvironmentType

指定环境是 Test 还是 Prod。可能的值包括：“Prod”、“Test”
source
str

要应用的源属性筛选器。

默认值: None
changed_since
str

要应用的上次更改状态属性筛选器。

默认值: None
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
QnADocumentsDTO,
<xref:msrest.pipeline.ClientRawResponse>

QnADocumentsDTO 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

generate_answer

GenerateAnswer 调用以 (QnA Maker 托管) 查询知识库。

generate_answer(kb_id, generate_answer_payload, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
generate_answer_payload
必需
QueryDTO

发布请求正文。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
QnASearchResultList,
<xref:msrest.pipeline.ClientRawResponse>

QnASearchResultList 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

get_details

获取特定知识库的详细信息。

get_details(kb_id, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
KnowledgebaseDTO,
<xref:msrest.pipeline.ClientRawResponse>

KnowledgebaseDTO 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

list_all

获取用户的所有知识库。

list_all(custom_headers=None, raw=False, **operation_config)

参数

名称 说明
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
KnowledgebasesDTO,
<xref:msrest.pipeline.ClientRawResponse>

KnowledgebasesDTO 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

publish

将知识库测试索引中的所有更改发布到其生产索引。

publish(kb_id, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

replace

替换知识库内容。

replace(kb_id, qn_alist, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
qn_alist
必需
list[QnADTO]

要添加到知识库的 Q-A (QnADTO) 列表。 Q-A ID 由服务分配，应省略。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

train

训练调用以 (QnAMaker 托管) 向知识库添加建议。

train(kb_id, feedback_records=None, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
feedback_records
list[FeedbackRecordDTO]

反馈记录列表。

默认值: None
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

update

用于修改知识库的异步操作。

update(kb_id, update_kb, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
kb_id
必需
str

知识库 ID。
update_kb
必需
UpdateKbOperationDTO

发布请求正文。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
Operation,
<xref:msrest.pipeline.ClientRawResponse>

Operation 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
ErrorResponseException

属性

models 

models = <module 'azure.cognitiveservices.knowledge.qnamaker.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\knowledge\\qnamaker\\models\\__init__.py'>