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 usar primero 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.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Responde una búsqueda con generación fundamentada.

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

Respuesta

Es la respuesta a una búsqueda.

Campos
answer_text

string

Contiene el texto de la respuesta.
citations[]

AnswerCitation

Solo salida. Contiene citas para la respuesta.
references[]

AnswerReference

Solo salida. Contiene referencias para la respuesta.

AnswerCitation

Es la información de la cita de un segmento.

Campos
start_index

int32

Solo salida. Indica el inicio del segmento, medido en bytes (Unicode UTF-8), inclusive. Si hay caracteres multibyte, como caracteres no ASCII, la medición del índice es más larga que la longitud de la cadena.
end_index

int32

Solo salida. Indica el final del segmento, medido en bytes (Unicode UTF-8), exclusivo. Si hay caracteres multibyte, como caracteres no ASCII, la medición del índice es más larga que la longitud de la cadena.
sources[]

CitationSource

Solo salida. Contiene las fuentes de citas del segmento atribuido.

AnswerReference

Representa una referencia a una fuente.

Campos
Campo de unión content. Contiene el contenido de la referencia. content puede ser solo uno de los parámetros siguientes:
document_reference

DocumentReference

Solo salida. Es el documento de referencia.

CitationSource

Es la fuente de la cita.

Campos
reference_index

int32

Solo salida. Contiene el índice de Answer.AnswerReference en el campo repetido references.

DocumentReference

Representa una referencia a un documento.

Campos
document_chunk

DocumentChunk

Solo salida. Contiene el fragmento del documento. El campo document_chunk.id no está configurado y estará vacío.

AnswerQueryRequest

Mensaje de solicitud para DeveloperKnowledge.AnswerQuery.

Campos
query

string

Obligatorio. Es la búsqueda para responder.

AnswerQueryResponse

Mensaje de respuesta para DeveloperKnowledge.AnswerQuery.

Campos
answer

Answer

Es la respuesta a la búsqueda.

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
view

DocumentView

Opcional. Especifica el DocumentView del documento. Si no se especifica, el valor predeterminado de DeveloperKnowledge.BatchGetDocuments es DOCUMENT_VIEW_CONTENT.

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 del desarrollador.

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

string

Solo salida. Especifica la fuente de datos del documento. Fuente de datos de ejemplo: firebase.google.com
title

string

Solo salida. Proporciona el título del documento.
update_time

Timestamp

Solo salida. Representa la marca de tiempo de la última actualización del contenido o los metadatos del documento.
view

DocumentView

Solo salida. Especifica el DocumentView 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.
document

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 tengan que 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.

DocumentView

Especifica qué campos del Document se incluyen.

Enums
DOCUMENT_VIEW_UNSPECIFIED Es el valor predeterminado o no establecido. Consulta el valor predeterminado de cada método de la API si no se especifica DocumentView.
DOCUMENT_VIEW_BASIC

Solo incluye los campos de metadatos básicos: - name - uri - data_source - title - description - update_time - view

Esta es la vista predeterminada de DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Incluye todos los campos de Document.
DOCUMENT_VIEW_CONTENT

Incluye los campos DOCUMENT_VIEW_BASIC y el campo content.

Esta es la vista predeterminada de DeveloperKnowledge.GetDocument y DeveloperKnowledge.BatchGetDocuments.

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
view

DocumentView

Opcional. Especifica el DocumentView del documento. Si no se especifica, el valor predeterminado de DeveloperKnowledge.GetDocument es DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

Mensaje de solicitud para DeveloperKnowledge.SearchDocumentChunks.

Campos
query

string

Obligatorio. Proporciona la cadena de consulta sin procesar que proporcionó 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.
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 SearchDocumentChunks devuelve DocumentChunks, el filtro se aplica a los campos DocumentChunk.document.

Campos admitidos para el filtrado:

  • data_source (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.
  • update_time (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 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:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "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.

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.