Package google.developers.knowledge.v1alpha

Índice

DeveloperKnowledge

La API de Developer Knowledge proporciona acceso programático a la documentación pública para desarrolladores de Google, lo que te permite integrar esta base de conocimiento en tus propias aplicaciones y flujos de trabajo.

La API está diseñada para ser la fuente canónica de acceso legible por máquina a la documentación para desarrolladores de Google.

Un caso de uso típico es primero usar DeveloperKnowledge.SearchDocumentChunks para encontrar URIs de páginas relevantes según una búsqueda y, luego, usar DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments para recuperar el contenido completo de los resultados principales.

Todo el contenido del documento se proporciona en formato Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Recupera varios documentos, cada uno con su contenido completo en Markdown.

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

rpc GetDocument(GetDocumentRequest) returns (Document)

Recupera un solo documento con su contenido completo en Markdown.

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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.

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.

BatchGetDocumentsRequest

Mensaje de solicitud para DeveloperKnowledge.BatchGetDocuments.

Campos
names[]

string

Obligatorio. Especifica los nombres de los documentos que se recuperarán. Se puede recuperar un máximo de 20 documentos en un lote. Los documentos se muestran en el mismo orden que los names en la solicitud.

Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets

BatchGetDocumentsResponse

Mensaje de respuesta para DeveloperKnowledge.BatchGetDocuments.

Campos
documents[]

Document

Contiene los documentos solicitados.

Documento

Un Document representa una parte del contenido del corpus de conocimiento para desarrolladores.

Campos
name

string

Es el identificador. Contiene el nombre del recurso del documento. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Solo salida. Proporciona el URI del contenido, como docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Solo salida. Contiene el contenido completo del documento en formato Markdown.
description

string

Solo salida. Proporciona una descripción del documento.
title

string

Solo salida. Proporciona el título del documento.

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.

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.

GetDocumentRequest

Mensaje de solicitud para DeveloperKnowledge.GetDocument.

Campos
name

string

Obligatorio. Especifica el nombre del documento que se recuperará. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Mensaje de solicitud para DeveloperKnowledge.SearchDocumentChunks.

Campos
query

string

Obligatorio. Proporciona la cadena de búsqueda sin procesar que ingresó el usuario, como "¿Cómo crear un bucket de Cloud Storage?".
page_size

int32

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

string

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

SearchDocumentChunksResponse

Mensaje de respuesta para DeveloperKnowledge.SearchDocumentChunks.

Campos
results[]

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

string

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