Method: documents.searchDocumentChunks

Busca información para desarrolladores en la documentación para desarrolladores de Google. Este método devuelve fragmentos de documentos basados en la consulta del usuario. Puede haber muchos fragmentos del mismo documento. Para obtener documentos completos, usa DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments con el DocumentChunk.parent devuelto en SearchDocumentChunksResponse.results.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de consulta

Parámetros
query

string

Obligatorio. La cadena de consulta sin formato proporcionada por el usuario, como "¿Cómo se crea un segmento de Cloud Storage?".
pageSize

integer

Opcional. Número máximo de resultados que se devolverán. Es posible que el servicio devuelva un número inferior a este valor.

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

El valor máximo es 20. Si se usan valores superiores, se producirá un error INVALID_ARGUMENT.
pageToken

string

Opcional. Token de página recibido de una llamada documents.searchDocumentChunks anterior. Proporciona este elemento para obtener la siguiente página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta a DeveloperKnowledge.SearchDocumentChunks.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (DocumentChunk)

Los resultados de búsqueda de la consulta dada. Cada DocumentChunk de esta lista contiene un fragmento de contenido relevante para la consulta de búsqueda. Usa el campo DocumentChunk.parent de cada resultado con DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments para obtener el contenido completo del documento.
nextPageToken

string

Opcional. Token que se puede enviar como pageToken para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

Permisos de autorización

Se necesita el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

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

DocumentChunk

Un DocumentChunk representa un fragmento de contenido de un Document en el corpus DeveloperKnowledge. Para obtener todo el contenido del documento, transfiere parent a DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments.

Representación JSON 
{
  "parent": string,
  "id": string,
  "content": string
}
Campos
parent

string

Solo de salida. Nombre de recurso del documento del que procede este fragmento. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Solo de salida. El ID de este fragmento en el documento. El ID de fragmento es único en 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 de salida. El contenido del fragmento del documento.