リファレンス: Embeddings | Azure AI Studio

入力テキストを表す埋め込みベクトルを作成します。

POST /embeddings?api-version=2024-04-01-preview

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

承認

Bearer: prefix が付いたトークン (例: Bearer abcde12345)

種類: apiKey 入力: ヘッダー

AADToken

Azure Active Directory OAuth2 認証

種類: oauth2 フロー: アプリケーション トークン URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

例

入力テキストを表す埋め込みベクトルを作成します

サンプル要求

POST /embeddings?api-version=2024-04-01-preview

{
  "input": [
    "This is a very good text"
  ],
  "input_type": "text",
  "encoding_format": "float",
  "dimensions": 1024
}

サンプル応答

状態コード:200

{
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "BERT",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

定義

ContentFilterError

プロンプトが構成どおりにコンテンツ フィルターをトリガーすると、API 呼び出しは失敗します。 プロンプトを変更して、もう一度やり直してください。

CreateEmbeddingRequest

埋め込み作成の要求。

CreateEmbeddingResponse

埋め込み要求からの応答。

詳細

UnprocessableContentError エラーの詳細。

埋め込み

生成された埋め込みを表します。

EmbeddingEncodingFormat

埋め込みを返す形式。 base64、float、int8、uint8、binary、または ubinary のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。

EmbeddingInputType

入力の "種類"。 text、query、または document のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。

EmbeddingObject

ListObject

オブジェクトの種類。常に "list" です。

NotFoundError

TooManyRequestsError

UnauthorizedError

UnprocessableContentError

要求に処理できないコンテンツが含まれています。 指定されたペイロードがこの仕様に従って有効な場合、エラーが返されます。 ただし、ペイロードに示されている命令の一部は、基になるモデルではサポートされていません。 details セクションは、問題のあるパラメーターを理解するために使用します。

使用方法

要求の使用状況に関する情報。