メインコンテンツへスキップ
POST
/
openai
/
v1
/
embeddings
埋め込みベクトルの作成
curl --request POST \
  --url https://api.highwayapi.ai/openai/v1/embeddings \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "input": [
    "<string>"
  ],
  "model": "<string>",
  "encoding_format": "<string>"
}
'
{
  "object": "<string>",
  "data": [
    {
      "index": 123,
      "embedding": [
        {}
      ],
      "object": "<string>"
    }
  ],
  "model": "<string>",
  "usage": {
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}
入力テキストを表す埋め込みベクトルを作成します。

リクエストヘッダー

Content-Type
string
必須
列挙値: application/json
Authorization
string
必須
Bearer 認証形式: Bearer {{API Key}}。

リクエストボディ

input
string[]
必須
埋め込む入力テキスト。文字列または token 配列としてエンコードされます。単一のリクエストで複数の入力を埋め込むには、文字列配列または token 配列を渡します。入力はモデルの最大入力 token(text-embedding-ada-002 では 8192 tokens)を超えてはならず、空文字列にはできません。また、いかなる配列の次元も 2048 以下である必要があります。
model
string
必須
使用するモデル ID。列挙値:
  • baai/bge-m3
encoding_format
string
返される埋め込みベクトルの形式。float または base64 を指定できます。

レスポンス情報

object
string
必須
常に list
data
array
必須
モデルによって生成された埋め込みベクトルの一覧。
model
string
必須
使用されたモデル ID。
usage
object
必須
使用状況情報。