Method: documents.searchDocumentChunks

Busca conocimiento para desarrolladores en la documentación para desarrolladores de Google. Devuelve DocumentChunks según la búsqueda del usuario. Puede haber muchos fragmentos del mismo Document. Para recuperar documentos completos, usa DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments con el DocumentChunk.parent que se devolvió en SearchDocumentChunksResponse.results.

Solicitud HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

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

Parámetros de consulta

Parámetros
query

string

Obligatorio. Proporciona la cadena de consulta sin procesar que proporcionó el usuario, como "¿Cómo crear un bucket de Cloud Storage?".
pageSize

integer

Opcional. Especifica la cantidad máxima de resultados que se devolverán. El servicio puede mostrar menos que este valor.

Si no se especifica, se devolverán, como máximo, 5 resultados.

El valor máximo es 100, y aquellos que superen esta cifra se convertirán a 100.
pageToken

string

Opcional. Contiene un token de página, recibido desde una llamada a documents.searchDocumentChunks anterior. Proporciona esto para recuperar la página siguiente.
filter

string

Opcional. Aplica un filtro estricto a los resultados de la búsqueda. La expresión admite un subconjunto de la sintaxis que se describe en https://google.aip.dev/160.

Si bien documents.searchDocumentChunks devuelve DocumentChunks, el filtro se aplica a los campos DocumentChunk.document.

Campos admitidos para el filtrado:

  • contentLengthBytes (INTEGER): Es la longitud del campo Document.content en bytes.
  • dataSource (STRING): Es la fuente del documento, p.ej., docs.cloud.google.com. Consulta https://developers.google.com/knowledge/reference/corpus-reference para ver la lista completa de fuentes de datos del corpus.
  • updateTime (TIMESTAMP): Es la marca de tiempo de la última vez que se actualizó el documento de forma significativa. Una actualización significativa es aquella que cambia el contenido de Markdown o los metadatos del documento.
  • uri (STRING): Es el URI del documento, p.ej., https://docs.cloud.google.com/bigquery/docs/tables.

Los campos INTEGER admiten los operadores =, <, <=, > y >=.

Los campos STRING admiten los operadores = (igual a) y != (no igual a) para la concordancia exacta en toda la cadena. No se admiten la coincidencia parcial, la coincidencia de prefijo ni la coincidencia de regex.

Los campos TIMESTAMP admiten los operadores =, <, <=, > y >=. Las marcas de tiempo deben estar en formato RFC-3339, p.ej., "2025-01-01T00:00:00Z".

Puedes combinar expresiones con los operadores lógicos AND, OR y NOT (o -). OR tiene mayor prioridad que AND. Usa paréntesis para agrupar la precedencia de forma explícita.

Ejemplos:

  • Filtrar por Document.content_length_bytes: contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

La cadena filter no debe superar los 500 caracteres. Los valores que superen este límite generarán un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para DeveloperKnowledge.SearchDocumentChunks.

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

Representación JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Campos
results[]

object (DocumentChunk)

Contiene los resultados de la búsqueda para la consulta determinada. Cada DocumentChunk de esta lista contiene un fragmento de contenido pertinente para la búsqueda. Usa el campo DocumentChunk.parent de cada resultado con DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments para recuperar el contenido completo del documento.
nextPageToken

string

Opcional. Proporciona un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta OAuth 2.0 Overview.