Analyze Text Submit Job - Analyze Text Submit Job

リファレンス

サービス:: Azure AI Services

API バージョン:: 2024-11-01

分析のためにテキストドキュメントのコレクションを送信します。実行時間の長い操作として実行する 1 つ以上の一意のタスクを指定します。

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

URI パラメーター

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

要求本文

名前	必須	型	説明
analysisInput	True	MultiLanguageAnalysisInput	分析する入力を格納します。
tasks	True	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	LRO の一部として実行するタスクの一覧。
displayName		string	タスクの名前。

応答

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

名前

型

説明

202 Accepted

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

ヘッダー

Operation-Location: string

Other Status Codes

ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

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

例

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

SuccessfulAbstractiveSummarizationTaskSubmit

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

SuccessfulHealthcareDocumentTypePostRequest

SuccessfulHealthcarePostRequest

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

要求のサンプル

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "summaryLength": "medium"
      }
    }
  ]
}

応答のサンプル

状態コード:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulAbstractiveSummarizationTaskSubmit

要求のサンプル

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "sentenceCount": 1
      }
    }
  ]
}

応答のサンプル

状態コード:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

要求のサンプル

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "displayName": "Extracting Location & US Region",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "I had a wonderful trip to Seattle last week."
      },
      {
        "id": "2",
        "language": "en",
        "text": "I'm flying to NYC tomorrow. See you there."
      }
    ]
  },
  "tasks": [
    {
      "kind": "EntityRecognition",
      "taskName": "Recognize Entities",
      "parameters": {
        "modelVersion": "latest"
      }
    },
    {
      "kind": "CustomEntityRecognition",
      "taskName": "Recognize US Regions",
      "parameters": {
        "projectName": "MyProject",
        "deploymentName": "MyDeployment"
      }
    }
  ]
}

応答のサンプル

状態コード:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01

SuccessfulHealthcareDocumentTypePostRequest

要求のサンプル

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "analysisInput": {
    "documents": [
      {
        "text": "Prescribed 100mg ibuprofen, taken twice daily.",
        "id": "1",
        "language": "en"
      }
    ]
  },
  "tasks": [
    {
      "kind": "Healthcare",
      "parameters": {
        "modelVersion": "latest",
        "fhirVersion": "4.0.1",
        "documentType": "DischargeSummary"
      }
    }
  ]
}

応答のサンプル

状態コード:: 202

Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01

SuccessfulHealthcarePostRequest

要求のサンプル

HTTP

POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01

{
  "analysisInput": {
    "documents": [
      {
        "text": "Prescribed 100mg ibuprofen, taken twice daily.",
        "id": "1",
        "language": "en"
      }
    ]
  },
  "tasks": [
    {
      "kind": "Healthcare",
      "parameters": {
        "modelVersion": "latest"
      }
    }
  ]
}

応答のサンプル

状態コード:: 202

Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01

定義

