Text Analysis Runtime - Analyze Text

ドキュメントのコレクションに対してテキスト分析を要求します。

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

URI パラメーター

名前 / 必須 説明
Endpoint
path True

string

サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).

api-version
query True

string

この操作に使用する API バージョン。

showStats
query

boolean

(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。

要求本文

要求本文は、次のいずれかの可能性があります。

名前 説明
AnalyzeTextEntityLinkingInput

分析テキストエンティティ リンク入力を含みます。

AnalyzeTextEntityRecognitionInput

エンティティ認識は、テキスト入力タスク要求を分析します。

AnalyzeTextKeyPhraseExtractionInput

分析テキスト KeyPhraseExtraction タスク入力を格納します。

AnalyzeTextLanguageDetectionInput

言語検出ドキュメント分析タスクの入力を含みます。

AnalyzeTextPiiEntitiesRecognitionInput

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

AnalyzeTextSentimentAnalysisInput

SentimentAnalysis タスク入力の分析テキストが含まれています。

AnalyzeTextEntityLinkingInput

分析テキストエンティティ リンク入力を含みます。

名前 必須 説明
kind True string:

EntityLinking

実行するタスクの種類。

analysisInput

MultiLanguageAnalysisInput

サービスによって処理される分析入力が含まれます。

parameters

EntityLinkingTaskParameters

タスク パラメーター。

AnalyzeTextEntityRecognitionInput

エンティティ認識は、テキスト入力タスク要求を分析します。

名前 必須 説明
kind True string:

EntityRecognition

実行するタスクの種類。

analysisInput

MultiLanguageAnalysisInput

分析する入力。

parameters

EntitiesTaskParameters

タスク パラメーター。

AnalyzeTextKeyPhraseExtractionInput

分析テキスト KeyPhraseExtraction タスク入力を格納します。

名前 必須 説明
kind True string:

KeyPhraseExtraction

実行するタスクの種類。

analysisInput

MultiLanguageAnalysisInput

入力ドキュメントを格納します。

parameters

KeyPhraseTaskParameters

キー フレーズ抽出タスクのパラメーター。

AnalyzeTextLanguageDetectionInput

言語検出ドキュメント分析タスクの入力を含みます。

名前 必須 説明
kind True string:

LanguageDetection

実行するタスクの種類。

analysisInput

LanguageDetectionAnalysisInput

分析するドキュメント。

parameters

LanguageDetectionTaskParameters

タスク パラメーター。

AnalyzeTextPiiEntitiesRecognitionInput

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

名前 必須 説明
kind True string:

PiiEntityRecognition

実行するタスクの種類。

analysisInput

MultiLanguageAnalysisInput

入力ドキュメントを格納します。

parameters

PiiTaskParameters

Pii タスク パラメーター。

AnalyzeTextSentimentAnalysisInput

SentimentAnalysis タスク入力の分析テキストが含まれています。

名前 必須 説明
kind True string:

SentimentAnalysis

実行するタスクの種類。

analysisInput

MultiLanguageAnalysisInput

入力ドキュメントを格納します。

parameters

SentimentAnalysisTaskParameters

感情分析タスクのパラメーター。

応答

名前 説明
200 OK AnalyzeTextTaskResult:

要求は成功しました。

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

SuccessfulEntityLinkingRequest
SuccessfulEntityRecognitionExclusionRequest
SuccessfulEntityRecognitionInclusionRequest
SuccessfulEntityRecognitionInferenceOptionsRequest
SuccessfulEntityRecognitionOverlapPolicy
SuccessfulEntityRecognitionRequest
SuccessfulKeyPhraseExtractionRequest
SuccessfulLanguageDetectionRequest
SuccessfulPiiEntityRecognitionRequest
SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

要求のサンプル

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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"
  }
}

SuccessfulEntityRecognitionExclusionRequest

要求のサンプル

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

応答のサンプル

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

要求のサンプル

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

応答のサンプル

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

要求のサンプル

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

応答のサンプル

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

要求のサンプル

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

応答のサンプル

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

要求のサンプル

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

応答のサンプル

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

要求のサンプル

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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=2024-11-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",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-12-01"
  }
}

SuccessfulPiiEntityRecognitionRequest

要求のサンプル

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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=2024-11-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"
  }
}

定義

名前 説明
AgeMetadata

Age エンティティ メタデータ モデルを表します。

AgeUnit

測定の年齢単位

AllowOverlapEntityPolicyType

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

AnalyzeTextEntityLinkingInput

分析テキストエンティティ リンク入力を含みます。

AnalyzeTextEntityRecognitionInput

エンティティ認識は、テキスト入力タスク要求を分析します。

AnalyzeTextKeyPhraseExtractionInput

分析テキスト KeyPhraseExtraction タスク入力を格納します。

AnalyzeTextLanguageDetectionInput

言語検出ドキュメント分析タスクの入力を含みます。

AnalyzeTextPiiEntitiesRecognitionInput

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

AnalyzeTextSentimentAnalysisInput

SentimentAnalysis タスク入力の分析テキストが含まれています。

AnalyzeTextTaskKind

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

AnalyzeTextTaskResultsKind

テキスト分析タスクによって返される応答オブジェクトの種類。

AreaMetadata

Area エンティティメタデータ モデルを表します。

AreaUnit

測定の面積単位。

CurrencyMetadata

Currency) エンティティ メタデータ モデルを表します。

DateMetadata

日付エンティティ インスタンスのメタデータ。

DateTimeMetadata

datetime エンティティ インスタンスのメタデータ。

DateValue

日付値を表します。

DetectedLanguage

テキストに対して検出された言語の詳細を格納します。

DocumentError

ジョブの実行中に発生したエラーの詳細が含まれます。

DocumentSentimentValue

ドキュメントの予測センチメント (負、中立、正、または混合)。

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

DocumentWarning

処理されたドキュメントに対して発生した警告を含む warnings オブジェクトを格納します。

EntitiesDocumentResultWithMetadata

エンティティ ドキュメントの結果とメタデータ。

EntitiesResult

エンティティ認識タスクの結果を格納します。

EntitiesTaskParameters

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

EntitiesTaskResult

エンティティ タスクを含む

Entity

検出されたエンティティ カテゴリや検出されたエンティティ テキストなどを含む、検出されたエンティティ オブジェクトを定義します。

EntityCategory

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

EntityInferenceOptions

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

EntityLinkingResult

エンティティ リンクの結果。

EntityLinkingTaskParameters

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

EntityLinkingTaskResult

分析テキストエンティティ リンク タスクの結果が含まれます。

EntityTag

関連付けられている信頼度スコアのタグ abd の名前を含むエンティティ タグ オブジェクト。 エンティティ タグは、エンティティ間のいくつかの類似点/アフィニティを表すために使用されます。

EntityWithMetadata

タグとメタデータを持つエンティティ オブジェクト。

