Question Answering Projects - Get Project Details
取得要求的項目元數據。
GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}?api-version=2023-04-15-preview
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
project
|
path | True |
string |
要使用的項目名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
指定專案的元數據。 |
|
Other Status Codes |
錯誤回應。 |
安全性
AADToken
這些是 Azure Active Directory OAuth2 流程
若要實作案例,建議您檢視
筆記
- 此安全性定義 需要 使用
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
範例要求
GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1?api-version=2023-04-15-preview
範例回覆
{
"projectName": "proj1",
"description": "proj1 is a test project.",
"language": "en",
"settings": {
"defaultAnswer": "No good match found for your question in the Knowledgebase."
},
"createdDateTime": "2021-05-01T15:13:22Z",
"lastModifiedDateTime": "2021-05-01T15:13:22Z",
"lastDeployedDateTime": "2021-05-01T15:13:22Z"
}
定義
名稱 | Description |
---|---|
Error |
error 物件。 |
Error |
人類可讀取的錯誤碼。 |
Error |
錯誤回應。 |
Inner |
人類可讀取的錯誤碼。 |
Inner |
物件,包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
Project |
表示專案。 |
Project |
Project 的可設定設定。 |
Error
error 物件。
名稱 | 類型 | Description |
---|---|---|
code |
其中一組伺服器定義的錯誤碼。 |
|
details |
Error[] |
導致此錯誤之特定錯誤的詳細數據陣列。 |
innererror |
物件,包含與目前對象有關錯誤更具體的資訊。 |
|
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一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
名稱 | 類型 | Description |
---|---|---|
code |
其中一組伺服器定義的錯誤碼。 |
|
details |
object |
錯誤詳細數據。 |
innererror |
物件,包含與目前對象有關錯誤更具體的資訊。 |
|
message |
string |
錯誤資訊。 |
target |
string |
錯誤目標。 |
ProjectMetadata
表示專案。
名稱 | 類型 | Description |
---|---|---|
createdDateTime |
string |
專案建立日期時間。 |
description |
string |
專案的描述。 |
language |
string |
文字記錄的語言。 這是語言的 BCP-47 表示法。 例如,使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定,請針對英文使用 「en」 作為預設值。 |
lastDeployedDateTime |
string |
表示專案上次部署日期時間。 |
lastModifiedDateTime |
string |
表示上次修改日期時間的專案。 |
multilingualResource |
boolean |
跨專案啟用多種語言的資源。 |
projectName |
string |
項目的名稱。 |
settings |
Project 的可設定設定。 |
ProjectSettings
Project 的可設定設定。
名稱 | 類型 | Description |
---|---|---|
defaultAnswer |
string |
在知識庫中找不到相符專案時,預設回應回應。 |