メインコンテンツへスキップ
POST
/
v1
/
embeddings
from openai import OpenAI client = OpenAI( base_url="https://api.cometapi.com/v1", api_key="<COMETAPI_KEY>", ) response = client.embeddings.create( model="text-embedding-3-small", input="The food was delicious and the waiter was friendly.", ) print(response.data[0].embedding[:5]) # First 5 dimensions print(f"Dimensions: {len(response.data[0].embedding)}")
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        -0.0021,
        -0.0491,
        0.0209,
        0.0314,
        -0.0453
      ]
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 2,
    "total_tokens": 2
  }
}

概要

Embeddings API は、意味的な情報を捉えるテキストのベクトル表現を生成します。これらのベクトルは、セマンティック検索、クラスタリング、分類、異常検知、検索拡張生成(RAG)に利用できます。 CometAPI は複数のプロバイダーのエンベディングモデルをサポートしています。1 つ以上のテキスト文字列を渡すと、ベクトルデータが返されます。これをベクターデータベースに保存したり、類似度計算に直接使用したりできます。

利用可能なモデル

ModelDimensionsMax TokensBest For
text-embedding-3-large3,072(調整可能)8,191最高品質のエンベディング
text-embedding-3-small1,536(調整可能)8,191低コストで高速
text-embedding-ada-0021,536(固定)8,191レガシー互換性
利用可能なすべてのエンベディングモデルと価格については、model list を参照してください。

重要な注意事項

次元数の削減text-embedding-3-* モデルは dimensions パラメーターをサポートしており、精度を大きく損なうことなくエンベディングベクトルを短縮できます。これにより、意味情報の大部分を維持したまま、ストレージコストを最大 75% 削減できます。
バッチ入力input パラメーターに文字列の配列を渡すことで、1 回のリクエストで複数のテキストをエンベディングできます。これは、各テキストごとに個別のリクエストを行うよりも大幅に効率的です。

承認

Authorization
string
header
必須

Bearer token authentication. Use your CometAPI key.

ボディ

application/json
model
string
必須

The embedding model to use. See the Models page for current embedding model IDs.

:

"text-embedding-3-small"

input
必須

The text to embed. Can be a single string, an array of strings, or an array of token arrays. Each input must not exceed the model's maximum token limit (8,191 tokens for text-embedding-3-* models).

encoding_format
enum<string>
デフォルト:float

The format of the returned embedding vectors. float returns an array of floating-point numbers. base64 returns a base64-encoded string representation, which can reduce response size for large batches.

利用可能なオプション:
float,
base64
dimensions
integer

The number of dimensions for the output embedding vector. Only supported by text-embedding-3-* models. Reducing dimensions can lower storage costs while maintaining most of the embedding's utility.

必須範囲: x >= 1
user
string

A unique identifier for your end-user, which can help monitor and detect abuse.

レスポンス

200 - application/json

A list of embedding vectors for the input text(s).

object
enum<string>

The object type, always list.

利用可能なオプション:
list
:

"list"

data
object[]

An array of embedding objects, one per input text. When multiple inputs are provided, results are returned in the same order as the input.

model
string

The model used to generate the embeddings.

:

"text-embedding-3-small"

usage
object

Token usage statistics for this request.