Error

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

ErrorCode

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

ErrorResponse

エラー応答。

InformationMetadata

情報 (データ) エンティティ メタデータ モデルを表します。

InformationUnit

情報 (データ) 測定単位。

InnerErrorCode

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

InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

KeyPhraseResult

KeyPhraseResult を格納します。

KeyPhrasesDocumentResult

ドキュメントのキー フレーズ抽出結果を格納します。

KeyPhraseTaskParameters

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

KeyPhraseTaskResult

分析テキスト KeyPhraseExtraction タスクの結果を格納します。

LanguageDetectionAnalysisInput

言語検出ドキュメント分析入力が含まれます。

LanguageDetectionDocumentResult

ドキュメントの言語検出を含みます。

LanguageDetectionResult

要求の言語検出結果が含まれます。

LanguageDetectionTaskParameters

言語検出タスクでサポートされているパラメーター。

LanguageDetectionTaskResult

要求の言語検出タスクの結果が含まれます。

LanguageInput

言語検出入力が含まれます。

LengthMetadata

Length エンティティ メタデータ モデルを表します。

LengthUnit

測定の長さの単位。

LinkedEntitiesDocumentResult

ドキュメントの結果をリンクするエンティティ。

LinkedEntity

関連付けられたソース/リンクを持つ検出されたエンティティを含む LinkedEntity オブジェクト。

Match

オフセットと長さを持つ検出されたエンティティ テキストを含む Match オブジェクト。

MatchLongestEntityPolicyType

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

MetadataKind

エンティティ メタデータ オブジェクトの種類。

MultiLanguageAnalysisInput

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

MultiLanguageInput

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

NumberKind

抽出された数値エンティティの型。

NumberMetadata

数値エンティティ インスタンスのメタデータ。

NumericRangeMetadata

は、数値の間隔のメタデータを表します。

OrdinalMetadata

数値エンティティ インスタンスのメタデータ。

PiiCategory

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

PiiDomain

PII タスクのドメイン

PiiEntitiesDocumentResult

PII の結果を格納します。

PiiResult

PiiResult を格納します。

PiiTaskParameters

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

PiiTaskResult

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

RangeInclusivity

このプロパティの範囲の包括性。

RangeKind

数値範囲エンティティの種類。

RelativeTo

序数が示す参照ポイント。

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

ScriptCode

入力ドキュメントのスクリプトを識別します。 ISO 15924 標準スクリプト コードにマップされます。

ScriptKind

入力ドキュメントのスクリプトを識別します。 ISO 15924 標準正式名にマップされます。

SentenceAssessment

文の評価と、それに関連する評価またはターゲット オブジェクトを表します。

SentenceSentiment

ドキュメントの文のセンチメント。

SentenceSentimentValue

文の予測センチメント。

SentenceTarget

文のターゲットと、それに関連する評価またはターゲット オブジェクトを表します。

SentimentAnalysisTaskParameters

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

SentimentConfidenceScores

すべてのセンチメント クラス (正、中立、負) の 0 から 1 の信頼度スコアを表します。

SentimentDocumentResult

各ドキュメントの事前構築済みのセンチメント分析結果を表すオブジェクト。

SentimentResponse

入力ドキュメントの感情分析結果。

SentimentTaskResult

SentimentAnalysis LRO タスクの分析テキストが含まれています。

SpeedMetadata

Speed エンティティ メタデータ モデルを表します。

SpeedUnit

速度測定単位

StringIndexType

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

TargetConfidenceScoreLabel

すべてのセンチメント クラス (正と負) の信頼度スコアを表します。

TargetRelation

評価とターゲットの間の関係を表します。

TargetRelationType

ターゲットに関連する型。

TemperatureMetadata

Information エンティティメタデータ モデルを表します。

TemperatureUnit

温度測定単位。

TemporalModifier

日付/時刻インスタンスの省略可能な修飾子。

TemporalSetMetadata

テンポラル セット エンティティ インスタンスのメタデータ。

TemporalSpanMetadata

は、日付または期間のメタデータを表します。

TemporalSpanValues

テンポラル スパン オブジェクト。

TimeMetadata

時間エンティティ インスタンスのメタデータ。

TokenSentimentValue

文の予測センチメント。

VolumeMetadata

ボリューム エンティティ メタデータ モデルを表します。

VolumeUnit

測定単位のボリューム

WarningCodeValue

警告コードの一覧を定義します。

WeightMetadata

Weight) エンティティ メタデータ モデルを表します。

WeightUnit

測定単位の重み。

AgeMetadata

Age エンティティ メタデータ モデルを表します。

名前 説明
metadataKind string:

AgeMetadata

エンティティ メタデータ オブジェクトの種類。

unit

AgeUnit

年齢の測定単位。

value

number

抽出されたテキストが示す数値。

AgeUnit

測定の年齢単位

名前 説明
Day

string

1 日の期間

Month

string

1 か月の期間

Unspecified

string

指定されていない期間

Week

string

1 週間の期間

Year

string

1 年の期間

AllowOverlapEntityPolicyType

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

名前 規定値 説明
policyKind string:

allowOverlap

matchLongest

エンティティ OverlapPolicy オブジェクトの種類。

AnalyzeTextEntityLinkingInput

分析テキストエンティティ リンク入力を含みます。

名前 説明
analysisInput

MultiLanguageAnalysisInput

サービスによって処理される分析入力が含まれます。

kind string:

EntityLinking

実行するタスクの種類。

parameters

EntityLinkingTaskParameters

タスク パラメーター。

AnalyzeTextEntityRecognitionInput

エンティティ認識は、テキスト入力タスク要求を分析します。

名前 説明
analysisInput

MultiLanguageAnalysisInput

分析する入力。

kind string:

EntityRecognition

実行するタスクの種類。

parameters

EntitiesTaskParameters

タスク パラメーター。

AnalyzeTextKeyPhraseExtractionInput

分析テキスト KeyPhraseExtraction タスク入力を格納します。

名前 説明
analysisInput

MultiLanguageAnalysisInput

入力ドキュメントを格納します。

kind string:

KeyPhraseExtraction

実行するタスクの種類。

parameters

KeyPhraseTaskParameters

キー フレーズ抽出タスクのパラメーター。

AnalyzeTextLanguageDetectionInput

言語検出ドキュメント分析タスクの入力を含みます。

名前 説明
analysisInput

LanguageDetectionAnalysisInput

分析するドキュメント。

kind string:

LanguageDetection

実行するタスクの種類。

parameters

LanguageDetectionTaskParameters

タスク パラメーター。

AnalyzeTextPiiEntitiesRecognitionInput

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

名前 説明
analysisInput

MultiLanguageAnalysisInput

入力ドキュメントを格納します。

kind string:

PiiEntityRecognition

実行するタスクの種類。

parameters

PiiTaskParameters

Pii タスク パラメーター。