名前	説明
AbstractiveSummarizationLROTask	抽象要約タスクのタスク定義を表すオブジェクト。
AbstractiveSummarizationTaskParameters	事前構築済みの抽象要約タスクでサポートされているパラメーター。
AllowOverlapEntityPolicyType	許可の重複ポリシーを表します。エンティティの後処理ロジックは適用されません。モデルが予測するものは何であれ、ユーザーに返される内容です。これにより、ユーザーは、すべてのモデルの使用可能な値の完全なビューを取得し、エンティティの選択に独自のカスタムロジックを適用できます。
AnalyzeTextJobsInput	分析テキスト LRO の入力オブジェクト。
AnalyzeTextLROTaskKind	サポートされている長時間実行される分析テキストタスクの種類。
CustomEntitiesLROTask	カスタムテキスト LRO タスクが含まれています。
CustomEntitiesTaskParameters	カスタムエンティティタスクでサポートされているパラメーター。
CustomMultiLabelClassificationLROTask	カスタムモデルを使用してテキストを複数ラベル分類に分類する
CustomMultiLabelClassificationTaskParameters	カスタム多分類タスクでサポートされているパラメーター。
CustomSingleLabelClassificationLROTask	カスタムモデルを使用してテキストを単一ラベル分類に分類する
CustomSingleLabelClassificationTaskParameters	カスタム単一分類タスクでサポートされているパラメーター。
EntitiesLROTask	エンティティ認識タスクのタスク定義を表すオブジェクト。
EntitiesTaskParameters	エンティティ認識タスクでサポートされているパラメーター。
EntityCategory	エンティティ認識によって検出されたすべてのエンティティカテゴリが含まれます。
EntityInferenceOptions	名前付きエンティティ認識に使用できる推論オプションを含むクラス。
EntityLinkingLROTask	LRO タスクをリンクする分析テキストエンティティが含まれています。
EntityLinkingTaskParameters	エンティティリンクタスクでサポートされているパラメーター。
Error	要求の処理中にサービスでエラーが発生したときに返されるエラー応答オブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
ExtractiveSummarizationLROTask	抽出要約タスクのタスク定義を表すオブジェクト。
ExtractiveSummarizationSortingCriteria	抽出されたサマリーを並べ替える方法を指定します。
ExtractiveSummarizationTaskParameters	抽出要約タスクでサポートされているパラメーター。
fhirVersion	FHIR 仕様のバージョン。
healthcareDocumentType	ドキュメントの種類。
HealthcareLROTask	Healthcare 入力ドキュメントでサービスによって実行される実行時間の長いタスク。
HealthcareTaskParameters	医療タスクでサポートされているパラメーター。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseLROTask	キーフレーズ抽出タスクのタスク定義を表すオブジェクト。
KeyPhraseTaskParameters	キーフレーズ抽出タスクでサポートされているパラメーター。
MatchLongestEntityPolicyType	最長一致の重複ポリシーを表します。可能な限り重複するエンティティはありません。 1. 重複するエンティティがある場合は、最も長いエンティティが返されます。 2. 2 つ以上のエンティティについて予測される文字のセットがまったく同じ場合は、信頼度スコアが高いエンティティを選択します。3。エンティティスコアが同一の場合は、前のルールを適用した後も存在するすべてのエンティティを返します。 3. (Hello Text Analytics のように) 部分的な重複がある場合は、1 から始まる上記の手順に従います。
MultiLanguageAnalysisInput	サービスによって分析される入力ドキュメントのコレクション。
MultiLanguageInput	サービスによって分析される入力ドキュメントが含まれます。
PiiCategory	(省略可能) 返す PII カテゴリについて説明します
PiiDomain	PII タスクのドメイン
PiiLROTask	分析テキスト PIIEntityRecognition LRO タスクが含まれます。
PiiTaskParameters	PII エンティティ認識タスクでサポートされているパラメーター。
SentimentAnalysisLROTask	感情分析タスクのタスク定義を表すオブジェクト。
SentimentAnalysisTaskParameters	感情分析タスクでサポートされているパラメーター。
StringIndexType	文字列インデックスの種類
SummaryLengthBucket	出力の概要の長さを定義する列挙型。

AbstractiveSummarizationLROTask

Object

抽象要約タスクのタスク定義を表すオブジェクト。

名前	型	説明
kind	string: AbstractiveSummarization	実行するタスクの種類。
parameters	AbstractiveSummarizationTaskParameters	抽象要約タスクのパラメーター。
taskName	string	タスク名

AbstractiveSummarizationTaskParameters

Object

事前構築済みの抽象要約タスクでサポートされているパラメーター。

名前	型	規定値	説明
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
sentenceCount	integer (int32)		出力の概要内の文の概数を制御します。
stringIndexType	StringIndexType	TextElements_v8	文字列インデックスの種類
summaryLength	SummaryLengthBucket		(注: sentenceCount よりも summaryLength を使用することをお勧めします)出力の概要のおおよその長さを制御します。

AllowOverlapEntityPolicyType

Object

許可の重複ポリシーを表します。エンティティの後処理ロジックは適用されません。モデルが予測するものは何であれ、ユーザーに返される内容です。これにより、ユーザーは、すべてのモデルの使用可能な値の完全なビューを取得し、エンティティの選択に独自のカスタムロジックを適用できます。

名前	型	規定値	説明
policyKind	string: allowOverlap	matchLongest	エンティティ OverlapPolicy オブジェクトの種類。

AnalyzeTextJobsInput

Object

分析テキスト LRO の入力オブジェクト。

名前	型	説明
analysisInput	MultiLanguageAnalysisInput	分析する入力を格納します。
displayName	string	タスクの名前。
tasks	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	LRO の一部として実行するタスクの一覧。

AnalyzeTextLROTaskKind

列挙

サポートされている長時間実行される分析テキストタスクの種類。

値	説明
AbstractiveSummarization	抽象要約タスク
CustomEntityRecognition	カスタムエンティティ認識タスク
CustomMultiLabelClassification	カスタムの複数ラベル分類タスク
CustomSingleLabelClassification	カスタムの単一ラベル分類タスク
EntityLinking	エンティティリンクタスク
EntityRecognition	エンティティ認識タスク
ExtractiveSummarization	抽出要約タスク
Healthcare	医療タスク
KeyPhraseExtraction	キーフレーズ抽出タスク
PiiEntityRecognition	PII エンティティ認識タスク
SentimentAnalysis	感情分析タスク

