Question Answering Projects - Update Sources
プロジェクトのソースを更新します。
PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
使用するプロジェクトの名前。 |
api-version
|
query | True |
string |
クライアント API バージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
body |
プロジェクトのソース パラメーターを更新します。 |
応答
名前 | 型 | 説明 |
---|---|---|
202 Accepted |
呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。 ヘッダー Operation-Location: string |
|
Other Status Codes |
エラー応答。 |
セキュリティ
AADToken
これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、ユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
メモ
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-id
アプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
は Authorization URL
、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- 現在、Azure Active Directory v1.0 または v2.0 では、職場、学校、ゲストはサポートされていますが、個人用アカウントはサポートされていません。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
言語サービス リソースのサブスクリプション キー。
型:
apiKey
/:
header
例
Successful query
要求のサンプル
PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/sources?api-version=2023-04-01
[
{
"op": "add",
"value": {
"displayName": "source3",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
"sourceKind": "url",
"source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
}
},
{
"op": "replace",
"value": {
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
"refresh": true,
"source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
}
},
{
"op": "delete",
"value": {
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
"sourceKind": "file",
"source": "surface-guide.pdf"
}
}
]
応答のサンプル
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-01
定義
名前 | 説明 |
---|---|
Error |
error オブジェクト。 |
Error |
人間が判読できるエラー コード。 |
Error |
エラー応答。 |
Inner |
人間が判読できるエラー コード。 |
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
source |
ソースのコンテンツ構造の種類。 |
source |
サポートされているソースの種類。 |
update |
資産の更新操作の種類。 |
Update |
ソース レコードを更新します。 |
Update |
更新するソース。 |
Error
error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
ErrorCode
人間が判読できるエラー コード。
名前 | 型 | 説明 |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
Conflict |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
InvalidArgument |
string |
|
InvalidRequest |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
ProjectNotFound |
string |
|
QuotaExceeded |
string |
|
ServiceUnavailable |
string |
|
Timeout |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
Warning |
string |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
InnerErrorCode
人間が判読できるエラー コード。
名前 | 型 | 説明 |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
InnerErrorModel
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
名前 | 型 | 説明 |
---|---|---|
code |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
object |
エラーの詳細。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
sourceContentStructureKind
ソースのコンテンツ構造の種類。
名前 | 型 | 説明 |
---|---|---|
unstructured |
string |
sourceKind
サポートされているソースの種類。
名前 | 型 | 説明 |
---|---|---|
file |
string |
|
url |
string |
updateOperationKind
資産の更新操作の種類。
名前 | 型 | 説明 |
---|---|---|
add |
string |
|
delete |
string |
|
replace |
string |
UpdateQnaSourceRecord
ソース レコードを更新します。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
contentStructureKind | Unstructured |
ソースのコンテンツ構造の種類。 |
|
displayName |
string |
ソースのフレンドリ名。 |
|
refresh |
boolean |
ソースからのデータを更新するために使用されるブール型 (Boolean) フラグ。 |
|
source |
string |
一意のソース識別子。 ファイルが 'file' ソースの場合は、そのファイルの名前。それ以外の場合は、完全な URL ('url' ソースの場合)。 |
|
sourceKind | url |
サポートされているソースの種類。 |
|
sourceUri |
string |
ファイルまたは URL の URI の場所。 |
UpdateSourceRecord
更新するソース。
名前 | 型 | 説明 |
---|---|---|
op |
資産の更新操作の種類。 |
|
value |
ソース レコードを更新します。 |