AnalyzeTextSentimentAnalysisInput

SentimentAnalysis タスク入力の分析テキストが含まれています。

名前 説明
analysisInput

MultiLanguageAnalysisInput

入力ドキュメントを格納します。

kind string:

SentimentAnalysis

実行するタスクの種類。

parameters

SentimentAnalysisTaskParameters

感情分析タスクのパラメーター。

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

感情分析の結果

AreaMetadata

Area エンティティメタデータ モデルを表します。

名前 説明
metadataKind string:

AreaMetadata

エンティティ メタデータ オブジェクトの種類。

unit

AreaUnit

面積の測定単位。

value

number

抽出されたテキストが示す数値。

AreaUnit

測定の面積単位。

名前 説明
Acre

string

面積単位 (エーカー単位)

SquareCentimeter

string

面積単位 (平方センチメートル)

SquareDecameter

string

四角いディケーターの面積単位

SquareDecimeter

string

平方デシメートルの面積単位

SquareFoot

string

平方フィート単位の面積単位

SquareHectometer

string

面積単位 (四角形のヘクトメーター)

SquareInch

string

面積単位 (平方インチ)

SquareKilometer

string

面積単位 (平方キロメートル)

SquareMeter

string

面積単位 (平方メートル)

SquareMile

string

面積単位 (平方マイル単位)

SquareMillimeter

string

面積単位 (平方ミリメートル)

SquareYard

string

面積単位 (平方ヤード)

Unspecified

string

未指定領域単位

CurrencyMetadata

Currency) エンティティ メタデータ モデルを表します。

名前 説明
iso4217

string

国名のコードを一覧表示する別の ISO 標準 ISO 3166 に基づくアルファベットコード。 ISO 4217 の 3 文字のコードの最初の 2 文字は国名のコードと同じであり、可能であれば、3 番目の文字は通貨名の最初の文字に対応します。

metadataKind string:

CurrencyMetadata

エンティティ メタデータ オブジェクトの種類。

unit

string

通貨単位。

value

number

抽出されたテキストが示す数値。

DateMetadata

日付エンティティ インスタンスのメタデータ。

名前 説明
dateValues

DateValue[]

日付値の一覧。

metadataKind string:

DateMetadata

エンティティ メタデータ オブジェクトの種類。

DateTimeMetadata

datetime エンティティ インスタンスのメタデータ。

名前 説明
dateValues

DateValue[]

日付値の一覧。

metadataKind string:

DateTimeMetadata

エンティティ メタデータ オブジェクトの種類。

DateValue

日付値を表します。

名前 説明
modifier

TemporalModifier

before、after などの参照ポイントを示す datetime の修飾子。

timex

string

(https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) で説明されている拡張 ISO 8601 日付/時刻表現

value

string

抽出されたテキストが示す実際の時刻。

DetectedLanguage

テキストに対して検出された言語の詳細を格納します。

名前 説明
confidenceScore

number

0 ~ 1 の信頼度スコア。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。

iso6391Name

string

ISO 639-1 標準 (en、fr など) に従って検出された言語の 2 文字の表現。

name

string

検出された言語の長い名前 (英語、フランス語など)。

scriptIso15924Code

ScriptCode

ISO 15924 標準に従って、入力ドキュメントのスクリプト コードを識別します。

scriptName

ScriptKind

ISO 15924 標準に従って、入力ドキュメントのスクリプト名を識別します。

DocumentError

ジョブの実行中に発生したエラーの詳細が含まれます。

名前 説明
error

Error

エラーが発生しました。

id

string

入力ドキュメントの ID。

DocumentSentimentValue

ドキュメントの予測センチメント (負、中立、正、または混合)。

名前 説明
mixed

string

Mixed ステートメント

negative

string

負のステートメント

neutral

string

Neutral ステートメント

positive

string

正のステートメント

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

名前 説明
charactersCount

integer

ドキュメントで認識されるテキスト要素の数。

transactionsCount

integer

ドキュメントのトランザクションの数。

DocumentWarning

処理されたドキュメントに対して発生した警告を含む warnings オブジェクトを格納します。

名前 説明
code

WarningCodeValue

警告コード。

message

string

警告メッセージ。

targetRef

string

ターゲット オブジェクトを示す JSON ポインター参照。

EntitiesDocumentResultWithMetadata

エンティティ ドキュメントの結果とメタデータ。

名前 説明
entities

EntityWithMetadata[]

ドキュメント内で認識されるエンティティ。

id

string

空でない一意のドキュメント識別子。

statistics

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

warnings

DocumentWarning[]

ドキュメントの処理中に発生した警告。

EntitiesResult

エンティティ認識タスクの結果を格納します。

名前 説明
documents

EntitiesDocumentResultWithMetadata[]

ドキュメント別の応答

errors

DocumentError[]

ドキュメント ID 別のエラー。

modelVersion

string

このフィールドは、スコアリングに使用されるモデルを示します。

statistics

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

EntitiesTaskParameters

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

名前 規定値 説明
exclusionList

EntityCategory[]

(省略可能) excludeList に含まれるエンティティを除外する要求パラメーター。 ユーザーが excludeList を指定すると、そのリスト内のエンティティで返される予測を取得できません。 exclusionList の前に inclusionList を適用します

inclusionList

EntityCategory[]

(省略可能) このリストに含まれる要求されたエンティティ型に出力を制限する要求パラメーター。 exclusionList の前に inclusionList を適用します

inferenceOptions

EntityInferenceOptions

(省略可能) 推論を実行するための設定をユーザーが指定できるようにする要求パラメーター。

loggingOptOut

boolean

False

オプトアウトのログ記録

modelVersion

string

latest

モデル バージョン

overlapPolicy BaseEntityOverlapPolicy:

(省略可能) ner 出力に適用するオーバーラップ ポリシーの種類を記述します。

stringIndexType

StringIndexType

TextElements_v8

(省略可能) 文字列オフセットの解釈に使用される文字列インデックス型を指定するパラメーター。 既定値は TextElements (Graphemes) です。

EntitiesTaskResult

エンティティ タスクを含む

名前 説明
kind string:

EntityRecognitionResults

タスクの結果の種類。

results

EntitiesResult

エンティティ認識の結果。

Entity

検出されたエンティティ カテゴリや検出されたエンティティ テキストなどを含む、検出されたエンティティ オブジェクトを定義します。

名前 説明
category

string

エンティティ型。

confidenceScore

number

抽出されたエンティティの 0 から 1 までの信頼度スコア。

length

integer

エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響する可能性があります。

offset

integer

エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響する可能性があります。

subcategory

string

(省略可能)エンティティのサブタイプ。

text

string

要求に表示されるエンティティ テキスト。

EntityCategory

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

名前 説明
Address

string

場所の特定の通りレベルのメンション: 住宅/建物番号、通り、通り、高速道路、名前で参照される交差点。

