> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Localization Translate API の接続と使用

> Localization translation 集成指南 - XHuoAPI

Localization Translate API の主な機能は、翻訳が必要なテキストを入力することで翻訳されたテキストを取得することです。また、翻訳後の言語はカスタマイズ可能で、翻訳結果は `json` と `markdown` の2つの主流な方法で出力できます。

本ドキュメントでは、Translate API の接続説明を詳しく紹介し、簡単に統合し、この API の強力な機能を十分に活用できるようにします。Translate API を使用することで、入力したテキストを特定の言語に翻訳し、特定の方法で翻訳結果を出力することが簡単に実現できます。

## 申請プロセス

Localization Translate API を使用するには、まず申請ページ [Localization Translate API](https://api.xhuoapi.ai/documents/6dcc60d0-a973-4ad2-92d8-11f4d3775532) にアクセスして、該当するサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。

![申請ページ](https://cdn.xhuoapi.ai/rci31i.png)

まだログインまたは登録していない場合は、自動的に[ログインページ](https://api.xhuoapi.ai)にリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。

初回申請時には無料のクレジットが付与され、この API を無料で使用できます。

## リクエスト例

英語の入力を例に、API の使用方法を示します。英語の説明文は次のとおりです：`# Title 1\n\nThis is a paragraph.\n\n## Title 2\n\nThis is another paragraph.` 次に、英語の説明文をアップロードし、中国語の翻訳結果を取得する方法を示し、markdown 形式で表示します。

### リクエストヘッダーとリクエストボディの設定

**Request Headers** には以下が含まれます：

* `accept`：JSON形式のレスポンス結果を受け取ることを指定します。ここには `application/json` と記入します。
* `authorization`：APIを呼び出すためのキーで、申請後に直接ドロップダウンから選択できます。

**Request Body** には以下が含まれます：

* `input`：翻訳が必要なテキストをアップロードします。
* `locale`：翻訳する言語をカスタマイズします。
* `extension`：翻訳結果の表示形式をカスタマイズします。
* `model`：翻訳に使用する大モデルで、デフォルトは gpt-3.5 です。

設定は以下の図のようになります：

<p>
  <img src="https://cdn.xhuoapi.ai/d4uqst.png" width="500" className="m-auto" />
</p>

### コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。

<p>
  <img src="https://cdn.xhuoapi.ai/tn5nno.png" width="500" className="m-auto" />
</p>

一部のコード例は以下の通りです：

#### CURL

```bash theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/localization/translate' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "input": "# Title 1\n\nThis is a paragraph.\n\n## Title 2\n\nThis is another paragraph.",
  "locale": "zh-CN",
  "extension": "md"
}'
```

#### Python

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/localization/translate"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "input": "# Title 1\n\nThis is a paragraph.\n\n## Title 2\n\nThis is another paragraph.",
    "locale": "zh-CN",
    "extension": "md"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

### レスポンス例

リクエストが成功すると、API はこの翻訳タスクの結果情報を返します。例えば：

```json theme={null}
{
  "data": "# タイトル 1\n\nこれは段落です。\n\n## タイトル 2\n\nこれは別の段落です。",
  "usage": {
    "prompt_tokens": 172,
    "completion_tokens": 25
  },
  "model": "gpt-3.5-turbo-16k",
  "locale": "zh-CN"
}
```

結果には `data` フィールドがあり、翻訳された中国語が含まれ、markdown 形式で返されます。他の情報は以下の通りです：

* `data`：この翻訳タスクの結果。
* `model`：この翻訳タスクで使用された大言語モデル。
* `locale`：この翻訳タスクの翻訳言語タイプ。

## エラーハンドリング

API を呼び出す際にエラーが発生した場合、API は対応するエラーコードと情報を返します。例えば：

* `400 token_mismatched`：不正なリクエスト、パラメータが不足しているか無効な可能性があります。
* `400 api_not_implemented`：不正なリクエスト、パラメータが不足しているか無効な可能性があります。
* `401 invalid_token`：未認証、無効または不足している認証トークン。
* `429 too_many_requests`：リクエストが多すぎます、レート制限を超えました。
* `500 api_error`：内部サーバーエラー、サーバーで何かがうまくいきませんでした。

### エラー応答例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 結論

本ドキュメントを通じて、Localization Translate API を使用して入力したテキストを特定の言語に翻訳し、特定の方法で翻訳結果を出力する方法を理解できたと思います。本ドキュメントが、API の接続と使用をより良くする手助けとなることを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。