CustomEntitiesLROTask

Object

カスタムテキスト LRO タスクが含まれています。

名前	型	説明
kind	string: CustomEntityRecognition	実行するタスクの種類。
parameters	CustomEntitiesTaskParameters	タスクパラメーター。
taskName	string	タスク名

CustomEntitiesTaskParameters

Object

カスタムエンティティタスクでサポートされているパラメーター。

名前	型	規定値	説明
deploymentName	string		このフィールドは、モデルのデプロイ名を示します。
loggingOptOut	boolean	False	オプトアウトのログ記録
projectName	string		このフィールドは、モデルのプロジェクト名を示します。
stringIndexType	StringIndexType	TextElements_v8	文字列オフセットの解釈に使用する文字列インデックスの種類を指定する省略可能なパラメーター。既定値は TextElements (Graphemes) です。

CustomMultiLabelClassificationLROTask

Object

カスタムモデルを使用してテキストを複数ラベル分類に分類する

名前	型	説明
kind	string: CustomMultiLabelClassification	実行するタスクの種類。
parameters	CustomMultiLabelClassificationTaskParameters	タスクパラメーター。
taskName	string	タスク名

CustomMultiLabelClassificationTaskParameters

Object

カスタム多分類タスクでサポートされているパラメーター。

名前	型	規定値	説明
deploymentName	string		このフィールドは、モデルのデプロイ名を示します。
loggingOptOut	boolean	False	オプトアウトのログ記録
projectName	string		このフィールドは、モデルのプロジェクト名を示します。

CustomSingleLabelClassificationLROTask

Object

カスタムモデルを使用してテキストを単一ラベル分類に分類する

名前	型	説明
kind	string: CustomSingleLabelClassification	実行するタスクの種類。
parameters	CustomSingleLabelClassificationTaskParameters	タスクパラメーター
taskName	string	タスク名

CustomSingleLabelClassificationTaskParameters

Object

カスタム単一分類タスクでサポートされているパラメーター。

名前	型	規定値	説明
deploymentName	string		このフィールドは、モデルのデプロイ名を示します。
loggingOptOut	boolean	False	オプトアウトのログ記録
projectName	string		このフィールドは、モデルのプロジェクト名を示します。

EntitiesLROTask

Object

エンティティ認識タスクのタスク定義を表すオブジェクト。

名前	型	説明
kind	string: EntityRecognition	実行するタスクの種類。
parameters	EntitiesTaskParameters	タスクパラメーター。
taskName	string	タスク名

EntitiesTaskParameters

Object

エンティティ認識タスクでサポートされているパラメーター。

名前	型	規定値	説明
exclusionList	EntityCategory[]		(省略可能) excludeList に含まれるエンティティを除外する要求パラメーター。ユーザーが excludeList を指定すると、そのリスト内のエンティティで返される予測を取得できません。 exclusionList の前に inclusionList を適用します
inclusionList	EntityCategory[]		(省略可能) このリストに含まれる要求されたエンティティ型に出力を制限する要求パラメーター。 exclusionList の前に inclusionList を適用します
inferenceOptions	EntityInferenceOptions		(省略可能) 推論を実行するための設定をユーザーが指定できるようにする要求パラメーター。
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(省略可能) ner 出力に適用するオーバーラップポリシーの種類を記述します。
stringIndexType	StringIndexType	TextElements_v8	(省略可能) 文字列オフセットの解釈に使用される文字列インデックス型を指定するパラメーター。既定値は TextElements (Graphemes) です。

EntityCategory

列挙

エンティティ認識によって検出されたすべてのエンティティカテゴリが含まれます。

