Conversational Analysis Authoring - Get Project

服務:

Cognitive Services - Language

API 版本:

2022-05-01

取得專案的詳細數據。

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2022-05-01

URI 參數

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

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	語言服務資源的訂用帳戶金鑰。

回應

名稱	類型	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	專案的元數據。
Other Status Codes	ErrorResponse	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Successful Get Project

範例要求

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01

範例回覆

狀態碼:

200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

定義

名稱	Description
ConversationalAnalysisAuthoringProjectMetadata	表示專案的元數據。
ConversationalAnalysisAuthoringProjectSettings	表示用來定義項目行為的設定。
Error	錯誤物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind	表示項目種類。

ConversationalAnalysisAuthoringProjectMetadata

表示專案的元數據。

名稱	類型	Description
createdDateTime	string	表示專案建立日期時間。
description	string	專案描述。
language	string	項目語言。 這是語言的 BCP-47 表示法。 例如，將 「en」 用於英文、“en-gb” 用於英文 (UK) 、“es” 用於西班牙文等。
lastDeployedDateTime	string	代表上次部署日期時間的專案。
lastModifiedDateTime	string	表示專案建立日期時間。
lastTrainedDateTime	string	代表上次定型日期時間的專案。
multilingual	boolean	專案是否要用於多種語言。
projectKind	ProjectKind	表示項目種類。
projectName	string	新的項目名稱。
settings	ConversationalAnalysisAuthoringProjectSettings	項目設定。

ConversationalAnalysisAuthoringProjectSettings

表示用來定義項目行為的設定。

名稱	類型	Description
confidenceThreshold	number	具有最高信賴度的意圖閾值，預測會自動變更為「無」。

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	錯誤目標。

ProjectKind

表示項目種類。

名稱	類型	Description
Conversation	string	將自然語言建置到應用程式、Bot 和IoT裝置的專案。
Orchestration	string	在單一專案中連接及協調對話、自定義問題解答和 LUIS 專案的專案。