Method: corpora.documents.query

Realiza búsquedas semánticas en un Document.

Solicitud HTTP

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. El nombre de la Document que se consultará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "query": string,
  "resultsCount": integer,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ]
}
Campos
query

string

Obligatorio. Cadena de consulta para realizar una búsqueda semántica.
resultsCount

integer

Opcional. La cantidad máxima de Chunk que se mostrarán. Es posible que el servicio muestre menos Chunk.

Si no se especifican, se mostrarán 10 Chunk como máximo. La cantidad máxima de resultados especificada es 100.
metadataFilters[]

object (MetadataFilter)

Opcional. Filtra los metadatos de Chunk. Cada objeto MetadataFilter debe corresponder a una clave única. Varios objetos MetadataFilter están unidos por "AND" lógicos.

Nota: No se admite el filtrado de nivel Document para esta solicitud porque ya se especificó un nombre Document.

Consulta de ejemplo: (año >= 2020 O año < 2010) AND (género = drama O género = acción)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operations = GREATER_EQUAL}, {int_value = 2010, operations = LESS}}, {key = "chunk.custom_metadata.year" conditions = [{stringValue}operación EQD, EQUAL}}, EQUALValue=“

Consulta de ejemplo para un rango numérico de valores: (año > 2015 Y año <= 2020)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operations = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operations = LESS_EQUAL}]}]

Nota: Los operadores "AND" para la misma clave solo son compatibles con valores numéricos. Los valores de cadena solo admiten "OR" para la misma clave.

Cuerpo de la respuesta

Respuesta de documents.query que contiene una lista de fragmentos relevantes.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
Campos
relevantChunks[]

object (RelevantChunk)

Los fragmentos relevantes que se muestran

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Para obtener más información, consulta Descripción general de la autenticación.