値	説明
Address	場所の特定の通りレベルのメンション: 住宅/建物番号、通り、通り、高速道路、名前で参照される交差点。
Age	年齢に関連する値。
Airport	空港。
Area	オブジェクトの領域。
City	市区町村関連の値。
ComputingProduct	コンピューティング製品。
Continent	大陸関連の値。
CountryRegion	国または地域に関連する値。
CulturalEvent	文化的なイベント関連の値。
Currency	通貨関連の値。
Date	カレンダーの日付。
DateRange	日付の範囲。
DateTime	カレンダーの日付と時刻。
DateTimeRange	日付と時刻の範囲。
Dimension	測定の寸法
Duration	期間。
Email	電子メールアドレス。
Event	ソーシャル、スポーツ、ビジネス、政治、教育、自然、歴史的、犯罪者、暴力、法的、軍事的なイベント。時間が限られています。
GPE	都市、国/地域、州。
Geological	河川、海洋、砂漠などの地理的および自然の特徴。
Height	オブジェクトの高さ。
IP	ネットワーク IP アドレス。
Information	デジタル情報の測定単位。
Length	オブジェクトの長さ。
Location	物理的な空間内の特定のポイントまたは場所。
NaturalEvent	自然イベント関連の値。
Number	単位のない数値
NumberRange	数値の範囲
Numeric	数字と数字の単語を含む数値。
Ordinal	序数。
Organization	確立された組織構造によって定義された企業、機関、およびその他のグループ。これらのラベルには、企業、政治団体/運動、音楽バンド、スポーツクラブ、政府機関、公共組織などが含まれます。国籍や宗教は組織ではありません。
OrganizationMedical	医療企業とグループ。
OrganizationSports	スポーツ関連組織。
OrganizationStockExchange	証券取引所グループ。
Percentage	パーセンテージ関連の値。
Person	最初、姓、ミドルネーム、架空の文字の名前、エイリアス。タイトル ("Mr." など) または 'President' は、名前付きエンティティの一部とは見なされません。
PersonType	グループメンバーシップによって分類される人間の役割。
PhoneNumber	電話番号 (米国と EU の電話番号のみ)。
Product	商用、消耗品、エレクトロニクス、車両、食品グループの単一またはグループ。
SetTemporal	時間関連の値のセット。
Skill	機能、スキル、または専門知識。
Speed	オブジェクトの速度。
SportsEvent	スポーツイベント関連の値。
State	状態関連の値。
Structural	マンメイド構造。
Temperature	温度関連の値。
Temporal	時間に関連する項目。
Time	1 日の時刻。
TimeRange	時間の範囲。
URL	Web サイトへの URL。
Volume	オブジェクトのボリューム。
Weight	オブジェクトの重み。

EntityInferenceOptions

Object

名前付きエンティティ認識に使用できる推論オプションを含むクラス。

名前	型	規定値	説明
excludeNormalizedValues	boolean	False	正規化してメタデータに含める、検出されたエンティティ値を含める/除外するオプション。数値エンティティ型とテンポラルエンティティ型は、値の正規化をサポートします。

EntityLinkingLROTask

Object

LRO タスクをリンクする分析テキストエンティティが含まれています。

名前	型	説明
kind	string: EntityLinking	実行するタスクの種類。
parameters	EntityLinkingTaskParameters	タスクパラメーター。
taskName	string	タスク名

EntityLinkingTaskParameters

Object

エンティティリンクタスクでサポートされているパラメーター。

名前	型	規定値	説明
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
stringIndexType	StringIndexType	TextElements_v8	文字列オフセットの解釈に使用する文字列インデックスの種類を指定する省略可能なパラメーター。既定値は TextElements (Graphemes) です。

Error

Object

要求の処理中にサービスでエラーが発生したときに返されるエラー応答オブジェクト。

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

ErrorCode

列挙

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

値	説明
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search インデックスの制限に達しましたエラー
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search インデックスが見つかりませんエラー
AzureCognitiveSearchNotFound	Azure Cognitive Search が見つかりませんエラー
AzureCognitiveSearchThrottling	Azure Cognitive Search の調整エラー
Conflict	競合エラー
Forbidden	許可されていないアクセスエラー
InternalServerError	内部サーバーエラー
InvalidArgument	無効な引数エラー
InvalidRequest	要求エラーが無効です
NotFound	見つからないエラー
OperationNotFound	操作が見つかりませんエラー
ProjectNotFound	プロジェクトが見つかりませんエラー
QuotaExceeded	クォータ超過エラー
ServiceUnavailable	サービス利用不可エラー
Timeout	タイムアウトエラー
TooManyRequests	要求が多すぎますエラー
Unauthorized	未承認のアクセスエラー
Warning	警告エラー

ErrorResponse

Object

エラー応答。

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

ExtractiveSummarizationLROTask

Object

抽出要約タスクのタスク定義を表すオブジェクト。

名前	型	説明
kind	string: ExtractiveSummarization	実行するタスクの種類。
parameters	ExtractiveSummarizationTaskParameters	抽出要約タスクのパラメーター。
taskName	string	タスク名

ExtractiveSummarizationSortingCriteria

列挙

抽出されたサマリーを並べ替える方法を指定します。

値	説明
Offset	テキスト内の外観順に結果を並べ替える必要があることを示します。
Rank	モデルに従って、重要度 (つまりランクスコア) の順に結果を並べ替える必要があることを示します。

ExtractiveSummarizationTaskParameters

Object

