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 パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string url	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
projectName	path	True	string	使用するプロジェクトの名前。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
metadata	True	CreateProjectOptions	プロジェクトのメタデータを表します。
projectFileVersion	True	string	エクスポートされたファイルのバージョン。
stringIndexType	True	StringIndexType	文字列オフセットの解釈に使用するメソッドを指定します。詳細については、https://aka.ms/text-analytics-offsetsを参照してください。
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	プロジェクト資産を表します。

応答

名前	型	説明
202 Accepted		要求は処理のために受け入れ済みですが、処理はまだ完了していません。ヘッダー Operation-Location: string
Other Status Codes	ErrorResponse	予期しないエラー応答。

名前

型

説明

202 Accepted

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

Operation-Location: string

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
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

定義

名前	説明
CreateProjectOptions	プロジェクトの作成または更新に使用するオプションを表します。
Error	エラーオブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
ExportedProject	エクスポートされたプロジェクトを表します。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	プロジェクトの動作を定義するために使用する設定を表します。
StringIndexType
TextAnalysisAuthoringExportedClass	エクスポートされたプロジェクトのクラスを表します。
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	カスタムエンティティ認識プロジェクトのエクスポートされたドキュメントを表します。
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	エンティティ認識プロジェクトのエクスポートされた資産を表します。
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	カスタムの複数ラベル分類プロジェクトのエクスポートされたドキュメントを表します。
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	カスタムマルチラベル分類プロジェクトのエクスポートされた資産を表します。
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	カスタムの単一ラベル分類プロジェクトのエクスポートされたドキュメントを表します。
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	単一ラベル分類プロジェクトのエクスポートされた資産を表します。
TextAnalysisAuthoringExportedDocumentClass	ドキュメントの分類ラベルを表します。
TextAnalysisAuthoringExportedDocumentEntityLabel	ドキュメントのエンティティラベルを表します。
TextAnalysisAuthoringExportedDocumentEntityRegion	エンティティラベル付けのドキュメント内の領域を表します。
TextAnalysisAuthoringExportedEntity	エクスポートされたプロジェクト内のエンティティを表します。

CreateProjectOptions

プロジェクトの作成または更新に使用するオプションを表します。

名前	型	説明
description	string	プロジェクトの説明。
language	string	プロジェクト言語。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
multilingual	boolean	プロジェクトを複数の言語に使用するかどうか。
projectKind	ProjectKind	プロジェクトの種類。
projectName	string	新しいプロジェクト名。
settings	ProjectSettings	プロジェクトの設定。
storageInputContainerName	string	ストレージコンテナー名。

Error

エラーオブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

人間が判読できるエラーコード。

名前	型	説明
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

エラー応答。

名前	型	説明
error	Error	エラーオブジェクト。

ExportedProject

エクスポートされたプロジェクトを表します。

名前	型	説明
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	プロジェクト資産を表します。
metadata	CreateProjectOptions	プロジェクトのメタデータを表します。
projectFileVersion	string	エクスポートされたファイルのバージョン。
stringIndexType	StringIndexType	文字列オフセットの解釈に使用するメソッドを指定します。詳細については、https://aka.ms/text-analytics-offsetsを参照してください。

InnerErrorCode

人間が判読できるエラーコード。

名前	型	説明
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.

名前	型	説明
code	InnerErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ProjectKind

名前	型	説明
CustomEntityRecognition	string	独自のデータを使用してドメインカテゴリを識別する抽出モデルを構築する場合。
CustomMultiLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルには、1 つまたは複数のラベルを含めることができます。たとえば、ファイル 1 は A、B、C に分類され、ファイル 2 は B と C に分類されます。
CustomSingleLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルにはラベルが 1 つだけ含まれます。たとえば、ファイル 1 は A に分類され、ファイル 2 は B として分類されます。

ProjectSettings

プロジェクトの動作を定義するために使用する設定を表します。

名前	型	説明
confidenceThreshold	number	予測が自動的に "なし" に変更される、信頼度が最も高いクラスのしきい値。しきい値の値は、0 ~ 1 の範囲にする必要があります。

StringIndexType

名前	型	説明
Utf16CodeUnit	string	オフセットと長さの値は UTF-16 コード単位に対応します。アプリケーションが Unicode (Java、JavaScript など) をサポートする言語で記述されている場合は、このオプションを使用します。

TextAnalysisAuthoringExportedClass

エクスポートされたプロジェクトのクラスを表します。

名前	型	説明
category	string	クラスカテゴリ。

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

カスタムエンティティ認識プロジェクトのエクスポートされたドキュメントを表します。

名前	型	説明
dataset	string	このドキュメントのデータセット。使用できる値は 'Train' と 'Test' です。
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	ドキュメントに属するエンティティラベルの一覧。
language	string	ドキュメント言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
location	string	ストレージ内のドキュメントの場所。

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

エンティティ認識プロジェクトのエクスポートされた資産を表します。

名前	型	説明
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	プロジェクトに属するドキュメントの一覧。
entities	TextAnalysisAuthoringExportedEntity[]	プロジェクトに属するエンティティの一覧。
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

カスタムの複数ラベル分類プロジェクトのエクスポートされたドキュメントを表します。

名前	型	説明
classes	TextAnalysisAuthoringExportedDocumentClass[]	ドキュメントクラス。
dataset	string	このドキュメントのデータセット。使用できる値は 'Train' と 'Test' です。
language	string	ドキュメント言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
location	string	ストレージ内のドキュメントの場所。

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

カスタムマルチラベル分類プロジェクトのエクスポートされた資産を表します。

名前	型	説明
classes	TextAnalysisAuthoringExportedClass[]	プロジェクト内のクラスの一覧。
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	プロジェクト内のドキュメントの一覧。
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

カスタムの単一ラベル分類プロジェクトのエクスポートされたドキュメントを表します。

名前	型	説明
class	TextAnalysisAuthoringExportedDocumentClass	ドキュメントのクラス。
dataset	string	このドキュメントのデータセット。使用できる値は 'Train' と 'Test' です。
language	string	ドキュメント言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
location	string	ストレージ内のドキュメントの場所。

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

単一ラベル分類プロジェクトのエクスポートされた資産を表します。

名前	型	説明
classes	TextAnalysisAuthoringExportedClass[]	このプロジェクトに属するクラスの一覧。
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	このプロジェクトに属するドキュメントの一覧。
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

ドキュメントの分類ラベルを表します。

名前	型	説明
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

ドキュメントのエンティティラベルを表します。

名前	型	説明
category	string	エンティティカテゴリ。
length	integer	エンティティテキストの長さ。
offset	integer	エンティティテキストの開始位置。

TextAnalysisAuthoringExportedDocumentEntityRegion

エンティティラベル付けのドキュメント内の領域を表します。

名前	型	説明
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	このリージョンに属するエンティティラベルの一覧。
regionLength	integer	領域テキストの長さ。
regionOffset	integer	リージョンの開始位置。

TextAnalysisAuthoringExportedEntity

エクスポートされたプロジェクト内のエンティティを表します。

名前	型	説明
category	string	エンティティカテゴリ。

次の方法で共有

Text Analysis Authoring - Import

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

OAuth2Auth

スコープ

例

SuccessfulImportProject

要求のサンプル

応答のサンプル

定義

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

その他のリソース