Method: models.batchEmbedText

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

HTTP リクエスト

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedText

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

パスパラメータ

パラメータ
model

string

必須。エンベディングの生成に使用する Model の名前。例: models/embedding-gecko-001

リクエスト本文

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

JSON 表現 
{
  "texts": [
    string
  ],
  "requests": [
    {
      object (EmbedTextRequest)
    }
  ]
}
フィールド
texts[]

string

（省略可）モデルがエンベディングに変換する自由形式の入力テキスト。現在の上限は 100 テキストで、これを超えるとエラーがスローされます。
requests[]

object (EmbedTextRequest)

（省略可）バッチの埋め込みリクエスト。texts または requests のいずれか 1 つのみを設定できます。

レスポンスの本文

EmbedTextRequest に対するレスポンス。

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

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

object (Embedding)

出力のみ。入力テキストから生成されたエンベディング。

認可スコープ

次の 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

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

EmbedTextRequest

モデルからテキスト エンベディングを取得するリクエスト。

JSON 表現 
{
  "model": string,
  "text": string
}
フィールド
model

string

必須。使用するモデル名を model=models/{model} の形式で指定します。
text

string

（省略可）モデルがエンベディングに変換する自由形式の入力テキスト。