抽出要約タスクでサポートされているパラメーター。

名前	型	規定値	説明
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
sentenceCount	integer (int64)	3	抽出されたサマリー内の文の数を指定します。
sortBy	ExtractiveSummarizationSortingCriteria	Offset	抽出されたサマリーを並べ替える方法を指定します。
stringIndexType	StringIndexType	TextElements_v8	文字列オフセットの解釈に使用するメソッドを指定します。

fhirVersion

列挙

FHIR 仕様のバージョン。

値	説明
4.0.1	バージョン 4.0.1

healthcareDocumentType

列挙

ドキュメントの種類。

値	説明
ClinicalTrial	臨床試験のドキュメントの種類
Consult	ドキュメントの種類を確認する
DischargeSummary	放電の概要ドキュメントの種類
HistoryAndPhysical	履歴と物理的なドキュメントの種類
Imaging	イメージングドキュメントの種類
None	ドキュメントの種類なし
Pathology	病理ドキュメントの種類
ProcedureNote	プロシージャノートのドキュメントの種類
ProgressNote	進行状況メモのドキュメントの種類

HealthcareLROTask

Object

Healthcare 入力ドキュメントでサービスによって実行される実行時間の長いタスク。

名前	型	説明
kind	string: Healthcare	実行するタスクの種類。
parameters	HealthcareTaskParameters	Healthcare タスクのパラメーター。
taskName	string	タスク名

HealthcareTaskParameters

Object

医療タスクでサポートされているパラメーター。

名前	型	規定値	説明
documentType	healthcareDocumentType		Fhir ドキュメントの入力として指定できるドキュメントの種類。使用する場合は、fhirVersion を指定する必要があります。 None 列挙型を使用する動作は、documentType パラメーターを使用しない場合と同じです。
fhirVersion	fhirVersion		結果が fhirBundle の書式設定に使用する FHIR Spec バージョン。詳細については、https://www.hl7.org/fhir/overview.htmlを参照してください。
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
stringIndexType	StringIndexType	TextElements_v8	文字列オフセットの解釈に使用するメソッドを指定します。

InnerErrorCode

列挙

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

値	説明
AzureCognitiveSearchNotFound	Azure Cognitive Search が見つかりませんエラー
AzureCognitiveSearchThrottling	Azure Cognitive Search の調整エラー
EmptyRequest	空の要求エラー
ExtractionFailure	抽出エラーエラー
InvalidCountryHint	無効な国ヒントエラー
InvalidDocument	無効なドキュメントエラー
InvalidDocumentBatch	無効なドキュメントバッチエラー
InvalidParameterValue	パラメーター値のエラーが無効です
InvalidRequest	要求エラーが無効です
InvalidRequestBodyFormat	要求本文の形式エラーが無効です
KnowledgeBaseNotFound	ナレッジベースが見つかりませんエラー
MissingInputDocuments	入力ドキュメントが見つからないエラー
ModelVersionIncorrect	モデルのバージョンが正しくないエラー
UnsupportedLanguageCode	サポートされていない言語コードエラー

InnerErrorModel

Object

エラーに関するより具体的な情報を含むオブジェクト。 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	エラーターゲット。

KeyPhraseLROTask

Object

キーフレーズ抽出タスクのタスク定義を表すオブジェクト。

名前	型	説明
kind	string: KeyPhraseExtraction	実行するタスクの種類。
parameters	KeyPhraseTaskParameters	キーフレーズ抽出タスクのパラメーター。
taskName	string	タスク名

KeyPhraseTaskParameters

Object

キーフレーズ抽出タスクでサポートされているパラメーター。

名前	型	規定値	説明
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン

MatchLongestEntityPolicyType

Object

最長一致の重複ポリシーを表します。可能な限り重複するエンティティはありません。 1. 重複するエンティティがある場合は、最も長いエンティティが返されます。 2. 2 つ以上のエンティティについて予測される文字のセットがまったく同じ場合は、信頼度スコアが高いエンティティを選択します。3。エンティティスコアが同一の場合は、前のルールを適用した後も存在するすべてのエンティティを返します。 3. (Hello Text Analytics のように) 部分的な重複がある場合は、1 から始まる上記の手順に従います。

名前	型	規定値	説明
policyKind	string: matchLongest	matchLongest	エンティティ OverlapPolicy オブジェクトの種類。

MultiLanguageAnalysisInput

Object

サービスによって分析される入力ドキュメントのコレクション。

名前	型	説明
documents	MultiLanguageInput[]	分析する入力ドキュメント。

MultiLanguageInput

Object

サービスによって分析される入力ドキュメントが含まれます。

