Method: models.batchEmbedContents

入力テキストを指定して、同期呼び出しでモデルから複数のエンベディングを生成します。

HTTP リクエスト

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:batchEmbedContents

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
model

string

必須。モデルのリソース名。これは、使用するモデルの ID として機能します。

この名前は、models.list メソッドから返されるモデル名と一致する必要があります。

形式: models/{model}

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requests": [
    {
      object (EmbedContentRequest)
    }
  ]
}
フィールド
requests[]

object (EmbedContentRequest)

必須。バッチの埋め込みリクエスト。これらの各リクエストのモデルは、指定された BatchEmbedContentsRequest.model モデルと一致する必要があります。

レスポンスの本文

BatchEmbedContentsRequest に対するレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "embeddings": [
    {
      object (ContentEmbedding)
    }
  ]
}
フィールド
embeddings[]

object (ContentEmbedding)

出力専用。各リクエストのエンベディング。バッチ リクエストで指定した順序と同じ順序です。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

詳細については、認証の概要をご覧ください。

EmbedContentRequest

埋め込むモデルの Content を含むリクエスト。

JSON 表現 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
フィールド
model

string

必須。モデルのリソース名。これは、使用するモデルの ID として機能します。

この名前は、models.list メソッドから返されるモデル名と一致する必要があります。

形式: models/{model}
content

object (Content)

必須。埋め込むコンテンツ。parts.text フィールドのみがカウントされます。
taskType

enum (TaskType)

省略可。エンベディングが使用されるオプションのタスクタイプ。models/embedding-001 に対してのみ設定できます。
title

string

省略可。テキストのタイトル（省略可）。TaskType が RETRIEVAL_DOCUMENT の場合にのみ適用されます。

注: RETRIEVAL_DOCUMENT に title を指定すると、取得のためのエンベディングの品質が向上します。
outputDimensionality

integer

省略可。出力エンベディングのオプションの縮小ディメンション。設定した場合、出力埋め込みで過剰な値が末尾から切り捨てられます。2024 年以降の新しいモデルでサポートされています。以前のモデル（models/embedding-001）ではこの値を指定できません。