テキストの言語を識別します。
リクエストURL
次の POST 要求を送信します。
https://api.cognitive.microsofttranslator.com/detect?api-version=3.0
Translator で選択したネットワークとプライベート エンドポイントの構成とサポートに対する仮想ネットワークのサポートを参照してください。
要求パラメーター
クエリ文字列で渡される要求パラメーターは次のとおりです。
| Query parameter (クエリ パラメーター) | Description |
|---|---|
| APIバージョン |
必須パラメーター。 クライアントによって要求された API のバージョン。 値は 3.0 とする必要があります。 |
要求ヘッダーには次のものが含まれます。
| Headers | Description |
|---|---|
| 認証ヘッダー |
必須の要求ヘッダー。 認証に使用できるオプションを参照してください。 |
| コンテンツタイプ |
必須の要求ヘッダー。 ペイロードのコンテンツ タイプを指定します。 指定できる値は、 application/jsonです。 |
| コンテンツの長さ |
オプション。 要求本文の長さ。 |
| X-ClientTraceId |
オプション。 要求を一意に識別するためのクライアントによって生成された GUID。 ClientTraceIdという名前のクエリ パラメーターを使用してクエリ文字列にトレース ID を含める場合は、このヘッダーを省略できます。 |
リクエストの本文
要求の本文は JSON 配列です。 各配列要素は、 Textという名前の文字列プロパティを持つ JSON オブジェクトです。 言語検出は、 Text プロパティの値に適用されます。 言語自動検出は、長い入力テキストでより適切に機能します。 サンプル要求本文は次のようになります。
[
{ "text": "Ich würde wirklich gerne Ihr Auto ein paar Mal um den Block fahren." }
]
次の制限事項が適用されます。
- 配列には最大 100 個の要素を含めることができます。
- 要求に含まれるテキスト全体は、スペースを含めて 50,000 文字を超えることはできません。
応答本文
成功した応答は、入力配列内の各文字列に対して 1 つの結果を持つ JSON 配列です。 結果オブジェクトには、次のプロパティが含まれます。
language: 検出された言語のコード。score: 結果の信頼度を示す浮動小数点値。 スコアが 0 から 1 の間で、低いスコアは低い信頼度を示します。isTranslationSupported: 検出された言語がテキスト翻訳でサポートされている言語の 1 つである場合に true のブール値。isTransliterationSupported: 検出された言語が表記変換でサポートされている言語の 1 つである場合に true のブール値。alternatives: 他の可能な言語の配列。 配列の各要素は、language、score、isTranslationSupported、isTransliterationSupportedの各プロパティを持つ別のオブジェクトです。
JSON 応答の例を次に示します。
[
{
"language": "de",
"score": 1.0,
"isTranslationSupported": true,
"isTransliterationSupported": false
}
]
応答ヘッダー
| Headers | Description |
|---|---|
| X-RequestId | 要求を識別するためにサービスによって生成され、トラブルシューティングのために使用される値。 |
応答ステータスコード
要求から返される可能性のある HTTP 状態コードを次に示します。
| 状態コード | Description |
|---|---|
| 200 | 成功。 |
| 400 | クエリ パラメーターの 1 つが見つからないか、無効です。 再試行する前に要求パラメーターを修正します。 |
| 401 | 要求を認証できませんでした。 資格情報が指定され、有効であることを確認します。 |
| 4:03 | 要求が承認されていません。 詳細エラー メッセージを確認します。 このコードは、多くの場合、試用版サブスクリプションで提供されるすべての無料翻訳が使用されることを示します。 |
| 429 | クライアントが要求の制限を超えたため、サーバーは要求を拒否しました。 |
| 500 | 予期しないエラーが発生しました。 エラーが解決しない場合は、エラーの日時、応答ヘッダー X-RequestIdからの要求識別子、および要求ヘッダー X-ClientTraceIdからのクライアント識別子を使用して報告します。 |
| 503 | サーバーは一時的に使用できません。 要求を再試行します。 エラーが解決しない場合は、エラーの日時、応答ヘッダー X-RequestIdからの要求識別子、および要求ヘッダー X-ClientTraceIdからのクライアント識別子を使用して報告します。 |
エラーが発生した場合、要求は JSON エラー応答を返します。 エラー コードは、3 桁の HTTP 状態コードと 3 桁の数字を組み合わせた 6 桁の数字で、さらにエラーを分類します。 一般的なエラー コードは 、v3 Translator のリファレンス ページにあります。
例示
次の例は、テキスト翻訳でサポートされている言語を取得する方法を示しています。
curl -X POST "https://api.cognitive.microsofttranslator.com/detect?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'What language is this text written in?'}]"