Text Analysis Authoring - Get Project

參考

服務:: Azure AI Services

API 版本:: 2023-04-01

取得專案的詳細數據。

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-01

URI 參數

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

回應

名稱	類型	Description
200 OK	TextAnalysisAuthoringProjectMetadata	要求已成功。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

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

範圍

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

範例

SuccessfulGetProject

範例要求

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-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": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

定義

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

Error

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	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	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤資訊。
target	string	錯誤目標。

ProjectKind

名稱	類型	Description
CustomEntityRecognition	string	若要建置擷取模型，以使用您自己的數據來識別您的領域類別。
CustomMultiLabelClassification	string	若要建置分類模型，以使用您自己的數據來分類文字。每個檔案可以有一或多個標籤。例如，檔案 1 會分類為 A、B 和 C，而檔案 2 則分類為 B 和 C。
CustomSingleLabelClassification	string	若要建置分類模型，以使用您自己的數據來分類文字。每個檔案只會有一個標籤。例如，檔案 1 會分類為 A，而檔案 2 則分類為 B。

ProjectSettings

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

名稱	類型	Description
confidenceThreshold	number	具有最高信賴度的類別閾值，預測會自動變更為「無」。閾值的值應介於 0 到 1 之間。

TextAnalysisAuthoringProjectMetadata

表示專案的元數據。

名稱	類型	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	ProjectSettings	項目設定。
storageInputContainerName	string	記憶體容器名稱。

共用方式為