KnowledgebaseOperations 類別

KnowledgebaseOperations 作業。

繼承

builtins.object

KnowledgebaseOperations

建構函式

KnowledgebaseOperations(client, config, serializer, deserializer)

參數

名稱	Description
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)

參數

名稱	Description
create_kb_payload 必要	CreateKbDTO 張貼要求的本文。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
Operation, <xref:msrest.pipeline.ClientRawResponse>	Operation 或 ClientRawResponse if raw=true

例外狀況

類型	Description
ErrorResponseException

delete

刪除知識庫及其所有資料。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
None, <xref:msrest.pipeline.ClientRawResponse>	如果 raw=true，則為 None 或 ClientRawResponse

例外狀況

類型	Description
ErrorResponseException

download

下載知識庫。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
environment 必要	str 或 EnvironmentType 指定環境是否為 Test 或 Prod。可能的值包括：'Prod'、'Test'
source	str 要套用的來源屬性篩選。 預設值: None
changed_since	str 要套用的最後一個已變更狀態屬性篩選。 預設值: None
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
QnADocumentsDTO, <xref:msrest.pipeline.ClientRawResponse>	QnADocumentsDTO 或 ClientRawResponse if raw=true

例外狀況

類型	Description
ErrorResponseException

generate_answer

GenerateAnswer 呼叫以查詢知識庫 (QnA Maker 受控) 。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
generate_answer_payload 必要	QueryDTO 張貼要求的本文。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
QnASearchResultList, <xref:msrest.pipeline.ClientRawResponse>	QnASearchResultList 或 ClientRawResponse if raw=true

例外狀況

類型	Description
ErrorResponseException

get_details

取得特定知識庫的詳細資料。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
KnowledgebaseDTO, <xref:msrest.pipeline.ClientRawResponse>	如果 raw=true，KnowledgebaseDTO 或 ClientRawResponse

例外狀況

類型	Description
ErrorResponseException

list_all

取得使用者的所有知識庫。

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

參數

名稱	Description
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
KnowledgebasesDTO, <xref:msrest.pipeline.ClientRawResponse>	如果 raw=true，則知識庫DTO 或 ClientRawResponse

例外狀況

類型	Description
ErrorResponseException

publish

將知識庫測試索引中的所有變更發佈至其生產索引。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
None, <xref:msrest.pipeline.ClientRawResponse>	如果 raw=true，則為 None 或 ClientRawResponse

例外狀況

類型	Description
ErrorResponseException

replace

取代知識庫內容。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
qn_alist 必要	list[QnADTO] 要新增至知識庫的 Q-A (QnADTO) 清單。 Q-A 識別碼是由服務指派，因此應該省略。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
None, <xref:msrest.pipeline.ClientRawResponse>	如果 raw=true，則為 None 或 ClientRawResponse

例外狀況

類型	Description
ErrorResponseException

train

訓練呼叫，將建議新增至知識庫 (QnAMaker 受控) 。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
feedback_records	list[FeedbackRecordDTO] 意見反應記錄的清單。 預設值: None
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
None, <xref:msrest.pipeline.ClientRawResponse>	如果 raw=true，則為 None 或 ClientRawResponse

例外狀況

類型	Description
ErrorResponseException

update

用來修改知識庫的非同步作業。

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

參數

名稱	Description
kb_id 必要	str 知識庫識別碼。
update_kb 必要	UpdateKbOperationDTO 張貼要求的本文。
custom_headers	dict 將新增至要求的標頭 預設值: None
raw	bool 傳回直接回應與還原序列化回應 預設值: False
operation_config 必要	作業組態覆寫。

傳回

類型	Description
Operation, <xref:msrest.pipeline.ClientRawResponse>	Operation 或 ClientRawResponse if raw=true

例外狀況

類型	Description
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'>