Text Analysis Authoring - Import

參考

服務:: Azure AI Services

API 版本:: 2023-04-01

觸發作業以匯入專案。如果具有相同名稱的項目已經存在，則會取代該專案的數據。

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?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
metadata	True	TextAnalysisAuthoringCreateProjectOptions	表示專案元數據。
projectFileVersion	True	string	導出的檔案版本。
stringIndexType	True	StringIndexType	指定用來解譯字串位移的方法。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	表示項目資產。

回應

名稱	類型	Description
202 Accepted		要求已接受進行處理，但尚未完成處理。標題 Operation-Location: string
Other Status Codes	ErrorResponse	未預期的錯誤回應。

名稱

類型

Description

202 Accepted

要求已接受進行處理，但尚未完成處理。

標題

Operation-Location: string

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

範例

SuccessfulImportProject

範例要求

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:import?api-version=2023-04-01

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "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"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

範例回覆

狀態碼:: 202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

定義

名稱	Description
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
ExportedProject	表示導出的專案。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind
ProjectSettings	表示用來定義項目行為的設定。
StringIndexType
TextAnalysisAuthoringCreateProjectOptions	表示用來建立或更新項目的選項。
TextAnalysisAuthoringExportedClass	表示匯出項目的類別。
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	表示自定義實體辨識項目的匯出檔。
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	表示實體辨識項目的導出資產。
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	表示自定義多標籤分類項目的匯出檔。
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	表示自定義多標籤分類項目的導出資產。
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	表示自定義單一標籤分類項目的匯出檔。
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	表示單一標籤分類項目的匯出資產。
TextAnalysisAuthoringExportedDocumentClass	表示文件的分類標籤。
TextAnalysisAuthoringExportedDocumentEntityLabel	表示文件的實體標籤。
TextAnalysisAuthoringExportedDocumentEntityRegion	表示文件中實體標籤的區域。
TextAnalysisAuthoringExportedEntity	表示匯出專案中的實體。

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 物件。

ExportedProject

表示導出的專案。

名稱	類型	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	表示項目資產。
metadata	TextAnalysisAuthoringCreateProjectOptions	表示專案元數據。
projectFileVersion	string	導出的檔案版本。
stringIndexType	StringIndexType	指定用來解譯字串位移的方法。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

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 之間。

StringIndexType

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

TextAnalysisAuthoringCreateProjectOptions

表示用來建立或更新項目的選項。

名稱	類型	Description
description	string	專案描述。
language	string	項目語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
multilingual	boolean	專案是否要用於多種語言。
projectKind	ProjectKind	專案種類。
projectName	string	新的項目名稱。
settings	ProjectSettings	項目設定。
storageInputContainerName	string	記憶體容器名稱。

TextAnalysisAuthoringExportedClass

表示匯出項目的類別。

名稱	類型	Description
category	string	類別類別目錄。

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

表示自定義實體辨識項目的匯出檔。

名稱	類型	Description
dataset	string	本文件的數據集。允許的值為『Train』和 'Test'。
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	屬於文件的實體標籤清單。
language	string	表示文件語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
location	string	檔在記憶體中的位置。

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

表示實體辨識項目的導出資產。

名稱	類型	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	屬於專案的檔案清單。
entities	TextAnalysisAuthoringExportedEntity[]	屬於項目的實體清單。
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

表示自定義多標籤分類項目的匯出檔。

名稱	類型	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	檔案類別。
dataset	string	本文件的數據集。允許的值為『Train』和 'Test'。
language	string	表示文件語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
location	string	檔在記憶體中的位置。

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

表示自定義多標籤分類項目的導出資產。

名稱	類型	Description
classes	TextAnalysisAuthoringExportedClass[]	專案中的類別清單。
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	專案中的檔案清單。
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

表示自定義單一標籤分類項目的匯出檔。

名稱	類型	Description
class	TextAnalysisAuthoringExportedDocumentClass	檔的類別。
dataset	string	本文件的數據集。允許的值為『Train』和 'Test'。
language	string	表示文件語言。這是語言的 BCP-47 表示法。例如，使用「en」代表英文、“en-gb” 代表英文（UK）、“es” 代表西班牙文等。
location	string	檔在記憶體中的位置。

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

表示單一標籤分類項目的匯出資產。

名稱	類型	Description
classes	TextAnalysisAuthoringExportedClass[]	屬於此項目的類別清單。
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	屬於此項目的檔案清單。
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

表示文件的分類標籤。

名稱	類型	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

表示文件的實體標籤。

名稱	類型	Description
category	string	實體類別目錄。
length	integer	實體文字的長度。
offset	integer	實體文字的開始位置。

TextAnalysisAuthoringExportedDocumentEntityRegion

表示文件中實體標籤的區域。

名稱	類型	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	屬於此區域的實體標籤清單。
regionLength	integer	區域文字的長度。
regionOffset	integer	區域的開始位置。

TextAnalysisAuthoringExportedEntity

表示匯出專案中的實體。

名稱	類型	Description
category	string	實體類別目錄。

共用方式為

Text Analysis Authoring - Import

URI 參數

要求本文

回應

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

範圍

範例

SuccessfulImportProject

範例要求

範例回覆

定義

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

其他資源