Text Analysis Authoring - Get Model Evaluation Results

參考

服務:: Azure AI Services

API 版本:: 2023-04-01

取得已定型模型評估的詳細結果。這包括評估程式中所含數據的原始推斷結果。

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

含選擇性參數:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}&stringIndexType=Utf16CodeUnit

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string url	支援的認知服務端點（例如，https://.api.cognitiveservices.azure.com).
projectName	path	True	string	新的項目名稱。
trainedModelLabel	path	True	string	定型的模型標籤。
api-version	query	True	string	要用於這項作業的 API 版本。
stringIndexType	query	True	StringIndexType	指定用來解譯字串位移的方法。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。
maxpagesize	query		integer int32	每個頁面的結果項目數目上限。
skip	query		integer int32	要略過的結果項目數目。
top	query		integer int32	要傳回的結果項目數目。

回應

名稱	類型	Description
200 OK	PagedTextAnalysisAuthoringDocumentEvaluationResult	要求已成功。
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

範例

SuccessfulGetModelEvaluation

範例要求

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result?api-version=2023-04-01&maxpagesize=10&stringIndexType=Utf16CodeUnit

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "location": "11.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 181,
                "length": 34
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 15
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1780
          }
        ]
      }
    },
    {
      "location": "01.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1793
          }
        ]
      }
    }
  ],
  "nextLink": "https://api.example.com/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-15-preview&top=2147483645&skip=100&maxpagesize=100"
}

定義

名稱	Description
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
PagedTextAnalysisAuthoringDocumentEvaluationResult	TextAnalysisAuthoringDocumentEvaluationResult 專案的分頁集合
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	表示自定義實體辨識專案的檔評估結果。
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	表示自定義多標籤分類專案的檔評估結果。
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	表示自定義單一標籤分類專案的檔評估結果。
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	表示評估結果實體標籤。
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	表示文件的實體辨識評估結果。
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	表示文件區域的預期和預測實體之間的評估比較。
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	表示評估作業所產生的預期和預測類別之間的比較。
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	表示評估作業所產生的預期和預測類別之間的比較。

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

PagedTextAnalysisAuthoringDocumentEvaluationResult

TextAnalysisAuthoringDocumentEvaluationResult 專案的分頁集合

名稱	類型	Description
nextLink	string	專案下一頁的連結
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	此頁面上的 TextAnalysisAuthoringDocumentEvaluationResult 專案

ProjectKind

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

StringIndexType

名稱	類型	Description
Utf16CodeUnit	string	位移和長度值會對應至UTF-16程式代碼單位。如果您的應用程式是以支援 Unicode 的語言撰寫，例如 Java、JavaScript，請使用此選項。

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

表示自定義實體辨識專案的檔評估結果。

名稱	類型	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	表示實體辨識的評估預測。
language	string	表示文件語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
location	string	表示文件路徑。
projectKind	string: CustomEntityRecognition	表示項目種類。

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

表示自定義多標籤分類專案的檔評估結果。

名稱	類型	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	表示多重標籤分類的評估預測。
language	string	表示文件語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
location	string	表示文件路徑。
projectKind	string: CustomMultiLabelClassification	表示項目種類。

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

表示自定義單一標籤分類專案的檔評估結果。

名稱	類型	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	表示單一標籤分類的評估預測。
language	string	表示文件語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
location	string	表示文件路徑。
projectKind	string: CustomSingleLabelClassification	表示項目種類。

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

表示評估結果實體標籤。

名稱	類型	Description
category	string	表示實體類別目錄。
length	integer	表示實體長度。
offset	integer	表示相對於原始文字的實體位移索引。

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

表示文件的實體辨識評估結果。

名稱	類型	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	表示標示為文件的文件實體。

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

表示文件區域的預期和預測實體之間的評估比較。

名稱	類型	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	表示區域預期的實體標籤。
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	表示區域的預測實體標籤。
regionLength	integer	表示區域長度。
regionOffset	integer	表示區域位移。

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

表示評估作業所產生的預期和預測類別之間的比較。

名稱	類型	Description
expectedClasses	string[]	表示文件的預期類別。
predictedClasses	string[]	表示文件的預測類別。

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult