> ## 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.

# OpenAI Embeddings API 申請及び使用

> OpenAI generation 集成指南 - XHuoAPI

OpenAI の単語ベクトルサービスは、入力テキストを表す単語ベクトル結果を生成するために使用されます。

この文書では、OpenAI Embeddings API の操作の使用プロセスについて主に説明します。これを利用して、入力テキストを表す埋め込みベクトルを作成できます。

## 申請プロセス

OpenAI Embeddings API を使用するには、まず [OpenAI Embeddings API](https://api.xhuoapi.ai/documents/0f2e63fa-5890-4bdd-84f0-1706b5c9a387) ページにアクセスし、「Acquire」ボタンをクリックして、リクエストに必要な資格情報を取得します：

![](https://cdn.xhuoapi.ai/nyq0xz.png)

まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。

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

## 基本使用

次に、画面上に対応する内容を入力します。以下の図のように：

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

このインターフェースを初めて使用する際には、少なくとも3つの内容を入力する必要があります。一つは `authorization` で、ドロップダウンリストから選択できます。もう一つのパラメータは `model` で、`model` は OpenAI の公式モデルカテゴリを選択するものです。ここでは主に3種類のモデルがあります。詳細は提供されたモデルを参照してください。最後のパラメータは `input` で、`input` は変換する単語ベクトルテキストです。

また、右側には対応する呼び出しコードが生成されていることに注意してください。コードをコピーして直接実行することも、直接「Try」ボタンをクリックしてテストすることもできます。

オプションのパラメータ：

* `dimensions`：ベクトルの次元を切り詰める。デフォルトでは完全な次元を出力します。
* `encoding_format`：返却形式。`float` または `base64` のいずれかを選択できます。

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

Python サンプル呼び出しコード：

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/openai/embeddings"

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

payload = {
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
}

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

呼び出し後、返された結果は以下の通りです：

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.0022756963,
        -0.009305916,
        0.015742613,
        -0.0077253063,
        -0.0047450014,
        0.014917395,
        -0.009807394,
        -0.038264707,
        -0.0069127847,
        -0.028590616,
        0.025251659,
        ....
        -0.014079482,
        -0.015425222,
        0.0040753055,
        0.002727979,
        -0.03138366,
        0.041159317,
        -0.017608874,
        -0.018637223,
        0.014587308,
        0.010486611,
        -0.015387135,
        -0.019424353,
        -0.002800979
      ]
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}
```

返された結果には複数のフィールドがあり、以下のように説明されます：

* `model`、今回のテキストから単語ベクトルに変換するために使用されたモデル。
* `usage`、今回のテキストから単語ベクトルに変換するために使用されたトークン情報。
* `data`、テキスト変換後の単語ベクトル結果。

その中で `data` はテキストに対応する単語ベクトルの具体的な情報を含んでおり、その中の `embedding` は生成された単語ベクトルの具体的な結果です。

## エラー処理

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"
}
```

## 結論

この文書を通じて、OpenAI Embeddings API を使用して公式の OpenAI の単語ベクトル生成機能を簡単に利用する方法を理解しました。この文書が、API の接続と使用をより良くする手助けとなることを願っています。何か問題があれば、いつでも技術サポートチームにお問い合わせください。