Embeddings

テキストをベクトル表現に変換します。セマンティック検索、クラスタリング、分類などに使用します。

エンドポイント


POST https://api.ofox.ai/v1/embeddings

リクエストパラメータ

パラメータ	型	必須	説明
`model`	string	✅	エンベディングモデル（例：`openai/text-embedding-3-small`）
`input`	string \| string[]	✅	変換するテキスト（単一またはバッチ）
`encoding_format`	string	—	出力形式：`float`（デフォルト）または `base64`
`dimensions`	number	—	出力ベクトル次元数（一部のモデルのみ対応）

リクエスト例

cURL

Terminal


curl https://api.ofox.ai/v1/embeddings \
  -H "Authorization: Bearer $OFOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/text-embedding-3-small",
    "input": "OfoxAI は LLM Gateway です"
  }'

Python

embedding.py


from openai import OpenAI
 
client = OpenAI(
    base_url="https://api.ofox.ai/v1",
    api_key="<あなたの OFOXAI_API_KEY>"
)
 
response = client.embeddings.create(
    model="openai/text-embedding-3-small",
    input="OfoxAI は LLM Gateway です"
)
 
embedding = response.data[0].embedding
print(f"ベクトル次元数: {len(embedding)}")

TypeScript

embedding.ts


import OpenAI from 'openai'
 
const client = new OpenAI({
  baseURL: 'https://api.ofox.ai/v1',
  apiKey: '<あなたの OFOXAI_API_KEY>'
})
 
const response = await client.embeddings.create({
  model: 'openai/text-embedding-3-small',
  input: 'OfoxAI は LLM Gateway です'
})
 
console.log(`ベクトル次元数: ${response.data[0].embedding.length}`)

レスポンス形式


{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [0.0023, -0.0091, 0.0156, ...]
    }
  ],
  "model": "openai/text-embedding-3-small",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

利用可能なモデル

モデル	次元数	説明
`openai/text-embedding-3-small`	1536	高コストパフォーマンス
`openai/text-embedding-3-large`	3072	最高精度
`qwen/text-embedding-v4`	1024	中国語最適化、Tongyi Qianwen エンベディングモデル