Text Analysis Runtime - Analyze Text
ドキュメントのコレクションに対するテキスト分析を要求します。
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
show
|
query |
boolean |
(省略可能) が true に設定されている場合、応答には要求レベルとドキュメント レベルの統計が含まれます。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
要求本文
要求本文は、次のいずれかの可能性があります。
名前 | 説明 |
---|---|
Analyze |
分析テキストエンティティ リンク入力が含まれています。 |
Analyze |
エンティティ認識では、テキスト入力タスク要求が分析されます。 |
Analyze |
分析テキスト KeyPhraseExtraction タスク入力が含まれます。 |
Analyze |
言語検出ドキュメント分析タスク入力が含まれます。 |
Analyze |
分析テキスト PIIEntityRecognition タスク入力が含まれます。 |
Analyze |
分析テキスト SentimentAnalysis タスク入力が含まれます。 |
AnalyzeTextEntityLinkingInput
分析テキストエンティティ リンク入力が含まれています。
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
string:
Entity |
実行するタスクの種類。 |
analysisInput |
サービスによって処理される分析入力が含まれます。 |
||
parameters |
タスク パラメーター。 |
AnalyzeTextEntityRecognitionInput
エンティティ認識では、テキスト入力タスク要求が分析されます。
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
string:
Entity |
実行するタスクの種類。 |
analysisInput |
分析する入力。 |
||
parameters |
タスク パラメーター。 |
AnalyzeTextKeyPhraseExtractionInput
分析テキスト KeyPhraseExtraction タスク入力が含まれます。
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
string:
Key |
実行するタスクの種類。 |
analysisInput |
入力ドキュメントを格納します。 |
||
parameters |
キー フレーズ抽出タスク のパラメーター。 |
AnalyzeTextLanguageDetectionInput
言語検出ドキュメント分析タスク入力が含まれます。
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
string:
Language |
実行するタスクの種類。 |
analysisInput |
分析するドキュメント。 |
||
parameters |
タスク パラメーター。 |
AnalyzeTextPiiEntitiesRecognitionInput
分析テキスト PIIEntityRecognition タスク入力が含まれます。
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
string:
Pii |
実行するタスクの種類。 |
analysisInput |
入力ドキュメントを格納します。 |
||
parameters |
Pii タスク パラメーター。 |
AnalyzeTextSentimentAnalysisInput
分析テキスト SentimentAnalysis タスク入力が含まれます。
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
string:
Sentiment |
実行するタスクの種類。 |
analysisInput |
入力ドキュメントを格納します。 |
||
parameters |
感情分析タスクパラメーター。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK | AnalyzeTextTaskResult: |
要求は成功しました。 |
Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
Ocp-Apim-Subscription-Key
型:
apiKey
/:
header
例
SuccessfulEntityLinkingRequest
要求のサンプル
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "EntityLinking",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Pike place market is my favorite Seattle attraction."
}
]
}
}
応答のサンプル
{
"kind": "EntityLinkingResults",
"results": {
"documents": [
{
"entities": [
{
"dataSource": "Wikipedia",
"id": "Bill Gates",
"language": "en",
"matches": [
{
"confidenceScore": 0.52,
"length": 10,
"offset": 25,
"text": "Bill Gates"
}
],
"name": "Bill Gates",
"url": "https://en.wikipedia.org/wiki/Bill_Gates"
},
{
"dataSource": "Wikipedia",
"id": "Paul Allen",
"language": "en",
"matches": [
{
"confidenceScore": 0.54,
"length": 10,
"offset": 40,
"text": "Paul Allen"
}
],
"name": "Paul Allen",
"url": "https://en.wikipedia.org/wiki/Paul_Allen"
},
{
"dataSource": "Wikipedia",
"id": "Microsoft",
"language": "en",
"matches": [
{
"confidenceScore": 0.49,
"length": 9,
"offset": 0,
"text": "Microsoft"
}
],
"name": "Microsoft",
"url": "https://en.wikipedia.org/wiki/Microsoft"
}
],
"id": "1",
"warnings": []
},
{
"entities": [
{
"dataSource": "Wikipedia",
"id": "Pike Place Market",
"language": "en",
"matches": [
{
"confidenceScore": 0.86,
"length": 17,
"offset": 0,
"text": "Pike place market"
}
],
"name": "Pike Place Market",
"url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
},
{
"dataSource": "Wikipedia",
"id": "Seattle",
"language": "en",
"matches": [
{
"confidenceScore": 0.27,
"length": 7,
"offset": 33,
"text": "Seattle"
}
],
"name": "Seattle",
"url": "https://en.wikipedia.org/wiki/Seattle"
}
],
"id": "2",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-02-01"
}
}
SuccessfulEntityRecognitionRequest
要求のサンプル
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "EntityRecognition",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Pike place market is my favorite Seattle attraction."
}
]
}
}
応答のサンプル
{
"kind": "EntityRecognitionResults",
"results": {
"documents": [
{
"entities": [
{
"category": "Organization",
"confidenceScore": 0.84,
"length": 9,
"offset": 0,
"text": "Microsoft"
},
{
"category": "Person",
"confidenceScore": 0.85,
"length": 10,
"offset": 25,
"text": "Bill Gates"
},
{
"category": "Person",
"confidenceScore": 0.9,
"length": 10,
"offset": 40,
"text": "Paul Allen"
}
],
"id": "1",
"warnings": []
},
{
"entities": [
{
"category": "Location",
"confidenceScore": 0.55,
"length": 7,
"offset": 33,
"subcategory": "GPE",
"text": "Seattle"
}
],
"id": "2",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
SuccessfulKeyPhraseExtractionRequest
要求のサンプル
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "KeyPhraseExtraction",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Text Analytics is one of the Azure Cognitive Services."
},
{
"id": "3",
"language": "en",
"text": "My cat might need to see a veterinarian."
}
]
}
}
応答のサンプル
{
"kind": "KeyPhraseExtractionResults",
"results": {
"documents": [
{
"id": "1",
"keyPhrases": [
"Bill Gates",
"Paul Allen",
"Microsoft"
],
"warnings": []
},
{
"id": "2",
"keyPhrases": [
"Azure Cognitive Services",
"Text Analytics"
],
"warnings": []
},
{
"id": "3",
"keyPhrases": [
"cat",
"veterinarian"
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-06-01"
}
}
SuccessfulLanguageDetectionRequest
要求のサンプル
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "LanguageDetection",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"text": "Hello world"
},
{
"id": "2",
"text": "Bonjour tout le monde"
},
{
"id": "3",
"text": "Hola mundo"
},
{
"id": "4",
"text": "Tumhara naam kya hai?"
}
]
}
}
応答のサンプル
{
"kind": "LanguageDetectionResults",
"results": {
"documents": [
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "en",
"name": "English"
},
"id": "1",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "fr",
"name": "French"
},
"id": "2",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "es",
"name": "Spanish"
},
"id": "3",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "hi",
"name": "Hindi"
},
"id": "4",
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-01-05"
}
}
SuccessfulPiiEntityRecognitionRequest
要求のサンプル
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "PiiEntityRecognition",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "My SSN is 859-98-0987"
},
{
"id": "2",
"language": "en",
"text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
},
{
"id": "3",
"language": "en",
"text": "Is 998.214.865-68 your Brazilian CPF number?"
}
]
}
}
応答のサンプル
{
"kind": "PiiEntityRecognitionResults",
"results": {
"documents": [
{
"id": "1",
"redactedText": "My SSN is ***********",
"entities": [
{
"category": "USSocialSecurityNumber",
"confidenceScore": 0.65,
"length": 11,
"offset": 28,
"text": "859-98-0987"
}
],
"warnings": []
},
{
"id": "2",
"redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
"entities": [
{
"category": "ABARoutingNumber",
"confidenceScore": 0.75,
"length": 9,
"offset": 18,
"text": "111000025"
}
],
"warnings": []
},
{
"id": "3",
"redactedText": "Is ************** your Brazilian CPF number?",
"entities": [
{
"category": "BRCPFNumber",
"confidenceScore": 0.85,
"length": 14,
"offset": 3,
"text": "998.214.865-68"
}
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-01-15"
}
}
SuccessfulSentimentAnalysisRequest
要求のサンプル
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "SentimentAnalysis",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
}
]
}
}
応答のサンプル
{
"kind": "SentimentAnalysisResults",
"results": {
"documents": [
{
"confidenceScores": {
"negative": 0,
"neutral": 0,
"positive": 1
},
"id": "1",
"sentences": [
{
"targets": [
{
"confidenceScores": {
"negative": 0,
"positive": 1
},
"length": 10,
"offset": 6,
"relations": [
{
"ref": "#/documents/0/sentences/0/assessments/0",
"relationType": "assessment"
}
],
"sentiment": "positive",
"text": "atmosphere"
}
],
"confidenceScores": {
"negative": 0,
"neutral": 0,
"positive": 1
},
"length": 17,
"offset": 0,
"assessments": [
{
"confidenceScores": {
"negative": 0,
"positive": 1
},
"isNegated": false,
"length": 5,
"offset": 0,
"sentiment": "positive",
"text": "great"
}
],
"sentiment": "positive",
"text": "Great atmosphere."
},
{
"targets": [
{
"confidenceScores": {
"negative": 0.01,
"positive": 0.99
},
"length": 11,
"offset": 37,
"relations": [
{
"ref": "#/documents/0/sentences/1/assessments/0",
"relationType": "assessment"
}
],
"sentiment": "positive",
"text": "restaurants"
},
{
"confidenceScores": {
"negative": 0.01,
"positive": 0.99
},
"length": 6,
"offset": 50,
"relations": [
{
"ref": "#/documents/0/sentences/1/assessments/0",
"relationType": "assessment"
}
],
"sentiment": "positive",
"text": "hotels"
}
],
"confidenceScores": {
"negative": 0.01,
"neutral": 0.86,
"positive": 0.13
},
"length": 52,
"offset": 18,
"assessments": [
{
"confidenceScores": {
"negative": 0.01,
"positive": 0.99
},
"isNegated": false,
"length": 15,
"offset": 18,
"sentiment": "positive",
"text": "Close to plenty"
}
],
"sentiment": "neutral",
"text": "Close to plenty of restaurants, hotels, and transit!"
}
],
"sentiment": "positive",
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-10-01"
}
}
定義
名前 | 説明 |
---|---|
Analyze |
分析テキストエンティティ リンク入力が含まれます。 |
Analyze |
エンティティ認識では、テキスト入力タスク要求が分析されます。 |
Analyze |
分析テキスト KeyPhraseExtraction タスク入力が含まれます。 |
Analyze |
言語検出ドキュメント分析タスクの入力が含まれます。 |
Analyze |
分析テキスト PIIEntityRecognition タスク入力が含まれます。 |
Analyze |
SentimentAnalysis タスク入力の分析テキストが含まれます。 |
Analyze |
サポートされている分析テキスト タスクの種類。 |
Analyze |
テキスト分析タスクによって返される応答オブジェクトの種類。 |
Detected |
テキストに対して検出された言語の詳細が含まれます。 |
Document |
ジョブの実行中に発生したエラーの詳細が含まれます。 |
Document |
ドキュメントの予測センチメント (Negative、Neutral、Positive、または Mixed)。 |
Document |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
Document |
処理されたドキュメントに対して発生した警告を含む warnings オブジェクトが含まれます。 |
Entities |
ドキュメントのエンティティ認識タスクの結果を格納します。 |
Entities |
エンティティ認識タスクの結果を格納します。 |
Entities |
エンティティ認識タスクでサポートされているパラメーター。 |
Entities |
エンティティ タスクを含む |
Entity |
検出されたエンティティ カテゴリや検出されたエンティティ テキストなどを含む、検出されたエンティティ オブジェクトを定義します。 |
Entity |
エンティティ リンクの結果。 |
Entity |
エンティティ リンク タスクでサポートされているパラメーター。 |
Entity |
分析テキストエンティティ リンク タスクの結果が含まれます。 |
Error |
要求の処理中にサービスでエラーが発生したときに返されるエラー応答オブジェクト。 |
Error |
人間が判読できるエラー コード。 |
Error |
エラー応答。 |
Inner |
人間が判読できるエラー コード。 |
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
Key |
KeyPhraseResult を格納します。 |
Key |
ドキュメントのキー フレーズ抽出結果が含まれます。 |
Key |
キー フレーズ抽出タスクでサポートされているパラメーター。 |
Key |
分析テキスト KeyPhraseExtraction タスクの結果を格納します。 |
Language |
言語検出ドキュメント分析入力が含まれます。 |
Language |
ドキュメントの言語検出を含みます。 |
Language |
要求の言語検出結果が含まれます。 |
Language |
言語検出タスクでサポートされているパラメーター。 |
Language |
要求の言語検出タスクの結果が含まれます。 |
Language |
言語検出入力が含まれます。 |
Linked |
ドキュメントの結果をリンクするエンティティ。 |
Linked |
関連付けられたソース/リンクを持つ検出されたエンティティを含む LinkedEntity オブジェクト。 |
Match |
オフセットと長さを持つ検出されたエンティティ テキストを含む Match オブジェクト。 |
Multi |
サービスによって分析される入力ドキュメントのコレクション。 |
Multi |
サービスによって分析される入力ドキュメントが含まれます。 |
Pii |
(省略可能) 返す PII カテゴリについて説明します |
Pii |
PII タスクのドメイン |
Pii |
PII の結果が含まれます。 |
Pii |
PiiResult を格納します。 |
Pii |
PII エンティティ認識タスクでサポートされているパラメーター。 |
Pii |
分析テキスト PIIEntityRecognition LRO タスクを含みます。 |
Request |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
Sentence |
文の評価と、それに関連する評価またはターゲット オブジェクトを表します。 |
Sentence |
ドキュメントの文のセンチメント。 |
Sentence |
文の予測センチメント。 |
Sentence |
文のターゲットと、それに関連する評価またはターゲット オブジェクトを表します。 |
Sentiment |
感情分析タスクでサポートされているパラメーター。 |
Sentiment |
すべてのセンチメント クラスで 0 から 1 の信頼度スコア (正、中立、負) を表します。 |
Sentiment |
各ドキュメントの事前構築済みの感情分析結果を表す オブジェクト。 |
Sentiment |
入力ドキュメントの感情分析結果。 |
Sentiment |
分析テキスト SentimentAnalysis LRO タスクの結果が含まれます。 |
String |
文字列インデックスの種類 |
Target |
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。 |
Target |
評価とターゲットの間の関係を表します。 |
Target |
ターゲットに関連する型。 |
Token |
文の予測センチメント。 |
Warning |
警告コードの一覧を定義します。 |
AnalyzeTextEntityLinkingInput
分析テキストエンティティ リンク入力が含まれます。
名前 | 型 | 説明 |
---|---|---|
analysisInput |
サービスによって処理される分析入力が含まれます。 |
|
kind |
string:
Entity |
実行するタスクの種類。 |
parameters |
タスク パラメーター。 |
AnalyzeTextEntityRecognitionInput
エンティティ認識では、テキスト入力タスク要求が分析されます。
名前 | 型 | 説明 |
---|---|---|
analysisInput |
分析する入力。 |
|
kind |
string:
Entity |
実行するタスクの種類。 |
parameters |
タスク パラメーター。 |
AnalyzeTextKeyPhraseExtractionInput
分析テキスト KeyPhraseExtraction タスク入力が含まれます。
名前 | 型 | 説明 |
---|---|---|
analysisInput |
入力ドキュメントを格納します。 |
|
kind |
string:
Key |
実行するタスクの種類。 |
parameters |
キー フレーズ抽出タスク パラメーター。 |
AnalyzeTextLanguageDetectionInput
言語検出ドキュメント分析タスクの入力が含まれます。
名前 | 型 | 説明 |
---|---|---|
analysisInput |
分析するドキュメント。 |
|
kind |
string:
Language |
実行するタスクの種類。 |
parameters |
タスク パラメーター。 |
AnalyzeTextPiiEntitiesRecognitionInput
分析テキスト PIIEntityRecognition タスク入力が含まれます。
名前 | 型 | 説明 |
---|---|---|
analysisInput |
入力ドキュメントを格納します。 |
|
kind |
string:
Pii |
実行するタスクの種類。 |
parameters |
Pii タスク パラメーター。 |
AnalyzeTextSentimentAnalysisInput
SentimentAnalysis タスク入力の分析テキストが含まれます。
名前 | 型 | 説明 |
---|---|---|
analysisInput |
入力ドキュメントを格納します。 |
|
kind |
string:
Sentiment |
実行するタスクの種類。 |
parameters |
感情分析タスク パラメーター。 |
AnalyzeTextTaskKind
サポートされている分析テキスト タスクの種類。
名前 | 型 | 説明 |
---|---|---|
EntityLinking |
string |
エンティティ リンク タスク |
EntityRecognition |
string |
エンティティ認識タスク |
KeyPhraseExtraction |
string |
キー フレーズ抽出タスク |
LanguageDetection |
string |
言語検出タスク |
PiiEntityRecognition |
string |
PII エンティティ認識タスク |
SentimentAnalysis |
string |
感情分析タスク |
AnalyzeTextTaskResultsKind
テキスト分析タスクによって返される応答オブジェクトの種類。
名前 | 型 | 説明 |
---|---|---|
EntityLinkingResults |
string |
エンティティ リンクの結果 |
EntityRecognitionResults |
string |
エンティティ認識の結果 |
KeyPhraseExtractionResults |
string |
キー フレーズ抽出の結果 |
LanguageDetectionResults |
string |
言語検出の結果 |
PiiEntityRecognitionResults |
string |
PII エンティティ認識の結果 |
SentimentAnalysisResults |
string |
感情分析の結果 |
DetectedLanguage
テキストに対して検出された言語の詳細が含まれます。
名前 | 型 | 説明 |
---|---|---|
confidenceScore |
number |
0 から 1 の信頼度スコア。 1 に近いスコアは、100% の確実性で正しい言語が特定されたことを示します。 |
iso6391Name |
string |
ISO 639-1 標準 (en、fr など) に従って検出された言語の 2 文字の表現。 |
name |
string |
検出された言語の長い名前 (英語、フランス語など)。 |
DocumentError
ジョブの実行中に発生したエラーの詳細が含まれます。
名前 | 型 | 説明 |
---|---|---|
error |
エラーが発生しました。 |
|
id |
string |
入力ドキュメントの ID。 |
DocumentSentimentValue
ドキュメントの予測センチメント (Negative、Neutral、Positive、または Mixed)。
名前 | 型 | 説明 |
---|---|---|
mixed |
string |
Mixed ステートメント |
negative |
string |
負のステートメント |
neutral |
string |
Neutral ステートメント |
positive |
string |
正のステートメント |
DocumentStatistics
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。
名前 | 型 | 説明 |
---|---|---|
charactersCount |
integer |
ドキュメントで認識されるテキスト要素の数。 |
transactionsCount |
integer |
ドキュメントのトランザクションの数。 |
DocumentWarning
処理されたドキュメントに対して発生した警告を含む warnings オブジェクトが含まれます。
名前 | 型 | 説明 |
---|---|---|
code |
警告コード。 |
|
message |
string |
警告メッセージ。 |
targetRef |
string |
ターゲット オブジェクトを示す JSON ポインター参照。 |
EntitiesDocumentResult
ドキュメントのエンティティ認識タスクの結果を格納します。
名前 | 型 | 説明 |
---|---|---|
entities |
Entity[] |
ドキュメント内で認識されたエンティティ。 |
id |
string |
一意の空でないドキュメント識別子。 |
statistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
warnings |
ドキュメントの処理中に発生した警告。 |
EntitiesResult
エンティティ認識タスクの結果を格納します。
名前 | 型 | 説明 |
---|---|---|
documents |
ドキュメント別の応答 |
|
errors |
ドキュメント ID 別のエラー。 |
|
modelVersion |
string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
EntitiesTaskParameters
エンティティ認識タスクでサポートされているパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
loggingOptOut |
boolean |
False |
オプトアウトのログ記録 |
modelVersion |
string |
latest |
モデル バージョン |
stringIndexType | TextElements_v8 |
(省略可能) 文字列オフセットの解釈に使用される文字列インデックス型を指定するパラメーター。 既定値は TextElements (Graphemes) です。 |
EntitiesTaskResult
エンティティ タスクを含む
名前 | 型 | 説明 |
---|---|---|
kind |
string:
Entity |
タスクの結果の種類。 |
results |
エンティティ認識の結果。 |
Entity
検出されたエンティティ カテゴリや検出されたエンティティ テキストなどを含む、検出されたエンティティ オブジェクトを定義します。
名前 | 型 | 説明 |
---|---|---|
category |
string |
エンティティの種類。 |
confidenceScore |
number |
抽出されたエンティティの 0 から 1 の信頼度スコア。 |
length |
integer |
エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響を与える可能性があります。 |
offset |
integer |
エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響を与える可能性があります。 |
subcategory |
string |
(省略可能)エンティティ のサブタイプ。 |
text |
string |
要求に表示されるエンティティ テキスト。 |
EntityLinkingResult
エンティティ リンクの結果。
名前 | 型 | 説明 |
---|---|---|
documents |
ドキュメント別の応答 |
|
errors |
ドキュメント ID 別のエラー。 |
|
modelVersion |
string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
EntityLinkingTaskParameters
エンティティ リンク タスクでサポートされているパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
loggingOptOut |
boolean |
False |
オプトアウトのログ記録 |
modelVersion |
string |
latest |
モデル バージョン |
stringIndexType | TextElements_v8 |
文字列オフセットの解釈に使用される文字列インデックス型を指定する省略可能なパラメーター。 既定値は TextElements (Graphemes) です。 |
EntityLinkingTaskResult
分析テキストエンティティ リンク タスクの結果が含まれます。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
Entity |
タスクの結果の種類。 |
results |
エンティティ リンクの結果。 |
Error
要求の処理中にサービスでエラーが発生したときに返されるエラー応答オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
ErrorCode
人間が判読できるエラー コード。
名前 | 型 | 説明 |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
Azure Cognitive Searchインデックスの制限に達しましたエラー |
AzureCognitiveSearchIndexNotFound |
string |
Azure Cognitive Search インデックスが見つかりませんエラー |
AzureCognitiveSearchNotFound |
string |
Azure Cognitive Search見つかりませんエラー |
AzureCognitiveSearchThrottling |
string |
Azure Cognitive Search調整エラー |
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 オブジェクト。 |
InnerErrorCode
人間が判読できるエラー コード。
名前 | 型 | 説明 |
---|---|---|
AzureCognitiveSearchNotFound |
string |
Azure Cognitive Search見つかりませんエラー |
AzureCognitiveSearchThrottling |
string |
Azure Cognitive Search調整エラー |
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 |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
object |
エラーの詳細。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラー ターゲット。 |
KeyPhraseResult
KeyPhraseResult を格納します。
名前 | 型 | 説明 |
---|---|---|
documents |
ドキュメント別の応答 |
|
errors |
ドキュメント ID 別のエラー。 |
|
modelVersion |
string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
KeyPhrasesDocumentResult
ドキュメントのキー フレーズ抽出結果が含まれます。
名前 | 型 | 説明 |
---|---|---|
id |
string |
一意の空でないドキュメント識別子。 |
keyPhrases |
string[] |
代表的な単語または語句の一覧。 返されるキー フレーズの数は、入力ドキュメント内の単語数に比例します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
warnings |
ドキュメントの処理中に発生した警告。 |
KeyPhraseTaskParameters
キー フレーズ抽出タスクでサポートされているパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
loggingOptOut |
boolean |
False |
オプトアウトのログ記録 |
modelVersion |
string |
latest |
モデル バージョン |
KeyPhraseTaskResult
分析テキスト KeyPhraseExtraction タスクの結果を格納します。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
Key |
タスクの結果の種類。 |
results |
キー フレーズ抽出結果の一覧 |
LanguageDetectionAnalysisInput
言語検出ドキュメント分析入力が含まれます。
名前 | 型 | 説明 |
---|---|---|
documents |
分析するドキュメントの一覧。 |
LanguageDetectionDocumentResult
ドキュメントの言語検出を含みます。
名前 | 型 | 説明 |
---|---|---|
detectedLanguage |
検出された言語。 |
|
id |
string |
一意の空でないドキュメント識別子。 |
statistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
warnings |
ドキュメントの処理中に発生した警告。 |
LanguageDetectionResult
要求の言語検出結果が含まれます。
名前 | 型 | 説明 |
---|---|---|
documents |
各入力ドキュメントの言語検出結果の列挙。 |
|
errors |
ドキュメント ID 別のエラー。 |
|
modelVersion |
string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
LanguageDetectionTaskParameters
言語検出タスクでサポートされているパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
loggingOptOut |
boolean |
False |
オプトアウトのログ記録 |
modelVersion |
string |
latest |
モデル バージョン |
LanguageDetectionTaskResult
要求の言語検出タスクの結果が含まれます。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
Language |
タスクの結果の種類。 |
results |
言語検出結果が含まれます。 |
LanguageInput
言語検出入力が含まれます。
名前 | 型 | 説明 |
---|---|---|
countryHint |
string |
テキストの言語検出に役立つ国ヒント。 |
id |
string |
空でない一意のドキュメント識別子。 |
text |
string |
処理する入力テキスト。 |
LinkedEntitiesDocumentResult
ドキュメントの結果をリンクするエンティティ。
名前 | 型 | 説明 |
---|---|---|
entities |
ドキュメント内の既知のエンティティが認識されました。 |
|
id |
string |
一意の空でないドキュメント識別子。 |
statistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
warnings |
ドキュメントの処理中に発生した警告。 |
LinkedEntity
関連付けられたソース/リンクを持つ検出されたエンティティを含む LinkedEntity オブジェクト。
名前 | 型 | 説明 |
---|---|---|
bingId |
string |
認識されたエンティティの Entity Search API の一意識別子をBingします。 |
dataSource |
string |
Wiki/Bing などのエンティティ リンクを抽出するために使用されるデータ ソース。 |
id |
string |
データ ソースから認識されたエンティティの一意識別子。 |
language |
string |
データ ソースで使用される言語。 |
matches |
Match[] |
このエンティティがテキストに表示されるインスタンスの一覧。 |
name |
string |
エンティティ リンクの正式な名前。 |
url |
string |
データ ソースからのエンティティのページの URL。 |
Match
オフセットと長さを持つ検出されたエンティティ テキストを含む Match オブジェクト。
名前 | 型 | 説明 |
---|---|---|
confidenceScore |
number |
既知の項目が認識された場合は、0 から 1 の信頼度レベルを示す 10 進数が返されます。 |
length |
integer |
エンティティの一致テキストの長さ。 |
offset |
integer |
エンティティ一致テキストの開始位置。 |
text |
string |
要求に表示されるエンティティ テキスト。 |
MultiLanguageAnalysisInput
サービスによって分析される入力ドキュメントのコレクション。
名前 | 型 | 説明 |
---|---|---|
documents |
分析する入力ドキュメント。 |
MultiLanguageInput
サービスによって分析される入力ドキュメントが含まれます。
名前 | 型 | 説明 |
---|---|---|
id |
string |
空でない一意のドキュメント識別子。 |
language |
string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定されていない場合は、既定で英語に "en" を使用します。 (以下は 2023-04-15-preview 以上にのみ適用されます)自動言語検出の場合は、"auto" を使用します。 設定されていない場合は、既定で英語に "en" を使用します。 |
text |
string |
処理する入力テキスト。 |
PiiCategory
(省略可能) 返す PII カテゴリについて説明します
名前 | 型 | 説明 |
---|---|---|
ABARoutingNumber |
string |
ABA ルーティング番号 |
ARNationalIdentityNumber |
string |
AR National Identity Number |
ATIdentityCard |
string |
AT ID カード |
ATTaxIdentificationNumber |
string |
AT 税識別番号 |
ATValueAddedTaxNumber |
string |
AT 付加価値税番号 |
AUBankAccountNumber |
string |
AT ID カード |
AUBusinessNumber |
string |
AU のビジネス番号 |
AUCompanyNumber |
string |
AU 会社番号 |
AUDriversLicenseNumber |
string |
AU 運転免許証番号 |
AUMedicalAccountNumber |
string |
AU 医療口座番号 |
AUPassportNumber |
string |
AU パスポート番号 |
AUTaxFileNumber |
string |
AU 税ファイル番号 |
Address |
string |
Address |
Age |
string |
Age |
All |
string |
すべての PII カテゴリ。 |
AzureDocumentDBAuthKey |
string |
Azure Document DB 認証キー |
AzureIAASDatabaseConnectionAndSQLString |
string |
Azure IAAS データベース接続と SQL 文字列 |
AzureIoTConnectionString |
string |
Azure IoT 接続文字列 |
AzurePublishSettingPassword |
string |
Azure 発行設定パスワード |
AzureRedisCacheString |
string |
Azure Redis Cache 文字列 |
AzureSAS |
string |
Azure SAS |
AzureServiceBusString |
string |
Azure Service Bus文字列 |
AzureStorageAccountGeneric |
string |
Azure Storage アカウントの汎用 |
AzureStorageAccountKey |
string |
Azure Storage アカウント キー |
BENationalNumber |
string |
BE National Number |
BENationalNumberV2 |
string |
BE National Number V2 |
BEValueAddedTaxNumber |
string |
BE 付加価値税番号 |
BGUniformCivilNumber |
string |
BG Uniform Civil Number |
BRCPFNumber |
string |
BR CPF 番号 |
BRLegalEntityNumber |
string |
BR 法人番号 |
BRNationalIDRG |
string |
BR National ID RG |
CABankAccountNumber |
string |
CA 銀行口座番号 |
CADriversLicenseNumber |
string |
CA Driver's License Number |
CAHealthServiceNumber |
string |
CA 正常性サービス番号 |
CAPassportNumber |
string |
CA パスポート番号 |
CAPersonalHealthIdentification |
string |
CA の個人の正常性の識別 |
CASocialInsuranceNumber |
string |
CA 社会保険番号 |
CHSocialSecurityNumber |
string |
CH 社会保障番号 |
CLIdentityCardNumber |
string |
CL ID カード番号 |
CNResidentIdentityCardNumber |
string |
CN 常駐 ID カード番号 |
CYIdentityCard |
string |
CY ID カード |
CYTaxIdentificationNumber |
string |
CY 税識別番号 |
CZPersonalIdentityNumber |
string |
CZ 個人 ID 番号 |
CZPersonalIdentityV2 |
string |
CZ Personal Identity V2 |
CreditCardNumber |
string |
クレジット カード番号 |
DEDriversLicenseNumber |
string |
DE Driver's License Number |
DEIdentityCardNumber |
string |
DE ID カード番号 |
DEPassportNumber |
string |
DE パスポート番号 |
DETaxIdentificationNumber |
string |
DE 税識別番号 |
DEValueAddedNumber |
string |
DE 値の加算番号 |
DKPersonalIdentificationNumber |
string |
DK 個人識別番号 |
DKPersonalIdentificationV2 |
string |
DK 個人識別 V2 |
Date |
string |
Date |
Default |
string |
言語の既定の PII カテゴリ。 |
DrugEnforcementAgencyNumber |
string |
薬物執行機関番号 |
EEPersonalIdentificationCode |
string |
EE 個人識別コード |
ESDNI |
string |
ES DNI |
ESSocialSecurityNumber |
string |
ES 社会保障番号 |
ESTaxIdentificationNumber |
string |
ES 税識別番号 |
EUDebitCardNumber |
string |
EU デビット カード番号 |
EUDriversLicenseNumber |
string |
EU の運転免許証番号 |
EUGPSCoordinates |
string |
EU の GPS 座標 |
EUNationalIdentificationNumber |
string |
EU の国民識別番号 |
EUPassportNumber |
string |
EU のパスポート番号 |
EUSocialSecurityNumber |
string |
EU 社会保障番号 |
EUTaxIdentificationNumber |
string |
EU の税識別番号 |
string |
電子メール |
|
FIEuropeanHealthNumber |
string |
FI ヨーロッパヘルス番号 |
FINationalID |
string |
FI National ID |
FINationalIDV2 |
string |
FI National ID V2 |
FIPassportNumber |
string |
FI パスポート番号 |
FRDriversLicenseNumber |
string |
FR 運転免許証番号 |
FRHealthInsuranceNumber |
string |
FR 健康保険番号 |
FRNationalID |
string |
FR National ID |
FRPassportNumber |
string |
FR パスポート番号 |
FRSocialSecurityNumber |
string |
FR 社会保障番号 |
FRTaxIdentificationNumber |
string |
FR 税識別番号 |
FRValueAddedTaxNumber |
string |
FR 付加価値税番号 |
GRNationalIDCard |
string |
GR 国民 ID カード |
GRNationalIDV2 |
string |
GR National ID V2 |
GRTaxIdentificationNumber |
string |
GR 税識別番号 |
HKIdentityCardNumber |
string |
HK ID カード番号 |
HRIdentityCardNumber |
string |
HR ID カード番号 |
HRNationalIDNumber |
string |
HR National ID Number |
HRPersonalIdentificationNumber |
string |
HR 個人識別番号 |
HRPersonalIdentificationOIBNumberV2 |
string |
HR 個人識別 OIB 番号 V2 |
HUPersonalIdentificationNumber |
string |
HU 個人識別番号 |
HUTaxIdentificationNumber |
string |
HU 税識別番号 |
HUValueAddedNumber |
string |
HU 値の加算番号 |
IDIdentityCardNumber |
string |
ID ID カード番号 |
IEPersonalPublicServiceNumber |
string |
IE 個人用パブリック サービス番号 |
IEPersonalPublicServiceNumberV2 |
string |
IE 個人用パブリック サービス番号 V2 |
ILBankAccountNumber |
string |
IL 銀行口座番号 |
ILNationalID |
string |
IL National ID |
INPermanentAccount |
string |
IN Permanent Account |
INUniqueIdentificationNumber |
string |
IN 一意の識別番号 |
IPAddress |
string |
IP アドレス |
ITDriversLicenseNumber |
string |
IT Driver's License Number |
ITFiscalCode |
string |
IT 会計コード |
ITValueAddedTaxNumber |
string |
IT 付加価値税番号 |
InternationalBankingAccountNumber |
string |
International Banking Account Number |
JPBankAccountNumber |
string |
JP銀行口座番号 |
JPDriversLicenseNumber |
string |
JP運転免許証番号 |
JPMyNumberCorporate |
string |
JP マイナンバー企業 |
JPMyNumberPersonal |
string |
JP マイナンバー個人用 |
JPPassportNumber |
string |
JPパスポート番号 |
JPResidenceCardNumber |
string |
JP在留カード番号 |
JPResidentRegistrationNumber |
string |
JP住民登録番号 |
JPSocialInsuranceNumber |
string |
JP社会保険番号 |
KRResidentRegistrationNumber |
string |
KR住民登録番号 |
LTPersonalCode |
string |
LT 個人用コード |
LUNationalIdentificationNumberNatural |
string |
LU 国民識別番号 自然 |
LUNationalIdentificationNumberNonNatural |
string |
LU 国民識別番号 非自然 |
LVPersonalCode |
string |
LV 個人用コード |
MTIdentityCardNumber |
string |
MT ID カード番号 |
MTTaxIDNumber |
string |
MT 税 ID 番号 |
MYIdentityCardNumber |
string |
マイ ID カード番号 |
NLCitizensServiceNumber |
string |
NL 市民サービス番号 |
NLCitizensServiceNumberV2 |
string |
NL 市民サービス番号 V2 |
NLTaxIdentificationNumber |
string |
NL 税識別番号 |
NLValueAddedTaxNumber |
string |
NL 値の追加税番号 |
NOIdentityNumber |
string |
ID 番号なし |
NZBankAccountNumber |
string |
NZ 銀行口座番号 |
NZDriversLicenseNumber |
string |
NZ 運転免許証番号 |
NZInlandRevenueNumber |
string |
NZ 内陸収益番号 |
NZMinistryOfHealthNumber |
string |
NZ 保健省番号 |
NZSocialWelfareNumber |
string |
NZソーシャル福祉番号 |
Organization |
string |
組織 |
PHUnifiedMultiPurposeIDNumber |
string |
PH Unified Multi Purpose ID Number |
PLIdentityCard |
string |
PL ID カード |
PLNationalID |
string |
PL National ID |
PLNationalIDV2 |
string |
PL National ID V2 |
PLPassportNumber |
string |
PLパスポート番号 |
PLREGONNumber |
string |
PL REGON 番号 |
PLTaxIdentificationNumber |
string |
PL 税識別番号 |
PTCitizenCardNumber |
string |
PT 市民カード番号 |
PTCitizenCardNumberV2 |
string |
PT 市民カード番号 V2 |
PTTaxIdentificationNumber |
string |
PT 税識別番号 |
Person |
string |
Person |
PhoneNumber |
string |
電話番号 |
ROPersonalNumericalCode |
string |
RO 個人数値コード |
RUPassportNumberDomestic |
string |
RU パスポート番号 国内 |
RUPassportNumberInternational |
string |
RU Passport Number International |
SANationalID |
string |
SA National ID |
SENationalID |
string |
SE National ID |
SENationalIDV2 |
string |
SE National ID V2 |
SEPassportNumber |
string |
SE パスポート番号 |
SETaxIdentificationNumber |
string |
SE 税識別番号 |
SGNationalRegistrationIdentityCardNumber |
string |
SG 国内登録 ID カード番号 |
SITaxIdentificationNumber |
string |
SI 税識別番号 |
SIUniqueMasterCitizenNumber |
string |
SI 固有マスター市民番号 |
SKPersonalNumber |
string |
SK 個人番号 |
SQLServerConnectionString |
string |
SQL Server 接続文字列 |
SWIFTCode |
string |
SWIFT コード |
THPopulationIdentificationCode |
string |
TH 母集団識別コード |
TRNationalIdentificationNumber |
string |
TR 国民識別番号 |
TWNationalID |
string |
TW National ID |
TWPassportNumber |
string |
TW パスポート番号 |
TWResidentCertificate |
string |
TW 常駐証明書 |
UAPassportNumberDomestic |
string |
UAパスポート番号国内 |
UAPassportNumberInternational |
string |
UA パスポート番号 インターナショナル |
UKDriversLicenseNumber |
string |
英国の運転免許証番号 |
UKElectoralRollNumber |
string |
英国の選挙ロール番号 |
UKNationalHealthNumber |
string |
英国の国民健康番号 |
UKNationalInsuranceNumber |
string |
英国国民保険番号 |
UKUniqueTaxpayerNumber |
string |
英国の一意の納税者番号 |
URL |
string |
URL |
USBankAccountNumber |
string |
米国の銀行口座番号 |
USDriversLicenseNumber |
string |
米国の運転免許証番号 |
USIndividualTaxpayerIdentification |
string |
米国の個人納税者識別 |
USSocialSecurityNumber |
string |
米国社会保障番号 |
USUKPassportNumber |
string |
米国の英国のパスポート番号 |
ZAIdentificationNumber |
string |
ZA 識別番号 |
PiiDomain
PII タスクのドメイン
名前 | 型 | 説明 |
---|---|---|
none |
string |
ドメインが指定されていないことを示します。 |
phi |
string |
Personal Health Information ドメイン内のエンティティを編集する必要があることを示します。 |
PiiEntitiesDocumentResult
PII の結果が含まれます。
名前 | 型 | 説明 |
---|---|---|
entities |
Entity[] |
ドキュメント内で認識されたエンティティ。 |
id |
string |
一意の空でないドキュメント識別子。 |
redactedText |
string |
編集されたテキストを返します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
warnings |
ドキュメントの処理中に発生した警告。 |
PiiResult
PiiResult を格納します。
名前 | 型 | 説明 |
---|---|---|
documents |
ドキュメント別の応答 |
|
errors |
ドキュメント ID 別のエラー。 |
|
modelVersion |
string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
PiiTaskParameters
PII エンティティ認識タスクでサポートされているパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
domain | none |
PII タスクのドメイン |
|
loggingOptOut |
boolean |
False |
オプトアウトのログ記録 |
modelVersion |
string |
latest |
モデル バージョン |
piiCategories |
応答で返される PII カテゴリの列挙。 |
||
stringIndexType | TextElements_v8 |
分析に使用する StringIndexType。 |
PiiTaskResult
分析テキスト PIIEntityRecognition LRO タスクを含みます。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
Pii |
タスクの結果の種類。 |
results |
pii の結果の一覧 |
RequestStatistics
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。
名前 | 型 | 説明 |
---|---|---|
documentsCount |
integer |
要求で送信されたドキュメントの数。 |
erroneousDocumentsCount |
integer |
無効なドキュメントの数。 これには、空の、サイズ超過の制限、またはサポートされていない言語のドキュメントが含まれます。 |
transactionsCount |
integer |
要求のトランザクションの数。 |
validDocumentsCount |
integer |
有効なドキュメントの数。 空の、サイズ超過の制限、またはサポートされていない言語のドキュメントは除外されます。 |
SentenceAssessment
文の評価と、それに関連する評価またはターゲット オブジェクトを表します。
名前 | 型 | 説明 |
---|---|---|
confidenceScores |
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。 |
|
isNegated |
boolean |
評価が否定されるかどうかを表すインジケーター。 |
length |
integer |
ターゲットの長さ。 |
offset |
integer |
文の先頭からのターゲット オフセット。 |
sentiment |
文のセンチメント。 |
|
text |
string |
ターゲット テキストが検出されました。 |
SentenceSentiment
ドキュメントの文のセンチメント。
名前 | 型 | 説明 |
---|---|---|
assessments |
文の評価の配列。 |
|
confidenceScores |
すべてのクラスの文に対する 0 から 1 のセンチメント信頼度スコア。 |
|
length |
integer |
ターゲットの長さ。 |
offset |
integer |
文の先頭からのターゲット オフセット。 |
sentiment |
文の予測センチメント。 |
|
targets |
文の対象となる文の配列。 |
|
text |
string |
文のテキスト。 |
SentenceSentimentValue
文の予測センチメント。
名前 | 型 | 説明 |
---|---|---|
negative |
string |
否定的なセンチメント |
neutral |
string |
ニュートラル センチメント |
positive |
string |
肯定的なセンチメント |
SentenceTarget
文のターゲットと、それに関連する評価またはターゲット オブジェクトを表します。
名前 | 型 | 説明 |
---|---|---|
confidenceScores |
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。 |
|
length |
integer |
ターゲットの長さ。 |
offset |
integer |
文の先頭からのターゲット オフセット。 |
relations |
ターゲットに関連する評価オブジェクトまたはターゲット オブジェクトの配列。 |
|
sentiment |
文のセンチメント。 |
|
text |
string |
ターゲット テキストが検出されました。 |
SentimentAnalysisTaskParameters
感情分析タスクでサポートされているパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
loggingOptOut |
boolean |
False |
オプトアウトのログ記録 |
modelVersion |
string |
latest |
モデル バージョン |
opinionMining |
boolean |
False |
要求でオピニオン マイニングを使用するかどうか。 |
stringIndexType | TextElements_v8 |
文字列オフセットの解釈に使用するメソッドを指定します。 |
SentimentConfidenceScores
すべてのセンチメント クラスで 0 から 1 の信頼度スコア (正、中立、負) を表します。
名前 | 型 | 説明 |
---|---|---|
negative |
number |
否定的なセンチメントの信頼度スコア |
neutral |
number |
ニュートラル センチメントの信頼度スコア |
positive |
number |
肯定的なセンチメントの信頼度スコア |
SentimentDocumentResult
各ドキュメントの事前構築済みの感情分析結果を表す オブジェクト。
名前 | 型 | 説明 |
---|---|---|
confidenceScores |
すべてのクラスの文に対する 0 から 1 のセンチメント信頼度スコア。 |
|
id |
string |
一意の空でないドキュメント識別子。 |
sentences |
ドキュメントの文のセンチメント。 |
|
sentiment |
ドキュメントの予測センチメント (Negative、Neutral、Positive、または Mixed)。 |
|
statistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
warnings |
ドキュメントの処理中に発生した警告。 |
SentimentResponse
入力ドキュメントの感情分析結果。
名前 | 型 | 説明 |
---|---|---|
documents |
入力内の各ドキュメントのセンチメント分析結果。 |
|
errors |
ドキュメント ID 別のエラー。 |
|
modelVersion |
string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
statistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
SentimentTaskResult
分析テキスト SentimentAnalysis LRO タスクの結果が含まれます。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
Sentiment |
タスクの結果の種類。 |
results |
センチメント分析の結果 |
StringIndexType
文字列インデックスの種類
名前 | 型 | 説明 |
---|---|---|
TextElements_v8 |
string |
返されるオフセットと長さの値は、Unicode 8.0.0 標準を確認する TextElements (Graphemes および Grapheme クラスター) に対応します。 アプリケーションが .Net Framework または.Net Coreで記述されていて、StringInfo を使用する場合は、このオプションを使用します。 |
UnicodeCodePoint |
string |
返されるオフセットと長さの値は、Unicode コード ポイントに対応します。 アプリケーションが Unicode (Python など) をサポートする言語で記述されている場合は、このオプションを使用します。 |
Utf16CodeUnit |
string |
返されるオフセットと長さの値は、UTF-16 コード単位に対応します。 アプリケーションが Unicode (Java、JavaScript など) をサポートする言語で記述されている場合は、このオプションを使用します。 |
TargetConfidenceScoreLabel
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。
名前 | 型 | 説明 |
---|---|---|
negative |
number |
否定的なセンチメントの信頼度スコア |
positive |
number |
肯定的なセンチメントの信頼度スコア |
TargetRelation
評価とターゲットの間の関係を表します。
名前 | 型 | 説明 |
---|---|---|
ref |
string |
リンクされたオブジェクトを示す JSON ポインター。 |
relationType |
ターゲットに関連する型。 |
TargetRelationType
ターゲットに関連する型。
名前 | 型 | 説明 |
---|---|---|
assessment |
string |
評価の関係。 |
target |
string |
ターゲット関係。 |
TokenSentimentValue
文の予測センチメント。
名前 | 型 | 説明 |
---|---|---|
mixed |
string |
混合センチメント |
negative |
string |
否定的なセンチメント |
positive |
string |
肯定的なセンチメント |
WarningCodeValue
警告コードの一覧を定義します。
名前 | 型 | 説明 |
---|---|---|
DocumentTruncated |
string |
ドキュメントの切り捨て警告 |
LongWordsInDocument |
string |
ドキュメント内の長い単語の警告 |