Translator 3.0:BreakSentence

[アーティクル]
09/01/2024

文章内で文の境界の位置を識別します。

要求 URL

POST 要求の送信先は次のとおりです。

https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0

Translator サービスの選択したネットワークとプライベートエンドポイントの構成とサポートについては Virtual ネットワークサポート を参照してください。

要求パラメーター

クエリ文字列に渡される要求パラメーターを次に示します。

クエリパラメーター	説明
api-version	"必須のクエリパラメーター" です。クライアントによって要求される API のバージョン。値は `3.0` とする必要があります。
language	"省略可能なクエリパラメーター" です。入力テキストの言語を示す言語タグ。コードを指定しないと、言語の自動検出が適用されます。
script	"省略可能なクエリパラメーター" です。入力テキストで使われているスクリプトを示すスクリプトタグ。スクリプトを指定しないと、言語の既定のスクリプトが見想定されれます。

要求ヘッダーには次のものがあります。

ヘッダー	説明
認証ヘッダー	"必須の要求ヘッダー" です。認証に使用できるオプションに関するページをご覧ください。
Content-Type	"必須の要求ヘッダー" です。ペイロードのコンテンツタイプを指定します。次のいずれかの値になります。`application/json`
Content-Length	省略可。要求本文の長さです。
X-ClientTraceId	オプション。要求を一意に識別する、クライアントで生成された GUID。 `ClientTraceId` という名前のクエリパラメーターを使用してクエリ文字列内にトレース ID を含める場合、このヘッダーは省略できます。

要求本文

要求の本文は JSON 配列です。各配列要素は、Text という名前の文字列プロパティを持つ JSON オブジェクトです。文の境界は、Text プロパティの値に対して計算されます。 1 つのテキストを含む要求本文の例を次に示します。

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

次の制限事項が適用されます。

配列に含めることができる要素は、最大でも 100 個です。
配列要素のテキスト値は、スペースも含めて 50,000 文字以下にする必要があります。
要求に含めるテキスト全体は、スペースも含めて 50,000 文字以下にする必要があります。
language クエリパラメーターを指定する場合は、すべての配列要素が同じ言語である必要があります。それ以外の場合、言語の自動検出が配列の各要素に個別に適用されます。

応答の本文

正常な応答は、入力配列内の文字列ごとに 1 つの結果が含まれる JSON 配列となります。結果オブジェクトには次のプロパティが含まれています。

sentLen:テキスト要素内の文の長さを表す整数の配列です。配列の長さは文の数であり、値は各文の長さです。
detectedLanguage:次のプロパティによって、検出された言語を説明するオブジェクトです。
- language:検出された言語のコードです。
- score:結果内の信頼度を示す浮動小数点値です。このスコアは、0 と 1.0 の間です。低いスコア (<= 0.4) は、信頼度が低いことを示します。

detectedLanguage プロパティは、言語自動検出が要求された場合に限り、結果オブジェクト内に存在します。

JSON 応答の例を次に示します。

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

応答ヘッダー

ヘッダー	説明
X-RequestId	要求を識別するためにサービスによって生成され、トラブルシューティングのために使用される値。

応答状態コード

要求によって返される可能性のある HTTP 状態コードを次に示します。

状態コード	説明
200	正常終了しました。
400	クエリパラメーターの 1 つが欠落しているか無効です。再試行する前に要求パラメーターを修正してください。
401	要求を認証できませんでした。資格情報が指定され、有効であることを確認してください。
403	要求は承認されません。詳細なエラーメッセージを確認してください。多くの場合、この応答コードは、試用版サブスクリプションで提供されるすべての無料翻訳が使用されることを示します。
429	クライアントが要求の制限を超えたため、サーバーは要求を拒否しました。
500	予期しないエラーが発生しました。エラーが解決しない場合は、エラー発生の日時、応答ヘッダー `X-RequestId` からの要求識別子、要求ヘッダー `X-ClientTraceId` からのクライアント識別子を添えてその旨をご報告ください。
503	サーバーが一時的に使用できません。要求をやり直してください。エラーが解決しない場合は、エラー発生の日時、応答ヘッダー `X-RequestId` からの要求識別子、要求ヘッダー `X-ClientTraceId` からのクライアント識別子を添えてその旨をご報告ください。

エラーが発生した場合、要求から JSON エラー応答を返します。このエラーコードは 3 桁の HTTP ステータスコードの後に､エラーをさらに分類するための 3 桁の数字を続けた 6 桁の数字です｡一般的なエラーコードは、v3 Translator のリファレンスページで確認できます。

例

次の例では、1 つの文に対する文の境界を取得する方法を示します。このサービスでは、文の言語が自動的に検出されます。

curl -X POST "https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"

次の方法で共有