Age

string

年齢に関連する値。

Airport

string

空港。

Area

string

オブジェクトの領域。

City

string

市区町村関連の値。

ComputingProduct

string

コンピューティング製品。

Continent

string

大陸関連の値。

CountryRegion

string

国または地域に関連する値。

CulturalEvent

string

文化的なイベント関連の値。

Currency

string

通貨関連の値。

Date

string

カレンダーの日付。

DateRange

string

日付の範囲。

DateTime

string

カレンダーの日付と時刻。

DateTimeRange

string

日付と時刻の範囲。

Dimension

string

測定の寸法

Duration

string

期間。

Email

string

電子メール アドレス。

Event

string

ソーシャル、スポーツ、ビジネス、政治、教育、自然、歴史的、犯罪者、暴力、法的、軍事的なイベント。時間が限られています。

GPE

string

都市、国/地域、州。

Geological

string

河川、海洋、砂漠などの地理的および自然の特徴。

Height

string

オブジェクトの高さ。

IP

string

ネットワーク IP アドレス。

Information

string

デジタル情報の測定単位。

Length

string

オブジェクトの長さ。

Location

string

物理的な空間内の特定のポイントまたは場所。

NaturalEvent

string

自然イベント関連の値。

Number

string

単位のない数値

NumberRange

string

数値の範囲

Numeric

string

数字と数字の単語を含む数値。

Ordinal

string

序数。

Organization

string

確立された組織構造によって定義された企業、機関、およびその他のグループ。 これらのラベルには、企業、政治団体/運動、音楽バンド、スポーツ クラブ、政府機関、公共組織などが含まれます。 国籍や宗教は組織ではありません。

OrganizationMedical

string

医療企業とグループ。

OrganizationSports

string

スポーツ関連組織。

OrganizationStockExchange

string

証券取引所グループ。

Percentage

string

パーセンテージ関連の値。

Person

string

最初、姓、ミドル ネーム、架空の文字の名前、エイリアス。 タイトル ("Mr." など) または 'President' は、名前付きエンティティの一部とは見なされません。

PersonType

string

グループ メンバーシップによって分類される人間の役割。

PhoneNumber

string

電話番号 (米国と EU の電話番号のみ)。

Product

string

商用、消耗品、エレクトロニクス、車両、食品グループの単一またはグループ。

SetTemporal

string

時間関連の値のセット。

Skill

string

機能、スキル、または専門知識。

Speed

string

オブジェクトの速度。

SportsEvent

string

スポーツ イベント関連の値。

State

string

状態関連の値。

Structural

string

マンメイド構造。

Temperature

string

温度関連の値。

Temporal

string

時間に関連する項目。

Time

string

1 日の時刻。

TimeRange

string

時間の範囲。

URL

string

Web サイトへの URL。

Volume

string

オブジェクトのボリューム。

Weight

string

オブジェクトの重み。

EntityInferenceOptions

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

名前 規定値 説明
excludeNormalizedValues

boolean

False

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

EntityLinkingResult

エンティティ リンクの結果。

名前 説明
documents

LinkedEntitiesDocumentResult[]

ドキュメント別の応答

errors

DocumentError[]

ドキュメント ID 別のエラー。

modelVersion

string

このフィールドは、スコアリングに使用されるモデルを示します。

statistics

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

EntityLinkingTaskParameters

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

名前 規定値 説明
loggingOptOut

boolean

False

オプトアウトのログ記録

modelVersion

string

latest

モデル バージョン

stringIndexType

StringIndexType

TextElements_v8

文字列オフセットの解釈に使用する文字列インデックスの種類を指定する省略可能なパラメーター。 既定値は TextElements (Graphemes) です。

EntityLinkingTaskResult

分析テキストエンティティ リンク タスクの結果が含まれます。

名前 説明
kind string:

EntityLinkingResults

タスクの結果の種類。

results

EntityLinkingResult

エンティティ リンクの結果。

EntityTag

関連付けられている信頼度スコアのタグ abd の名前を含むエンティティ タグ オブジェクト。 エンティティ タグは、エンティティ間のいくつかの類似点/アフィニティを表すために使用されます。

名前 説明
confidenceScore

number

抽出されたエンティティの 0 から 1 までの検出スコア。

name

string

タグの名前。 エンティティ タグ名はグローバルに一意になります。

EntityWithMetadata

タグとメタデータを持つエンティティ オブジェクト。

名前 説明
category

string

エンティティ型。

confidenceScore

number

抽出されたエンティティの 0 から 1 までの信頼度スコア。

length

integer

エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響する可能性があります。

metadata BaseMetadata:

エンティティ メタデータ オブジェクト。

offset

integer

エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響する可能性があります。

subcategory

string

(省略可能)エンティティのサブタイプ。

tags

EntityTag[]

エンティティ タグの一覧。 タグは、エンティティ間のいくつかの類似点/アフィニティを表します。

text

string

要求に表示されるエンティティ テキスト。

type

string

エンティティ型は、エンティティが検出された最も低い (または最も細かい) 細分性です。 この型は、検出されたエンティティに関連付けられている特定のメタデータ属性にマップされます。

Error

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

名前 説明
code

ErrorCode

サーバー定義の一連のエラー コードの 1 つ。

details

Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

InnerErrorModel

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

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

エラー オブジェクト。

InformationMetadata

情報 (データ) エンティティ メタデータ モデルを表します。

名前 説明
metadataKind string:

InformationMetadata

エンティティ メタデータ オブジェクトの種類。

unit

InformationUnit

情報の測定単位。

value

number

抽出されたテキストが示す数値。

InformationUnit

情報 (データ) 測定単位。

名前 説明
Bit

string

データ サイズ単位 (ビット単位)

Byte

string

データ サイズ単位 (バイト単位)

Gigabit

string

ギガビット単位のデータ サイズ ユニット

Gigabyte

string

データ サイズ単位 (ギガバイト単位)

Kilobit

string

キロビット単位のデータ サイズ単位

Kilobyte

string

データ サイズ単位 (キロバイト単位)

Megabit

string

メガビット単位のデータ サイズ単位

Megabyte

string

データ サイズ単位 (メガバイト単位)

Petabit

string

ペタビト単位のデータ サイズ

Petabyte

string

ペタバイト単位のデータ サイズ単位

Terabit

string

テラビット単位のデータ サイズ単位

Terabyte

string

データ サイズ単位 (テラバイト単位)

Unspecified

string

指定されていないデータ サイズ単位

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

InnerErrorCode

サーバー定義の一連のエラー コードの 1 つ。

details

object

エラーの詳細。

innererror

InnerErrorModel

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

message

string

エラーメッセージ。

target

string

エラーターゲット。

KeyPhraseResult

KeyPhraseResult を格納します。

名前 説明
documents

KeyPhrasesDocumentResult[]

ドキュメント別の応答

