次の方法で共有

KnowledgebaseOperations クラス

  • リファレンス

KnowledgebaseOperations 操作。

継承
builtins.object
KnowledgebaseOperations

コンストラクター

KnowledgebaseOperations(client, config, serializer, deserializer)

パラメーター

名前 説明
client
必須

サービス要求のクライアント。
config
必須

サービス クライアントの構成。
serializer
必須

オブジェクト モデル シリアライザー。
deserializer
必須

オブジェクト モデル逆シリアライザー。

メソッド

create

新しいナレッジベースを作成する非同期操作。
delete

ナレッジベースとそのすべてのデータを削除します。
download

ナレッジベースをダウンロードします。
generate_answer

GenerateAnswer を呼び出してナレッジ ベースのクエリを実行する (QnA Maker Managed)。
get_details

特定のナレッジ ベースの詳細を取得します。
list_all

ユーザーのすべてのナレッジ ベースを取得します。
publish

ナレッジベースのテスト インデックス内のすべての変更を、その製品インデックスに発行します。
replace

ナレッジ ベースの内容を置き換えます。
train

ナレッジ ベースに候補を追加するための通話をトレーニングします (QnAMaker Managed)。
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 or ClientRawResponse if 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 Managed)。

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>

raw=true の場合は QnASearchResultList または ClientRawResponse

例外

型 説明
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>

raw=true の場合は KnowledgebaseDTO または ClientRawResponse

例外

型 説明
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>

raw=true の場合は KnowledgebasesDTO または ClientRawResponse

例外

型 説明
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 Managed)。

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 or ClientRawResponse if 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'>