Google Diacritize APIとは、
ネイティブでない人向けに
テキストに対応する発音記号を返す
GoogleのAPI(Application Programin Interface)です。Google Language API Familyに含まれます。
現在のステータスはLabsになっていますので、
今後変更もありえます。
今回はGoogle Diacritize APIのスタートガイドページです。
Developer's Guide(v1):Getting Started
重要:このバージョンのGoogle Diacritize APIはin Labsの状態で、この機能は次の段階に進むまでに予告なしに変更される場合があります。
この文書は、Google Diacritize API v1を使用する上で必要となる背景となる知識を解説します。
Contents
Intorduction
Diaceitize API background
･Diacritize concepts
･Diacritize API operations
Calling style
･REST
Data format
･JSON
Intorduction
このドキュメントは、Google Diacritize APIと相互に通信できるアプリケーションを書きたいという開発者向けです。Google Tashkeel(またはDiacritize)で、ウェブページやアプリケーション内のテキストに、発音記号を付加することができます。
新しいプロジェクトをセットアップするために、Google APIs consoleでAPI keyを取得してください。
重要:Google Diacritize APIはGoogle APIs consoleから取得できるAPI keyの使用が必須です。
Diacritize API background
Diacritize concepts
Diacritize APIは、ウェブサイトにGoogle Tashkeelのパワーを加えることを可能にします。APIはテキストに発音記号を付加することができます。これらの発音記号は必須ではありませんが、ネイティブではない話者の発音をアシストすることができます。
発音記号はアラビア語(APIがサポートしています)を含めた幾つかの言語で使用されています。これらの記号なしのテキストの文字列を渡すことで、記号を付け加えた同一の文字列を取得できます。それに加えて、それぞれの単語の最後に記号を付け加えるかどうか選択することができます。
Diacritize API operations
Google Diacritize APIで呼び出すメソッドは、一つだけです。
| Operation | Description | REST HTTP Mapping |
|---|---|---|
| diacritize | 発音記号を付加した、リクエストされたテキストを返します。 | GET |
Calling styles
API呼び出しには、複数の方法があります。
･RESTディレクトリを使用する
･(サーバーサイドのコードを必要としない)JavaScriptからRESTを使用する
REST
Google Diacritize APIにおけるREST、REpresentational State Transferは、伝統的なRESTとはいくらか違いが存在します。
リソースへのアクセスの提供の代わりに、APIはサービスへのアクセスを提供します。結果として、APIはサービスのエンドポイントとして働く単一のURLを提供します。
Google Diacritize APIサービスのエンドポイントには、API operationsで説明されるGET REST HTTP動詞を使ってアクセスします。全てのサービスへのリクエストの詳細は、クエリのパラメータとして渡します。
単一のGoogle Diacritize API URIの定型のフォーマットは
https://www.googleapis.com/language/diacritize/v1?parameters
です。
parameterの部分は、クエリに適用するパラメータを表します。詳細については、Using REST 文書のWorking with resultsとQuery parameter referenceを参照してください。
以下は、Diacritize APIでの使い方の一例です。このサンプルコードは提供されたテキストに発音記号を付加しますが、それぞれの単語の後ではありません。
GET https://www.googleapis.com/language/diacritize/v1?key=INSERT-YOUR-KEY&lang=ar&message=%D9%85%D8%AB%D8%A7%D9%84%20%D9%84%D8%AA%D8%B4%D9%83%D9%8A%D9%84&last_letter=false
REST from JavaScript
コールバッククエリパラメータ、コールバック機能を使用して、JavaScriptからRESTを使ってDiacirtize APIを呼び出すことができます。これにより、サーバーサイドのコードを記述することなく、Diacritizeデータを表示する立地アプリケーションを書くことが可能になります。
以下のサンプルコードは、発音記号を付加した複数のテキストの表示を行います。
<html>
<head>
<title>Diacritize API Example</title>
</head>
<body>
<div id="content"></div>
<script>
function handleResponse(response) {
// in production code, item.text should have the HTML entities escaped.
document.getElementById("content").innerHTML += "<br>" + response.data.diacritized_text;
}
</script>
<script src="https://www.googleapis.com/language/diacritize/v1?key=INSERT-YOUR-KEY&lang=ar&message=%D9%85%D8%AB%D8%A7%D9%84%20%D9%84%D8%AA%D8%B4%D9%83%D9%8A%D9%84&last_letter=false&callback=handleResponse"></script>
</body>
</html>
JSON
JSON(JavaScript Object Notation)は、任意のデータ構造を表すシンプルな方法を提供する共通インターネットフォーマットです。json.orgによると、JSONは完全に言語から独立したテキストフォーマットですが、C,C++,C#,Java,JavaScript,Perl,Pythonや他の多くのCファミリーの言語のプログラマには慣れ親しんだ表記法を使用しています。
インストール不要･無料のKaede翻訳ツール：
http://kaedetrans.appspot.com/