errors

DocumentError[]

ドキュメント ID 別のエラー。

modelVersion

string

このフィールドは、スコアリングに使用されるモデルを示します。

statistics

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

KeyPhrasesDocumentResult

ドキュメントのキー フレーズ抽出結果を格納します。

名前 説明
id

string

空でない一意のドキュメント識別子。

keyPhrases

string[]

代表的な単語または語句の一覧。 返されるキー フレーズの数は、入力ドキュメント内の単語数に比例します。

statistics

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

warnings

DocumentWarning[]

ドキュメントの処理中に発生した警告。

KeyPhraseTaskParameters

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

名前 規定値 説明
loggingOptOut

boolean

False

オプトアウトのログ記録

modelVersion

string

latest

モデル バージョン

KeyPhraseTaskResult

分析テキスト KeyPhraseExtraction タスクの結果を格納します。

名前 説明
kind string:

KeyPhraseExtractionResults

タスクの結果の種類。

results

KeyPhraseResult

キー フレーズ抽出結果の一覧

LanguageDetectionAnalysisInput

言語検出ドキュメント分析入力が含まれます。

名前 説明
documents

LanguageInput[]

分析するドキュメントの一覧。

LanguageDetectionDocumentResult

ドキュメントの言語検出を含みます。

名前 説明
detectedLanguage

DetectedLanguage

検出された言語。

id

string

空でない一意のドキュメント識別子。

statistics

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

warnings

DocumentWarning[]

ドキュメントの処理中に発生した警告。

LanguageDetectionResult

要求の言語検出結果が含まれます。

名前 説明
documents

LanguageDetectionDocumentResult[]

各入力ドキュメントの言語検出結果の列挙。

errors

DocumentError[]

ドキュメント ID 別のエラー。

modelVersion

string

このフィールドは、スコアリングに使用されるモデルを示します。

statistics

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

LanguageDetectionTaskParameters

言語検出タスクでサポートされているパラメーター。

名前 規定値 説明
loggingOptOut

boolean

False

オプトアウトのログ記録

modelVersion

string

latest

モデル バージョン

LanguageDetectionTaskResult

要求の言語検出タスクの結果が含まれます。

名前 説明
kind string:

LanguageDetectionResults

タスクの結果の種類。

results

LanguageDetectionResult

言語検出の結果を格納します。

LanguageInput

言語検出入力が含まれます。

名前 説明
countryHint

string

テキストの言語検出に役立つ国ヒント。

id

string

空でない一意のドキュメント識別子。

text

string

処理する入力テキスト。

LengthMetadata

Length エンティティ メタデータ モデルを表します。

名前 説明
metadataKind string:

LengthMetadata

エンティティ メタデータ オブジェクトの種類。

unit

LengthUnit

長さの測定単位。

value

number

抽出されたテキストが示す数値。

LengthUnit

測定の長さの単位。

名前 説明
Centimeter

string

長さ単位 (センチメートル単位)。

Decameter

string

ディケーター単位の長さ。

Decimeter

string

デシメートル単位の長さ単位。

Foot

string

長さ単位 (フィート単位)。

Hectometer

string

長さ単位 (ヘクトメーター)。

Inch

string

長さ単位 (インチ単位)。

Kilometer

string

キロメートル単位の長さ単位。

LightYear

string

ライトイヤーの長さ単位。

Meter

string

長さ単位 (メートル単位)。

Micrometer

string

マイクロメートル単位の長さ単位。

Mile

string

長さ単位 (マイル単位)。

Millimeter

string

ミリメートル単位の長さ単位。

Nanometer

string

ナノメートル単位の長さ単位。

Picometer

string

ピコメーターの長さ単位。

Point

string

長さ単位 (ポイント単位)。

Unspecified

string

指定されていない長さの単位。

Yard

string

長さ単位 (ヤード単位)。

LinkedEntitiesDocumentResult

ドキュメントの結果をリンクするエンティティ。

名前 説明
entities

LinkedEntity[]

ドキュメント内で認識された既知のエンティティ。

id

string

空でない一意のドキュメント識別子。

statistics

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

warnings

DocumentWarning[]

ドキュメントの処理中に発生した警告。

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

要求に表示されるエンティティ テキスト。

MatchLongestEntityPolicyType

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

名前 規定値 説明
policyKind string:

matchLongest

matchLongest

エンティティ OverlapPolicy オブジェクトの種類。

MetadataKind

エンティティ メタデータ オブジェクトの種類。

名前 説明
AgeMetadata

string

年齢に関連する値のメタデータ。

AreaMetadata

string

エリア関連の値のメタデータ。

CurrencyMetadata

string

通貨関連の値のメタデータ。

DateMetadata

string

日付関連の値のメタデータ。

DateTimeMetadata

string

日付と時刻に関連する値のメタデータ。

InformationMetadata

string

情報関連の値のメタデータ。

LengthMetadata

string

長さに関連する値のメタデータ。

NumberMetadata

string

数値のメタデータ。

NumericRangeMetadata

string

数値範囲の値のメタデータ。

OrdinalMetadata

string

序数のメタデータ。

SpeedMetadata

string

速度に関連する値のメタデータ。

TemperatureMetadata

string

温度関連の値のメタデータ。

TemporalSetMetadata

string

時間関連の値のセットのメタデータ。

TemporalSpanMetadata

string

テンポラル スパン値のメタデータ。

TimeMetadata

string

時間関連の値のメタデータ。

VolumeMetadata

string

ボリューム関連の値のメタデータ。

WeightMetadata

string

重みに関連する値のメタデータ。

MultiLanguageAnalysisInput

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

名前 説明
documents

MultiLanguageInput[]

分析する入力ドキュメント。

MultiLanguageInput

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

名前 説明
id

string

空でない一意のドキュメント識別子。

language

string

