- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
Executa pesquisa semântica em um Document
.
Solicitação HTTP
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
name |
Obrigatório. O nome do |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{
"query": string,
"resultsCount": integer,
"metadataFilters": [
{
object ( |
Campos | |
---|---|
query |
Obrigatório. String de consulta para realizar a pesquisa semântica. |
resultsCount |
Opcional. O número máximo de Se não for especificado, no máximo 10 |
metadataFilters[] |
Opcional. Filtrar por metadados Observação: a filtragem no nível de Exemplo de consulta: (ano >= 2020 OR ano < 2010) AND (gênero = drama OR gênero = ação) Lista de objetos Exemplo de consulta para um intervalo numérico de valores: (ano > 2015 E ano <= 2020) Lista de objetos Observação: "AND" para a mesma chave são aceitos apenas para valores numéricos. Os valores de string aceitam apenas "OR"s para a mesma chave. |
Corpo da resposta
Resposta de documents.query
contendo uma lista de blocos relevantes.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"relevantChunks": [
{
object ( |
Campos | |
---|---|
relevantChunks[] |
Os blocos relevantes retornados. |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
Para saber mais, consulte a Visão geral da autenticação.