Question Answering Projects - Update Sources

サービス:
Azure AI Services
API バージョン:
2023-04-01

プロジェクトのソースを更新します。

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-01

URI パラメーター

名前 / 必須 型 説明
Endpoint
 path True

string (uri)

サポートされている Cognitive Services エンドポイント (https://<resource-name>.api.cognitiveservices.azure.com など)。
projectName
 path True

string

maxLength: 100
pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$

使用するプロジェクトの名前。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 型 説明
body

UpdateSourceRecord[]

プロジェクトのソースパラメータを更新します。

応答

名前 型 説明
202 Accepted

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

Operation-Location: string
Other Status Codes

ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
https://cognitiveservices.azure.com/.default

例

Successful query

要求のサンプル

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/sources?api-version=2023-04-01

[
  {
    "op": "add",
    "value": {
      "displayName": "source3",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
      "sourceKind": "url",
      "sourceUri": "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",
      "refresh": true,
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    }
  },
  {
    "op": "delete",
    "value": {
      "displayName": "source2",
      "source": "surface-guide.pdf",
      "sourceKind": "file",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  }
]

応答のサンプル

状態コード:
202 
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-01

定義

名前 説明
Error

エラー オブジェクト。
ErrorCode

人間が判読できるエラー コード。
ErrorResponse

エラー応答。
InnerErrorCode

人間が判読できるエラー コード。
InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind

ソースのコンテンツ構造タイプ。
sourceKind

サポートされているソースの種類。
updateOperationKind

資産の操作タイプを更新します。
UpdateQnaSourceRecord

ソースレコードを更新します。
UpdateSourceRecord

更新されるソース。

Error

Object

エラー オブジェクト。

名前 型 説明
code

ErrorCode

サーバー定義の一連のエラー コードの 1 つ。
details

Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror

InnerErrorModel

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message

string

エラーの人間が判読できる表現。
target

string

エラーのターゲット。

ErrorCode

列挙

人間が判読できるエラー コード。

値 説明
InvalidRequest

要求エラーが無効です
InvalidArgument

無効な引数エラー
Unauthorized

未承認のアクセス エラー
Forbidden

許可されていないアクセス エラー
NotFound

見つからないエラー
ProjectNotFound

プロジェクトが見つかりませんエラー
OperationNotFound

操作が見つかりませんエラー
AzureCognitiveSearchNotFound

Azure Cognitive Search が見つかりませんエラー
AzureCognitiveSearchIndexNotFound

Azure Cognitive Search インデックスが見つかりませんエラー
TooManyRequests

要求が多すぎますエラー
AzureCognitiveSearchThrottling

Azure Cognitive Search の調整エラー
AzureCognitiveSearchIndexLimitReached

Azure Cognitive Search インデックスの制限に達しましたエラー
InternalServerError

内部サーバー エラー
ServiceUnavailable

サービス利用不可エラー
Timeout

タイムアウト エラー
QuotaExceeded

クォータ超過エラー
Conflict

競合エラー
Warning

警告エラー

ErrorResponse

Object

エラー応答。

名前 型 説明
error

Error

エラー オブジェクト。

InnerErrorCode

列挙

人間が判読できるエラー コード。

値 説明
InvalidRequest

要求エラーが無効です
InvalidParameterValue

パラメーター値のエラーが無効です
KnowledgeBaseNotFound

ナレッジ ベースが見つかりませんエラー
AzureCognitiveSearchNotFound

Azure Cognitive Search が見つかりませんエラー
AzureCognitiveSearchThrottling

Azure Cognitive Search の調整エラー
ExtractionFailure

抽出エラー エラー
InvalidRequestBodyFormat

要求本文の形式エラーが無効です
EmptyRequest

空の要求エラー
MissingInputDocuments

入力ドキュメントが見つからないエラー
InvalidDocument

無効なドキュメント エラー
ModelVersionIncorrect

モデル のバージョンが正しくないエラー
InvalidDocumentBatch

無効なドキュメント バッチ エラー
UnsupportedLanguageCode

サポートされていない言語コード エラー
InvalidCountryHint

無効な国ヒント エラー

InnerErrorModel

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前 型 説明
code

InnerErrorCode

サーバー定義の一連のエラー コードの 1 つ。
details

object

エラーの詳細。
innererror

InnerErrorModel

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message

string

エラー メッセージ。
target

string

エラーターゲット。

sourceContentStructureKind

列挙

ソースのコンテンツ構造タイプ。

値 説明
unstructured

構造化されていない。

sourceKind

列挙

サポートされているソースの種類。

値 説明
file

ファイルソース。
url

URI ソース。

updateOperationKind

列挙

資産の操作タイプを更新します。

値 説明
add

操作を追加します。
delete

削除操作。
replace

置換操作。

UpdateQnaSourceRecord

Object

ソースレコードを更新します。

名前 型 規定値 説明
contentStructureKind

sourceContentStructureKind

unstructured

ソースのコンテンツ構造タイプ。
displayName

string

minLength: 1
maxLength: 200

ソースのフレンドリ名。
refresh

boolean

ソースからデータを更新するために使用されるブール値フラグ。
source

string

一意のソース識別子。 「ファイル」ソースの場合のファイルの名前。それ以外の場合は、完全な URL が 'url' ソースの場合。
sourceKind

sourceKind

サポートされているソースの種類。
sourceUri

string (uri)

ファイルまたはURLのURIの場所。

UpdateSourceRecord

Object

更新されるソース。

名前 型 説明
op

updateOperationKind

資産の操作タイプを更新します。
value

UpdateQnaSourceRecord

ソースレコードを更新します。