Método: models.embedContent
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Gera um embedding do modelo que recebe um Content
de entrada.
Endpoint
postar
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent
Parâmetros de caminho
model
string
Obrigatório. O nome do recurso do modelo. Isso serve como um ID a ser usado pelo modelo.
Esse nome precisa corresponder a um nome de modelo retornado pelo método models.list
.
Formato: models/{model}
. Ele assume o formato models/{model}
.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
content
object (Content
)
Obrigatório. O conteúdo a ser incorporado. Somente os campos parts.text
serão contados.
taskType
enum (TaskType
)
Opcional. Tipo de tarefa opcional em que os embeddings serão usados. Só pode ser definido para models/embedding-001
.
title
string
Opcional. Um título opcional para o texto. Aplicável apenas quando o Tipo de tarefa é RETRIEVAL_DOCUMENT
.
Observação: especificar um title
para RETRIEVAL_DOCUMENT
fornece embeddings de melhor qualidade para recuperação.
outputDimensionality
integer
Opcional. Dimensão reduzida opcional para o embedding de saída. Se definido, os valores excessivos na incorporação de saída serão truncados no final. Compatível com modelos mais recentes desde 2024, e o modelo anterior (models/embedding-001
) não pode especificar esse valor.
Exemplo de solicitação
Python
Node.js
Corpo da resposta
A resposta a um EmbedContentRequest
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
embedding
object (ContentEmbedding
)
Apenas saída. O embedding gerado a partir do conteúdo de entrada.
Representação JSON |
---|
{
"embedding": {
object ( |
Método: models.batchEmbedContents
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
- EmbedContentRequest
Gera vários embeddings do modelo com base no texto de entrada fornecido em uma chamada síncrona.
Endpoint
postar
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents
Parâmetros de caminho
model
string
Obrigatório. O nome do recurso do modelo. Isso serve como um ID a ser usado pelo modelo.
Esse nome precisa corresponder a um nome de modelo retornado pelo método models.list
.
Formato: models/{model}
. Ele assume o formato models/{model}
.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
requests[]
object (EmbedContentRequest
)
Obrigatório. Incorpore solicitações para o lote. O modelo em cada uma dessas solicitações precisa corresponder ao modelo especificado BatchEmbedContentsRequest.model
.
Exemplo de solicitação
Python
Node.js
Corpo da resposta
A resposta a um BatchEmbedContentsRequest
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
embeddings[]
object (ContentEmbedding
)
Apenas saída. Os embeddings de cada solicitação, na mesma ordem informada na solicitação em lote.
Representação JSON |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
Solicitação contendo o Content
do modelo a ser incorporado.
Representação JSON |
---|
{ "model": string, "content": { object ( |
model
string
Obrigatório. O nome do recurso do modelo. Isso serve como um ID a ser usado pelo modelo.
Esse nome precisa corresponder a um nome de modelo retornado pelo método models.list
.
Formato: models/{model}
content
object (Content
)
Obrigatório. O conteúdo a ser incorporado. Somente os campos parts.text
serão contados.
taskType
enum (TaskType
)
Opcional. Tipo de tarefa opcional em que os embeddings serão usados. Só pode ser definido para models/embedding-001
.
title
string
Opcional. Um título opcional para o texto. Aplicável apenas quando o Tipo de tarefa é RETRIEVAL_DOCUMENT
.
Observação: especificar um title
para RETRIEVAL_DOCUMENT
fornece embeddings de melhor qualidade para recuperação.
outputDimensionality
integer
Opcional. Dimensão reduzida opcional para o embedding de saída. Se definido, os valores excessivos na incorporação de saída serão truncados no final. Compatível com modelos mais recentes desde 2024, e o modelo anterior (models/embedding-001
) não pode especificar esse valor.
ContentEmbedding
Uma lista de pontos flutuantes que representam um embedding.
Representação JSON |
---|
{ "values": [ number ] } |
values[]
number
Os valores de embedding.
TaskType
Tipo de tarefa em que o embedding vai ser usado.
Enums | |
---|---|
TASK_TYPE_UNSPECIFIED |
Valor não definido, que será padronizado para um dos outros valores de tipo enumerado. |
RETRIEVAL_QUERY |
Especifica que o texto é uma consulta em uma configuração de pesquisa/recuperação. |
RETRIEVAL_DOCUMENT |
Especifica que o texto fornecido é um documento do corpus que está sendo pesquisado. |
SEMANTIC_SIMILARITY |
Especifica o texto fornecido que será usado para STS. |
CLASSIFICATION |
Especifica que o texto fornecido será classificado. |
CLUSTERING |
Especifica que os embeddings serão usados para clustering. |
QUESTION_ANSWERING |
Especifica que o texto fornecido será usado para responder a perguntas. |
FACT_VERIFICATION |
Especifica que o texto fornecido será usado para a verificação de fatos. |