Question Answering Projects - Update Sources

參考

服務:: Cognitive Services - Language

API 版本:: 2023-04-01

匯報專案的來源。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string	要使用的項目名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
body	UpdateSourceRecord[]	更新專案的來源參數。

回應

名稱	類型	Description
202 Accepted		成功呼叫的結果是用於檢查作業狀態的 Operation-Location 標頭。標題 Operation-Location: string
Other Status Codes	ErrorResponse	錯誤回應。

名稱

類型

Description

202 Accepted

成功呼叫的結果是用於檢查作業狀態的 Operation-Location 標頭。

標題

Operation-Location: string

Other Status Codes

ErrorResponse

錯誤回應。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。與 Azure 角色型存取控制配對時，可用來控制對 #DDF824AA8266B4B1DBA64ED2373C38A89 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供將應用程式模型化 () 的解決方案。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式設定。

目前，Azure Active Directory v1.0 或 v2.0 支援公司、學校和來賓，但不支持個人帳戶。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

語言服務資源的訂用帳戶金鑰。

類型: apiKey
位於: header

範例

Successful query

範例要求

HTTP

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"
    }
  }
]

範例回覆

狀態碼:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-01

定義

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

錯誤物件。

名稱	類型	Description
code	ErrorCode	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
target	string	錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
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

錯誤回應。

名稱	類型	Description
error	Error	錯誤物件。

InnerErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
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。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	錯誤訊息。
target	string	錯誤目標。

sourceContentStructureKind

來源的內容結構類型。

名稱	類型	Description
unstructured	string

sourceKind

支援的來源類型。

名稱	類型	Description
file	string
url	string

updateOperationKind

更新資產的作業類型。

名稱	類型	Description
add	string
delete	string
replace	string

UpdateQnaSourceRecord

更新來源記錄。

名稱	類型	預設值	Description
contentStructureKind	sourceContentStructureKind	Unstructured	來源的內容結構類型。
displayName	string		來源的易記名稱。
refresh	boolean		用來重新整理來源數據的布爾值旗標。
source	string		唯一來源標識碼。如果是 'file' 來源，則為檔名;否則，如果是 'url' 來源，則為完整的 URL。
sourceKind	sourceKind	url	支援的來源類型。
sourceUri	string		檔案或 URL 的 URI 位置。

UpdateSourceRecord

要更新的來源。

名稱	類型	Description
op	updateOperationKind	更新資產的作業類型。
value	UpdateQnaSourceRecord	更新來源記錄。

共用方式為

Question Answering Projects - Update Sources

URI 參數

要求本文

回應

安全性

AADToken

備註

範圍

Ocp-Apim-Subscription-Key

範例

Successful query

範例要求

範例回覆

定義

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord

其他資源