Вложения — это численное представление ввода текста, которое открывает ряд уникальных вариантов использования, таких как кластеризация, измерение сходства и поиск информации. Для ознакомления ознакомьтесь с руководством по встраиванию .
Метод: models.embedContent
Создает вектор внедрения текста из входного Content
используя указанную модель внедрения Gemini .
Конечная точка
опубликуйте https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContentПараметры пути
model
string
Необходимый. Имя ресурса модели. Это служит идентификатором для использования модели.
Это имя должно соответствовать имени модели, возвращаемому методом models.list
.
Формат: models/{model}
Принимает форму models/{model}
.
Тело запроса
Тело запроса содержит данные следующей структуры:
content
object ( Content
)
Необходимый. Содержимое для встраивания. Будут учитываться только поля parts.text
.
taskType
enum ( TaskType
)
Необязательный. Необязательный тип задачи, для которого будут использоваться внедрения. Может быть установлено только для models/embedding-001
.
string
title
Необязательный. Необязательный заголовок текста. Применимо только в том случае, если TaskType имеет значение RETRIEVAL_DOCUMENT
.
Примечание. Указание title
для RETRIEVAL_DOCUMENT
обеспечивает более качественное внедрение при поиске.
integer
outputDimensionality
Необязательный. Необязательный уменьшенный размер для встраивания вывода. Если установлено, лишние значения в выходном внедрении обрезаются с конца. Поддерживается только новыми моделями с 2024 года. Вы не можете установить это значение, если используете более раннюю модель ( models/embedding-001
).
Пример запроса
Питон
Node.js
Оболочка
Тело ответа
Ответ на EmbedContentRequest
.
В случае успеха тело ответа содержит данные следующей структуры:
embedding
object ( ContentEmbedding
)
Только вывод. Встраивание, созданное на основе входного содержимого.
JSON-представление |
---|
{
"embedding": {
object ( |
Метод: models.batchEmbedContents
- Конечная точка
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Пример запроса
- ВстроитьСодержимоеЗапрос
Создает несколько векторов внедрения из входного Content
, которое состоит из пакета строк, представленных как объекты EmbedContentRequest
.
Конечная точка
опубликуйте https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContentsПараметры пути
model
string
Необходимый. Имя ресурса модели. Это служит идентификатором для использования модели.
Это имя должно соответствовать имени модели, возвращаемому методом models.list
.
Формат: models/{model}
Принимает форму models/{model}
.
Тело запроса
Тело запроса содержит данные следующей структуры:
requests[]
object ( EmbedContentRequest
)
Необходимый. Встраивание запросов на пакет. Модель в каждом из этих запросов должна соответствовать модели, указанной BatchEmbedContentsRequest.model
.
Пример запроса
Питон
Node.js
Оболочка
Тело ответа
Ответ на BatchEmbedContentsRequest
.
В случае успеха тело ответа содержит данные следующей структуры:
embeddings[]
object ( ContentEmbedding
)
Только вывод. Внедрения для каждого запроса в том же порядке, который указан в пакетном запросе.
JSON-представление |
---|
{
"embeddings": [
{
object ( |
ВстроитьСодержимоеЗапрос
Запрос, содержащий Content
для встраиваемой модели.
model
string
Необходимый. Имя ресурса модели. Это служит идентификатором для использования модели.
Это имя должно соответствовать имени модели, возвращаемому методом models.list
.
Формат: models/{model}
content
object ( Content
)
Необходимый. Содержимое для встраивания. Будут учитываться только поля parts.text
.
taskType
enum ( TaskType
)
Необязательный. Необязательный тип задачи, для которого будут использоваться внедрения. Может быть установлено только для models/embedding-001
.
string
title
Необязательный. Необязательный заголовок текста. Применимо только в том случае, если TaskType имеет значение RETRIEVAL_DOCUMENT
.
Примечание. Указание title
для RETRIEVAL_DOCUMENT
обеспечивает более качественное внедрение при поиске.
integer
outputDimensionality
Необязательный. Необязательный уменьшенный размер для встраивания вывода. Если установлено, лишние значения в выходном внедрении обрезаются с конца. Поддерживается только новыми моделями с 2024 года. Вы не можете установить это значение, если используете более раннюю модель ( models/embedding-001
).
Встраивание контента
Список чисел с плавающей запятой, представляющих вложение.
values[]
number
Вложенные значения.
JSON-представление |
---|
{ "values": [ number ] } |
Тип задачи
Тип задачи, для которой будет использоваться внедрение.
Перечисления | |
---|---|
TASK_TYPE_UNSPECIFIED | Неустановленное значение, которое по умолчанию будет равно одному из других значений перечисления. |
RETRIEVAL_QUERY | Указывает, что данный текст является запросом в настройках поиска/извлечения. |
RETRIEVAL_DOCUMENT | Указывает, что данный текст является документом из искомого корпуса. |
SEMANTIC_SIMILARITY | Указывает, что данный текст будет использоваться для STS. |
CLASSIFICATION | Указывает, что данный текст будет засекречен. |
CLUSTERING | Указывает, что внедрения будут использоваться для кластеризации. |
QUESTION_ANSWERING | Указывает, что данный текст будет использоваться для ответа на вопрос. |
FACT_VERIFICATION | Указывает, что данный текст будет использоваться для проверки фактов. |