Method: models.embedText

入力メッセージを与えられて、モデルからエンベディングを生成します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
model

string

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

リクエスト本文

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

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

string

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

レスポンスの本文

EmbedTextRequest に対するレスポンス。

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

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

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

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