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 búsqueda sin procesar que ingresó 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 20. Los valores superiores a 20 generarán un error INVALID_ARGUMENT.
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:

  • 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 actualización significativa del documento. 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 STRING admiten los operadores = (igual a) y != (no igual a) para la coincidencia 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:

  • 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.

DocumentChunk

Un DocumentChunk representa una parte del contenido de un Document en el corpus de DeveloperKnowledge. Para recuperar todo el contenido del documento, pasa parent a DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments.

Representación JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Campos
parent

string

Solo salida. Contiene el nombre del recurso del documento del que proviene este fragmento. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Solo salida. Especifica el ID de este fragmento dentro del documento. El ID de fragmento es único dentro de un documento, pero no es único a nivel global en todos los documentos. El ID de fragmento no es estable y puede cambiar con el tiempo.
content

string

Solo salida. Contiene el contenido del fragmento del documento.
document

object (Document)

Solo salida. Representa los metadatos sobre el Document del que proviene este fragmento. El DocumentView de este mensaje de Document se establecerá en DOCUMENT_VIEW_BASIC. Se incluye aquí para mayor comodidad, de modo que los clientes no necesiten llamar a DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments si solo necesitan los campos de metadatos. De lo contrario, los clientes deben usar DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments para recuperar el contenido completo del documento.