(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 (以下は 2023-04-15-preview 以降にのみ適用されます)自動言語検出の場合は、"auto" を使用します。 設定しない場合は、既定で英語に "en" を使用します。

text

string

処理する入力テキスト。

NumberKind

抽出された数値エンティティの型。

名前 説明
Decimal

string

10 進数

Fraction

string

分数

Integer

string

整数

Percent

string

パーセント番号

Power

string

電源番号

Unspecified

string

指定されていない番号の種類

NumberMetadata

数値エンティティ インスタンスのメタデータ。

名前 説明
metadataKind string:

NumberMetadata

エンティティ メタデータ オブジェクトの種類。

numberKind

NumberKind

数値型の種類。

value

number

抽出されたテキストが示す内容の数値表現。

NumericRangeMetadata

は、数値の間隔のメタデータを表します。

名前 説明
maximum

number

間隔の終了値。

metadataKind string:

NumericRangeMetadata

エンティティ メタデータ オブジェクトの種類。

minimum

number

間隔の開始値。

rangeInclusivity

RangeInclusivity

この範囲の包括性。

rangeKind

RangeKind

サポートされている数値範囲の種類 (数値、速度など)。

OrdinalMetadata

数値エンティティ インスタンスのメタデータ。

名前 説明
metadataKind string:

OrdinalMetadata

エンティティ メタデータ オブジェクトの種類。

offset

string

参照に対するオフセット (たとえば、offset = -1 は 2 番目から最後の位置を示します)

relativeTo

RelativeTo

序数が示す参照ポイント。

value

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

住所

Age

string

年齢

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 運転免許証番号

CAHealthServiceNumber

string

CA ヘルス サービス番号

CAPassportNumber

string

CA Passport Number

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 運転免許証番号

DEIdentityCardNumber

string

DE ID カード番号

DEPassportNumber

string

DE Passport Number

DETaxIdentificationNumber

string

DE 税識別番号

DEValueAddedNumber

string

DE Value Added Number

DKPersonalIdentificationNumber

string

DK の個人識別番号

DKPersonalIdentificationV2

string

DK の個人識別 V2

Date

string

日付

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 の税識別番号

Email

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

人事の国民 ID 番号

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 Personal Public Service Number V2

ILBankAccountNumber

string

IL 銀行口座番号

ILNationalID

string

IL National ID

INPermanentAccount

string

IN Permanent Account

INUniqueIdentificationNumber

string

IN 固有の識別番号

IPAddress

string

IPアドレス

ITDriversLicenseNumber

string

IT 運転免許証番号

ITFiscalCode

string

IT 会計コード

ITValueAddedTaxNumber

string

IT 付加価値税番号

InternationalBankingAccountNumber

string

国際銀行口座番号

JPBankAccountNumber

string

JP銀行口座番号

JPDriversLicenseNumber

string

JP運転免許証番号

JPMyNumberCorporate

string

JP マイナンバーコーポレート

JPMyNumberPersonal

string

JPマイナンバーパーソナル

JPPassportNumber

string

JPパスポート番号

JPResidenceCardNumber

string

JPレジデンスカード番号

JPResidentRegistrationNumber

string

日本居住者登録番号

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

PhoneNumber

string

電話番号

ROPersonalNumericalCode

string

RO 個人数値コード

RUPassportNumberDomestic

string

RU Passport Number Domestic

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 Passport Number

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 Passport Number International

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

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

warnings

DocumentWarning[]

ドキュメントの処理中に発生した警告。

PiiResult

PiiResult を格納します。

名前 説明
documents

PiiEntitiesDocumentResult[]

ドキュメント別の応答

errors

DocumentError[]

ドキュメント ID 別のエラー。

modelVersion

string

このフィールドは、スコアリングに使用されるモデルを示します。

statistics

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

PiiTaskParameters

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

名前 規定値 説明
domain

PiiDomain

none

PII タスクのドメイン

loggingOptOut

boolean

False

オプトアウトのログ記録

modelVersion

string

latest

モデル バージョン

piiCategories

PiiCategory[]

応答で返される PII カテゴリの列挙。

stringIndexType

StringIndexType

TextElements_v8

分析に使用する StringIndexType。

PiiTaskResult

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

名前 説明
kind string:

PiiEntityRecognitionResults

タスクの結果の種類。

results

PiiResult

pii の結果の一覧

RangeInclusivity

このプロパティの範囲の包括性。

名前 説明
LeftInclusive

string

左側 (両端を含む)

LeftRightInclusive

string

両側を含む

NoneInclusive

string

包括性なし

RightInclusive

string

右側 (両端を含む)

RangeKind

数値範囲エンティティの種類。

名前 説明
Age

string

年齢範囲

Area

string

エリア範囲

Currency

string

通貨範囲

Information

string

情報範囲

Length

string

長さの範囲

Number

string

数値の範囲

Speed

string

速度範囲

Temperature

string

温度範囲

Volume

string

ボリューム範囲

Weight

string

重みの範囲

RelativeTo

序数が示す参照ポイント。

名前 説明
Current

string

現在の状態または位置

End

string

終了状態または位置

Start

string

開始状態または位置

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

名前 説明
documentsCount

integer

要求で送信されたドキュメントの数。

erroneousDocumentsCount

integer

無効なドキュメントの数。 これには、空の、サイズ超過の制限、またはサポートされていない言語ドキュメントが含まれます。

transactionsCount

integer

要求のトランザクションの数。

validDocumentsCount

integer

有効なドキュメントの数。 これにより、空の、サイズ超過の制限、またはサポートされていない言語ドキュメントが除外されます。

ScriptCode

入力ドキュメントのスクリプトを識別します。 ISO 15924 標準スクリプト コードにマップされます。

名前 説明
Arab

string

アラビア語スクリプトのスクリプト コード。

Armn

string

アルメニア語スクリプトのスクリプト コード。

Beng

string

Bangla スクリプトのスクリプト コード。

Cans

string

UnifiedCanadianAboriginalSyllabics スクリプトのスクリプト コード。

Cyrl

string

キリル文字スクリプトのスクリプト コード。

Deva

string

Devanagari スクリプトのスクリプト コード。

Ethi

string

Ethiopic スクリプトのスクリプト コード。

Geor

string

ジョージア語スクリプトのスクリプト コード。

Grek

string

ギリシャ語スクリプトのスクリプト コード。

Gujr

string

Gujarati スクリプトのスクリプト コード。

Guru

string

グルムキ スクリプトのスクリプト コード。

Hang

string

ハングル スクリプトのスクリプト コード。

Hani

string

HanLiteral スクリプトのスクリプト コード。

Hans

string

HanSimplified スクリプトのスクリプト コード。

Hant

string

HanTraditional スクリプトのスクリプト コード。

Hebr

string

ヘブライ語スクリプトのスクリプト コード。

Jpan

string

日本語スクリプトのスクリプト コード。

Khmr

string

Khmer スクリプトのスクリプト コード。

Knda

string

カンナダ スクリプトのスクリプト コード。

Laoo

string

ラオス語スクリプトのスクリプト コード。

Latn

string

ラテン文字スクリプトのスクリプト コード。

Mlym

string

マラヤーラム スクリプトのスクリプト コード。

Mong

string

モンゴル語スクリプトのスクリプト コード。

Mtei

string

Meitei スクリプトのスクリプト コード。

Mymr

string

ミャンマー スクリプトのスクリプト コード。

Olck

string

Santali スクリプトのスクリプト コード。

Orya

string

Odia スクリプトのスクリプト コード。

Shrd

string

Sharada スクリプトのスクリプト コード。

Sinh

string

Sinhala スクリプトのスクリプト コード。

Taml

string

Tamil スクリプトのスクリプト コード。

Telu

string

Telugu スクリプトのスクリプト コード。

Thaa

string

Thaana スクリプトのスクリプト コード。

Thai

string

タイ語スクリプトのスクリプト コード。

Tibt

string

ティベク語スクリプトのスクリプト コード。

ScriptKind

入力ドキュメントのスクリプトを識別します。 ISO 15924 標準正式名にマップされます。

名前 説明
Arabic

string

アラビア語スクリプトのスクリプト名。

Armenian

string

アルメニア語スクリプトのスクリプト名。

Bangla

string

Bangla スクリプトのスクリプト名。

Cyrillic

string

キリル文字スクリプトのスクリプト名。

Devanagari

string

Devanagari スクリプトのスクリプト名。

Ethiopic

string

Ethiopic スクリプトのスクリプト名。

Georgian

string

ジョージア語スクリプトのスクリプト名。

Greek

string

ギリシャ語スクリプトのスクリプト名。

Gujarati

string

Gujarati スクリプトのスクリプト名。

Gurmukhi

string

グルムキ スクリプトのスクリプト名。

HanLiteral

string

HanLiteral スクリプトのスクリプト名。

HanSimplified

string

HanSimplified スクリプトのスクリプト名。

HanTraditional

string

HanTraditional スクリプトのスクリプト名。

Hangul

string

ハングル スクリプトのスクリプト名。

Hebrew

string

ヘブライ語スクリプトのスクリプト名。

Japanese

string

日本語スクリプトのスクリプト名。

Kannada

string

カンナダ スクリプトのスクリプト名。

Khmer

string

Khmer スクリプトのスクリプト名。

Lao

string

ラオス語スクリプトのスクリプト名。

Latin

string

ラテン文字スクリプトのスクリプト名。

Malayalam

string

マラヤーラム スクリプトのスクリプト名。

Meitei

string

Meitei スクリプトのスクリプト名。

Mongolian

string

モンゴル語スクリプトのスクリプト名。

Myanmar

string

ミャンマー スクリプトのスクリプト名。

Odia

string

Odia スクリプトのスクリプト名。

Santali

string

Santali スクリプトのスクリプト名。

Sharada

string

Sharada スクリプトのスクリプト名。

Sinhala

string

シンハラ語スクリプトのスクリプト名。

Tamil

string

Tamil スクリプトのスクリプト名。

Telugu

string

Telugu スクリプトのスクリプト名。

Thaana

string

Thaana スクリプトのスクリプト名。

Thai

string

タイ語スクリプトのスクリプト名。

Tibetan

string

ザ・ティベタンスクリプトのスクリプト名。

UnifiedCanadianAboriginalSyllabics

string

UnifiedCanadianAboriginalSyllabics スクリプトのスクリプト名。

SentenceAssessment

文の評価と、それに関連する評価またはターゲット オブジェクトを表します。

名前 説明
confidenceScores

TargetConfidenceScoreLabel

すべてのセンチメント クラス (正と負) の信頼度スコアを表します。

isNegated

boolean

評価が否定されているかどうかを表すインジケーター。

length

integer

ターゲットの長さ。

offset

integer

文の先頭からのターゲット オフセット。

sentiment

TokenSentimentValue

文のセンチメント。

text

string

ターゲット テキストが検出されました。

SentenceSentiment

ドキュメントの文のセンチメント。

名前 説明
assessments

SentenceAssessment[]

文の評価の配列。

confidenceScores

SentimentConfidenceScores

すべてのクラスの文に対する 0 から 1 のセンチメント信頼度スコア。

length

integer

ターゲットの長さ。

offset

integer

文の先頭からのターゲット オフセット。

sentiment

SentenceSentimentValue

文の予測センチメント。

targets

SentenceTarget[]

文の対象となる文の配列。

text

string

文のテキスト。

SentenceSentimentValue

文の予測センチメント。

名前 説明
negative

string

負のセンチメント

neutral

string

ニュートラルセンチメント

positive

string

肯定的なセンチメント

SentenceTarget

文のターゲットと、それに関連する評価またはターゲット オブジェクトを表します。

名前 説明
confidenceScores

TargetConfidenceScoreLabel

すべてのセンチメント クラス (正と負) の信頼度スコアを表します。

length

integer

ターゲットの長さ。

offset

integer

文の先頭からのターゲット オフセット。

relations

TargetRelation[]

ターゲットに関連する評価オブジェクトまたはターゲット オブジェクトの配列。

sentiment

TokenSentimentValue

文のセンチメント。

text

string

ターゲット テキストが検出されました。

SentimentAnalysisTaskParameters

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

名前 規定値 説明
loggingOptOut

boolean

False

オプトアウトのログ記録

modelVersion

string

latest

モデル バージョン

opinionMining

boolean

False

要求でオピニオン マイニングを使用するかどうか。

stringIndexType

StringIndexType

TextElements_v8

文字列オフセットの解釈に使用するメソッドを指定します。

SentimentConfidenceScores

すべてのセンチメント クラス (正、中立、負) の 0 から 1 の信頼度スコアを表します。

名前 説明
negative

number

否定的なセンチメントの信頼度スコア

neutral

number

ニュートラルセンチメントの信頼度スコア

positive

number

肯定的なセンチメントの信頼度スコア

SentimentDocumentResult

各ドキュメントの事前構築済みのセンチメント分析結果を表すオブジェクト。

名前 説明
confidenceScores

SentimentConfidenceScores

すべてのクラスの文に対する 0 から 1 のセンチメント信頼度スコア。

id

string

空でない一意のドキュメント識別子。

sentences

SentenceSentiment[]

ドキュメントの文のセンチメント。

sentiment

DocumentSentimentValue

ドキュメントの予測センチメント (負、中立、正、または混合)。

statistics

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

warnings

DocumentWarning[]

ドキュメントの処理中に発生した警告。

SentimentResponse

入力ドキュメントの感情分析結果。

名前 説明
documents

SentimentDocumentResult[]

入力内の各ドキュメントのセンチメント分析結果。

errors

DocumentError[]

ドキュメント ID 別のエラー。

modelVersion

string

このフィールドは、スコアリングに使用されるモデルを示します。

statistics

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

SentimentTaskResult

SentimentAnalysis LRO タスクの分析テキストが含まれています。

名前 説明
kind string:

SentimentAnalysisResults

タスクの結果の種類。

results

SentimentResponse

センチメント分析の結果

SpeedMetadata

Speed エンティティ メタデータ モデルを表します。

名前 説明
metadataKind string:

SpeedMetadata

エンティティ メタデータ オブジェクトの種類。

unit

SpeedUnit

速度の測定単位。

value

number

抽出されたテキストが示す数値。

SpeedUnit

速度測定単位

名前 説明
CentimetersPerMillisecond

string

ミリ秒あたりのセンチメートル単位の速度単位。

FeetPerMinute

string

毎分フィート単位の速度単位。

FeetPerSecond

string

速度単位 (フィート/秒)。

KilometersPerHour

string

速度単位 (キロメートル/時)。

KilometersPerMillisecond

string

速度単位 (キロメートル/ミリ秒)。

KilometersPerMinute

string

毎分キロメートル単位の速度単位。

KilometersPerSecond

string

速度単位 (キロメートル/秒)。

Knots

string

結び目の速度単位。

MetersPerMillisecond

string

ミリ秒あたりの速度単位 (メートル単位)。

MetersPerSecond

string

速度単位 (メートル/秒)。

MilesPerHour

string

毎時マイル単位の速度単位。

Unspecified

string

指定されていない速度ユニット。

YardsPerMinute

string

毎分ヤード単位の速度単位。

YardsPerSecond

string

速度単位 (ヤード/秒)。

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

ターゲットに関連する型。

TargetRelationType

ターゲットに関連する型。

名前 説明
assessment

string

評価の関係。

target

string

ターゲットの関係。

TemperatureMetadata

Information エンティティメタデータ モデルを表します。

名前 説明
metadataKind string:

TemperatureMetadata

エンティティ メタデータ オブジェクトの種類。

unit

TemperatureUnit

温度の測定単位。

value

number

抽出されたテキストが示す数値。

TemperatureUnit

温度測定単位。

名前 説明
Celsius

string

摂氏の温度単位

Fahrenheit

string

華氏の温度単位

Kelvin

string

ケルビンの温度単位

Rankine

string

ランキンの温度単位

Unspecified

string

指定されていない温度単位

TemporalModifier

日付/時刻インスタンスの省略可能な修飾子。

名前 説明
After

string

特定の時刻の後

AfterApprox

string

おおよその時間が経過した後

AfterMid

string

期間の途中以降

AfterStart

string

期間の開始後

Approx

string

おおよその特定の時刻

Before

string

特定の時刻より前

BeforeApprox

string

おおよその時間の前

BeforeEnd

string

期間の終了前

BeforeStart

string

期間の開始前

End

string

期間の終了時

Less

string

特定の時間未満

Mid

string

期間の途中

More

string

特定の時間を超える

ReferenceUndefined

string

未定義の時刻への参照

Since

string

特定の時刻から

SinceEnd

string

期間の終了以降

Start

string

期間の開始時

Until

string

特定の時刻まで

TemporalSetMetadata

テンポラル セット エンティティ インスタンスのメタデータ。

名前 説明
dateValues

DateValue[]

日付値の一覧。

metadataKind string:

TemporalSetMetadata

エンティティ メタデータ オブジェクトの種類。

TemporalSpanMetadata

は、日付または期間のメタデータを表します。

名前 説明
metadataKind string:

TemporalSpanMetadata

エンティティ メタデータ オブジェクトの種類。

spanValues

TemporalSpanValues[]

テンポラル スパンの一覧が検出されました。

TemporalSpanValues

テンポラル スパン オブジェクト。

名前 説明
begin

string

スパンの開始値。

duration

string

ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) に基づいて書式設定された省略可能な期間値

