Package google.developers.knowledge.v1alpha

Índice

DeveloperKnowledge

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

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

Un caso de uso habitual es utilizar primero DeveloperKnowledge.SearchDocumentChunks para encontrar URIs de páginas relevantes en función de una consulta y, a continuación, usar DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments para obtener el contenido completo de los resultados principales.

Todo el contenido del documento se proporciona en formato Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Obtiene varios documentos, cada uno con su contenido completo de Markdown.

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

rpc GetDocument(GetDocumentRequest) returns (Document)

Obtiene un solo documento con todo su contenido de Markdown.

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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.

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.

BatchGetDocumentsRequest

Mensaje de solicitud de DeveloperKnowledge.BatchGetDocuments.

Campos
names[]

string

Obligatorio. Los nombres de los documentos que se deben obtener. Se pueden recuperar un máximo de 20 documentos en un lote. Los documentos se devuelven en el mismo orden que los names de la solicitud.

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

BatchGetDocumentsResponse

Mensaje de respuesta a DeveloperKnowledge.BatchGetDocuments.

Campos
documents[]

Document

Documentos solicitados.

Documento

Un documento representa un fragmento de contenido del corpus de conocimientos para desarrolladores.

Campos
name

string

Identificador. Nombre de recurso del documento. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

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

string

Solo de salida. El contenido completo del documento en formato Markdown.
description

string

Solo de salida. Descripción del documento.

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.

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.

GetDocumentRequest

Mensaje de solicitud de DeveloperKnowledge.GetDocument.

Campos
name

string

Obligatorio. Nombre del documento que se va a obtener. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Mensaje de solicitud de DeveloperKnowledge.SearchDocumentChunks.

Campos
query

string

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

int32

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

string

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

SearchDocumentChunksResponse

Mensaje de respuesta a DeveloperKnowledge.SearchDocumentChunks.

Campos
results[]

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

string

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