名前	型	説明
id	string	空でない一意のドキュメント識別子。
language	string	(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 (以下は 2023-04-15-preview 以降にのみ適用されます)自動言語検出の場合は、"auto" を使用します。設定しない場合は、既定で英語に "en" を使用します。
text	string	処理する入力テキスト。

PiiCategory

列挙

(省略可能) 返す PII カテゴリについて説明します

値	説明
ABARoutingNumber	ABA ルーティング番号
ARNationalIdentityNumber	AR National Identity Number
ATIdentityCard	AT ID カード
ATTaxIdentificationNumber	AT 税識別番号
ATValueAddedTaxNumber	AT 付加価値税番号
AUBankAccountNumber	AT 銀行口座番号
AUBusinessNumber	AU ビジネス番号
AUCompanyNumber	AU の会社番号
AUDriversLicenseNumber	AU 運転免許証番号
AUMedicalAccountNumber	AU医療口座番号
AUPassportNumber	AU パスポート番号
AUTaxFileNumber	AU 税ファイル番号
Address	住所
Age	年齢
All	すべての PII カテゴリ。
AzureDocumentDBAuthKey	Azure Document DB 認証キー
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS データベース接続と SQL 文字列
AzureIoTConnectionString	Azure IoT 接続文字列
AzurePublishSettingPassword	Azure 発行設定パスワード
AzureRedisCacheString	Azure Redis Cache 文字列
AzureSAS	Azure SAS
AzureServiceBusString	Azure Service Bus 文字列
AzureStorageAccountGeneric	Azure Storage アカウント汎用
AzureStorageAccountKey	Azure Storage アカウントキー
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE 付加価値税番号
BGUniformCivilNumber	BG Uniform Civil Number
BRCPFNumber	BR CPF 番号
BRLegalEntityNumber	BR 法人番号
BRNationalIDRG	BR National ID RG
CABankAccountNumber	CA 銀行口座番号
CADriversLicenseNumber	CA 運転免許証番号
CAHealthServiceNumber	CA ヘルスサービス番号
CAPassportNumber	CA Passport Number
CAPersonalHealthIdentification	CA の個人の正常性の識別
CASocialInsuranceNumber	CA 社会保険番号
CHSocialSecurityNumber	CH 社会保障番号
CLIdentityCardNumber	CL ID カード番号
CNResidentIdentityCardNumber	CN 常駐 ID カード番号
CYIdentityCard	CY ID カード
CYTaxIdentificationNumber	CY 税識別番号
CZPersonalIdentityNumber	CZ 個人 ID 番号
CZPersonalIdentityV2	CZ Personal Identity V2
CreditCardNumber	クレジットカード番号
DEDriversLicenseNumber	DE 運転免許証番号
DEIdentityCardNumber	DE ID カード番号
DEPassportNumber	DE Passport Number
DETaxIdentificationNumber	DE 税識別番号
DEValueAddedNumber	DE Value Added Number
DKPersonalIdentificationNumber	DK の個人識別番号
DKPersonalIdentificationV2	DK の個人識別 V2
Date	日付
Default	言語の既定の PII カテゴリ。
DrugEnforcementAgencyNumber	薬物執行機関番号
EEPersonalIdentificationCode	EE 個人識別コード
ESDNI	ES DNI
ESSocialSecurityNumber	ES 社会保障番号
ESTaxIdentificationNumber	ES 税識別番号
EUDebitCardNumber	EU デビットカード番号
EUDriversLicenseNumber	EU 運転免許証番号
EUGPSCoordinates	EU GPS 座標
EUNationalIdentificationNumber	EU の国民識別番号
EUPassportNumber	EU パスポート番号
EUSocialSecurityNumber	EU 社会保障番号
EUTaxIdentificationNumber	EU の税識別番号
Email	電子メール
FIEuropeanHealthNumber	FI ヨーロッパの健康番号
FINationalID	FI National ID
FINationalIDV2	FI National ID V2
FIPassportNumber	FI パスポート番号
FRDriversLicenseNumber	FR 運転免許証番号
FRHealthInsuranceNumber	FR健康保険番号
FRNationalID	FR National ID
FRPassportNumber	FR パスポート番号
FRSocialSecurityNumber	FR社会保障番号
FRTaxIdentificationNumber	FR 税識別番号
FRValueAddedTaxNumber	FR 付加価値税番号
GRNationalIDCard	GRナショナルIDカード
GRNationalIDV2	GR National ID V2
GRTaxIdentificationNumber	GR 税識別番号
HKIdentityCardNumber	HK ID カード番号
HRIdentityCardNumber	HR ID カード番号
HRNationalIDNumber	人事の国民 ID 番号
HRPersonalIdentificationNumber	HR の個人識別番号
HRPersonalIdentificationOIBNumberV2	HR の個人識別 OIB 番号 V2
HUPersonalIdentificationNumber	HU 個人識別番号
HUTaxIdentificationNumber	HU 税識別番号
HUValueAddedNumber	HU 付加価値番号
IDIdentityCardNumber	ID ID カード番号
IEPersonalPublicServiceNumber	IE 個人用パブリックサービス番号
IEPersonalPublicServiceNumberV2	IE Personal Public Service Number V2
ILBankAccountNumber	IL 銀行口座番号
ILNationalID	IL National ID
INPermanentAccount	IN Permanent Account
INUniqueIdentificationNumber	IN 固有の識別番号
IPAddress	IPアドレス
ITDriversLicenseNumber	IT 運転免許証番号
ITFiscalCode	IT 会計コード
ITValueAddedTaxNumber	IT 付加価値税番号
InternationalBankingAccountNumber	国際銀行口座番号
JPBankAccountNumber	JP銀行口座番号
JPDriversLicenseNumber	JP運転免許証番号
JPMyNumberCorporate	JP マイナンバーコーポレート
JPMyNumberPersonal	JPマイナンバーパーソナル
JPPassportNumber	JPパスポート番号
JPResidenceCardNumber	JPレジデンスカード番号
JPResidentRegistrationNumber	日本居住者登録番号
JPSocialInsuranceNumber	JP社会保険番号
KRResidentRegistrationNumber	KR住民登録番号
LTPersonalCode	LT 個人用コード
LUNationalIdentificationNumberNatural	LU の国民識別番号 (自然)
LUNationalIdentificationNumberNonNatural	LU の国民識別番号 (自然ではない)
LVPersonalCode	LV 個人用コード
MTIdentityCardNumber	MT ID カード番号
MTTaxIDNumber	MT 税 ID 番号
MYIdentityCardNumber	マイ ID カード番号
NLCitizensServiceNumber	NL 市民サービス番号
NLCitizensServiceNumberV2	NL 市民サービス番号 V2
NLTaxIdentificationNumber	NL 税識別番号
NLValueAddedTaxNumber	NL 付加価値税番号
NOIdentityNumber	ID 番号なし
NZBankAccountNumber	NZ 銀行口座番号
NZDriversLicenseNumber	NZ 運転免許証番号
NZInlandRevenueNumber	NZ 内陸収益番号
NZMinistryOfHealthNumber	NZ 保健省番号
NZSocialWelfareNumber	NZ社会保障番号
Organization	組織
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID Number
PLIdentityCard	PL ID カード
PLNationalID	PL National ID
PLNationalIDV2	PL National ID V2
PLPassportNumber	PL パスポート番号
PLREGONNumber	PL REGON 番号
PLTaxIdentificationNumber	PL 税識別番号
PTCitizenCardNumber	PT 市民カード番号
PTCitizenCardNumberV2	PT 市民カード番号 V2
PTTaxIdentificationNumber	PT 税識別番号
Person	人
PhoneNumber	電話番号
ROPersonalNumericalCode	RO 個人数値コード
RUPassportNumberDomestic	RU Passport Number Domestic
RUPassportNumberInternational	RU Passport Number International
SANationalID	SA National ID
SENationalID	SE National ID
SENationalIDV2	SE National ID V2
SEPassportNumber	SE Passport Number
SETaxIdentificationNumber	SE 税識別番号
SGNationalRegistrationIdentityCardNumber	SG 国内登録 ID カード番号
SITaxIdentificationNumber	SI 税識別番号
SIUniqueMasterCitizenNumber	SI 固有のマスター市民番号
SKPersonalNumber	SK 個人番号
SQLServerConnectionString	SQL Server 接続文字列
SWIFTCode	SWIFT コード
THPopulationIdentificationCode	TH 母集団識別コード
TRNationalIdentificationNumber	TR の国民識別番号
TWNationalID	TW National ID
TWPassportNumber	TW パスポート番号
TWResidentCertificate	TW 常駐証明書
UAPassportNumberDomestic	UAパスポート番号国内
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	英国の運転免許証番号
UKElectoralRollNumber	英国の選挙ロール番号
UKNationalHealthNumber	英国の国民健康番号
UKNationalInsuranceNumber	英国国民保険番号
UKUniqueTaxpayerNumber	英国の一意の納税者番号
URL	URL
USBankAccountNumber	米国の銀行口座番号
USDriversLicenseNumber	米国運転免許証番号
USIndividualTaxpayerIdentification	米国の個人納税者識別情報
USSocialSecurityNumber	米国社会保障番号
USUKPassportNumber	米国の英国のパスポート番号
ZAIdentificationNumber	ZA 識別番号

PiiDomain

列挙

PII タスクのドメイン

値	説明
none	ドメインが指定されていないことを示します。
phi	Personal Health Information ドメイン内のエンティティを編集する必要があることを示します。

PiiLROTask

Object

分析テキスト PIIEntityRecognition LRO タスクが含まれます。

名前	型	説明
kind	string: PiiEntityRecognition	実行するタスクの種類。
parameters	PiiTaskParameters	Pii タスクパラメーター。
taskName	string	タスク名

PiiTaskParameters

Object

PII エンティティ認識タスクでサポートされているパラメーター。

名前	型	規定値	説明
domain	PiiDomain	none	PII タスクのドメイン
loggingOptOut	boolean	True	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
piiCategories	PiiCategory[]		応答で返される PII カテゴリの列挙。
stringIndexType	StringIndexType	TextElements_v8	分析に使用する StringIndexType。

SentimentAnalysisLROTask

Object

感情分析タスクのタスク定義を表すオブジェクト。

名前	型	説明
kind	string: SentimentAnalysis	実行するタスクの種類。
parameters	SentimentAnalysisTaskParameters	感情分析タスクのパラメーター。
taskName	string	タスク名

SentimentAnalysisTaskParameters

Object

感情分析タスクでサポートされているパラメーター。

名前	型	規定値	説明
loggingOptOut	boolean	False	オプトアウトのログ記録
modelVersion	string	latest	モデルバージョン
opinionMining	boolean	False	要求でオピニオンマイニングを使用するかどうか。
stringIndexType	StringIndexType	TextElements_v8	文字列オフセットの解釈に使用するメソッドを指定します。

StringIndexType

列挙

文字列インデックスの種類

値	説明
TextElements_v8	返されるオフセットと長さの値は、Unicode 8.0.0 標準を確認する TextElements (Graphemes および Grapheme クラスター) に対応します。アプリケーションが .Net Framework または .Net Core で記述されていて、StringInfo を使用する場合は、このオプションを使用します。
UnicodeCodePoint	返されるオフセット値と長さの値は、Unicode コードポイントに対応します。このオプションは、アプリケーションが Unicode (Python など) をサポートする言語で記述されている場合に使用します。
Utf16CodeUnit	返されるオフセットと長さの値は、UTF-16 コード単位に対応します。アプリケーションが Unicode (Java、JavaScript など) をサポートする言語で記述されている場合は、このオプションを使用します。

SummaryLengthBucket

列挙

出力の概要の長さを定義する列挙型。

値	説明
long	長い長さの概要を生成するようにモデルに指示します。
medium	中程度の長さの概要を生成するようにモデルに指示します。
short	短い長さの概要を生成するようにモデルに指示します。

次の方法で共有

Analyze Text Submit Job - Analyze Text Submit Job

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

OAuth2Auth

スコープ

例

SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit

要求のサンプル

応答のサンプル

SuccessfulAbstractiveSummarizationTaskSubmit

要求のサンプル

応答のサンプル

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

要求のサンプル

応答のサンプル

SuccessfulHealthcareDocumentTypePostRequest

要求のサンプル

応答のサンプル

SuccessfulHealthcarePostRequest

要求のサンプル

応答のサンプル

定義

AbstractiveSummarizationLROTask

AbstractiveSummarizationTaskParameters

AllowOverlapEntityPolicyType

AnalyzeTextJobsInput

AnalyzeTextLROTaskKind

CustomEntitiesLROTask

CustomEntitiesTaskParameters

CustomMultiLabelClassificationLROTask

CustomMultiLabelClassificationTaskParameters

CustomSingleLabelClassificationLROTask

CustomSingleLabelClassificationTaskParameters

EntitiesLROTask

EntitiesTaskParameters

EntityCategory

EntityInferenceOptions

EntityLinkingLROTask

EntityLinkingTaskParameters

Error

ErrorCode

ErrorResponse

ExtractiveSummarizationLROTask

ExtractiveSummarizationSortingCriteria

ExtractiveSummarizationTaskParameters

fhirVersion

healthcareDocumentType

HealthcareLROTask

HealthcareTaskParameters

InnerErrorCode

InnerErrorModel

KeyPhraseLROTask

KeyPhraseTaskParameters

MatchLongestEntityPolicyType

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiLROTask

PiiTaskParameters

SentimentAnalysisLROTask

SentimentAnalysisTaskParameters

StringIndexType

SummaryLengthBucket