end

string

スパンの終了値。

modifier

TemporalModifier

before、after などの参照ポイントを示す datetime の修飾子。

timex

string

ISO 8601 で書式設定された文字列として記述された先頭、末尾、および期間を含む省略可能なトリプレット。

TimeMetadata

時間エンティティ インスタンスのメタデータ。

名前 説明
dateValues

DateValue[]

日付値の一覧。

metadataKind string:

TimeMetadata

エンティティ メタデータ オブジェクトの種類。

TokenSentimentValue

文の予測センチメント。

名前 説明
mixed

string

混合センチメント

negative

string

負のセンチメント

positive

string

肯定的なセンチメント

VolumeMetadata

ボリューム エンティティ メタデータ モデルを表します。

名前 説明
metadataKind string:

VolumeMetadata

エンティティ メタデータ オブジェクトの種類。

unit

VolumeUnit

ボリュームの測定単位。

value

number

抽出されたテキストが示す数値。

VolumeUnit

測定単位のボリューム

名前 説明
Barrel

string

バレルの容積単位。

Bushel

string

ブッシェルの容積単位。

Centiliter

string

ボリューム単位 (センチリットル単位)。

Cord

string

コードのボリュームユニット。

CubicCentimeter

string

体積単位 (立方センチメートル単位)。

