Method: models.embedContent

Генерирует внедрение из модели с учетом входного Content .

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
model

string

Необходимый. Имя ресурса модели. Это служит идентификатором для использования модели.

Это имя должно соответствовать имени модели, возвращаемому методом models.list .

Формат: models/{model}

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Поля
content

object ( Content )

Необходимый. Содержимое для встраивания. Будут учитываться только поля parts.text .

taskType

enum ( TaskType )

Необязательный. Необязательный тип задачи, для которого будут использоваться внедрения. Может быть установлено только для models/embedding-001 .

title

string

Необязательный. Необязательный заголовок текста. Применимо только в том случае, если TaskType имеет значение RETRIEVAL_DOCUMENT .

Примечание. Указание title для RETRIEVAL_DOCUMENT обеспечивает более качественное внедрение при поиске.

outputDimensionality

integer

Необязательный. Необязательный уменьшенный размер для встраивания вывода. Если установлено, лишние значения в выходном внедрении обрезаются с конца. Поддерживается более новыми моделями с 2024 года, а более ранняя модель ( models/embedding-001 ) не может указать это значение.

Тело ответа

Ответ на EmbedContentRequest .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Поля
embedding

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

Для получения дополнительной информации см. Обзор аутентификации .