CubicFoot

string

体積単位 (立方フィート単位)。

CubicInch

string

体積単位 (立方インチ単位)。

CubicMeter

string

体積単位 (立方メートル単位)。

CubicMile

string

体積単位 (立方マイル単位)。

CubicMillimeter

string

体積単位 (立方ミリメートル単位)。

CubicYard

string

立方ヤード単位の体積単位。

Cup

string

カップ単位のボリューム。

Decaliter

string

デカルタイターのボリュームユニット。

FluidDram

string

流体ドラムの容積単位。

FluidOunce

string

液体オンスの容積単位。

Gill

string

鰻の容積単位。

Hectoliter

string

ヘクトリターのボリューム ユニット。

Hogshead

string

ホグヘッドのボリューム ユニット。

Liter

string

リットル単位の容積単位。

Milliliter

string

体積単位 (ミリ単位)。

Minim

string

ミニム単位のボリューム単位。

Peck

string

ペック単位のボリューム単位。

Pinch

string

ピンチ内のボリュームユニット。

Pint

string

Pint 単位のボリューム単位。

Quart

string

ボリューム単位 (クォート単位)。

Tablespoon

string

大さじ単位のボリューム単位。

Teaspoon

string

小さじ 1 のボリューム ユニット。

Unspecified

string

未指定のボリュームユニット。

WarningCodeValue

警告コードの一覧を定義します。

名前 説明
DocumentTruncated

string

ドキュメントの切り捨て警告

LongWordsInDocument

string

ドキュメント内の長い単語の警告

WeightMetadata

Weight) エンティティ メタデータ モデルを表します。

名前 説明
metadataKind string:

WeightMetadata

エンティティ メタデータ オブジェクトの種類。

unit

WeightUnit

重量の測定単位。

value

number

抽出されたテキストが示す数値。

WeightUnit

測定単位の重み。

名前 説明
Dram

string

重み単位 (drams)

Gallon

string

ガロン単位の容積単位

Grain

string

粒の重量単位

Gram

string

重量単位 (グラム単位)

Kilogram

string

重量単位 (キロ単位)

LongTonBritish

string

長いトンの重量の単位(イギリス)

MetricTon

string

重量単位 (メートルトン)

Milligram

string

重量単位 (ミリグラム単位)

Ounce

string

重量単位 (オンス)

PennyWeight

string

ペニーウェイト単位

Pound

string

重量単位 (ポンド単位)

ShortHundredWeightUS

string

ショートハンドレッドウェイトの重量単位 (米国)

ShortTonUS

string

短いトンの重量の単位(米国)

Stone

string

石の重量の単位

Ton

string

重量単位 (トン単位)

Unspecified

string

未指定の重量単位