Package google.developers.knowledge.v1alpha

Índice

DeveloperKnowledge

La API de Developer Knowledge proporciona acceso programático a la documentación para desarrolladores pública 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áquinas a la documentación para desarrolladores de Google.

Un caso de uso típico es usar primero DeveloperKnowledge.SearchDocumentChunks para encontrar fragmentos de documentos relevantes en función de una consulta y, luego, usar DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments con nombres de recursos de documentos (como DocumentChunk.parent o documents/{uri_without_scheme}) 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 consulta 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/developerprofiles.readonly
  • 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/developerprofiles.readonly
  • 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 todo su contenido de 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/developerprofiles.readonly
  • 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 conocimientos para desarrolladores en la documentación para desarrolladores de Google. Devuelve DocumentChunk según la consulta 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 muestra en el 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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

Respuesta

Es una respuesta a una consulta.

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

Información de 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 de varios bytes, como caracteres que no son 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 de varios bytes, como caracteres que no son ASCII, la medición del índice es más larga que la longitud de la cadena.
sources[]

CitationSource

Solo salida. Contiene fuentes de citas para el 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 consulta que se debe responder.
filter

string

Opcional. Aplica un filtro estricto a los resultados de la búsqueda que se usan para fundamentar la respuesta. La expresión admite un subconjunto de la sintaxis descrita en https://google.aip.dev/160.

Campos admitidos para el filtrado:

  • content_length_bytes (INTEGER): Es la longitud del campo Document.content en bytes.
  • 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 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 INTEGER admiten los operadores =, <, <=, > y >=.

Los campos STRING admiten los operadores = (igual a) y != (no igual a) para la coincidencia exacta en toda la cadena. No se admiten las coincidencias parciales, de prefijo ni 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 la agrupación de precedencia explícita.

Ejemplos:

  • Filtrar por Document.content_length_bytes: content_length_bytes < 50000
  • 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 los 500 caracteres generarán un error INVALID_ARGUMENT.

AnswerQueryResponse

Mensaje de respuesta para DeveloperKnowledge.AnswerQuery.

Campos
answer

Answer

Es la respuesta a la consulta.

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

Cada nombre no debe superar los 500 caracteres. Los valores que superen los 500 caracteres generarán un error INVALID_ARGUMENT.
view

DocumentView

Opcional. Especifica el DocumentView del documento. Si no se especifica, DeveloperKnowledge.BatchGetDocuments se establece de forma predeterminada como DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Mensaje de respuesta para DeveloperKnowledge.BatchGetDocuments.

Campos
documents[]

Document

Contiene los documentos solicitados.

Documento

Un documento representa una página de documentación en el corpus de conocimiento para desarrolladores, como la página en https://docs.cloud.google.com/storage/docs/creating-buckets.

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 https://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.
content_length_bytes

int32

Solo salida. Es la longitud del campo content en bytes.

DocumentChunk

Un DocumentChunk representa un fragmento de contenido de un Document en el corpus de DeveloperKnowledge. Para recuperar todo el contenido del documento, pasa el 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 del fragmento es único dentro de un documento, pero no es único a nivel global en todos los documentos. El ID del 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í por conveniencia, 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.
relevance_score

double

Solo salida. Representa la puntuación de relevancia del fragmento para la búsqueda. Una puntuación más alta indica una mayor relevancia del fragmento. La puntuación está en el rango [0.0, 1.0].

DocumentView

Especifica qué campos de Document se incluyen.

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

Incluye solo los campos de metadatos básicos:

  • name
  • uri
  • data_source
  • title
  • description
  • update_time
  • view
  • content_length_bytes

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

Incluye los campos DOCUMENT_VIEW_BASIC y el campo content.

Esta es la vista predeterminada para 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

El nombre no debe superar los 500 caracteres. Los valores que superen los 500 caracteres generarán un error INVALID_ARGUMENT.
view

DocumentView

Opcional. Especifica el DocumentView del documento. Si no se especifica, DeveloperKnowledge.GetDocument se establece de forma predeterminada como DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

Mensaje de solicitud para DeveloperKnowledge.SearchDocumentChunks.

Campos
query

string

Obligatorio. Proporciona la cadena de consulta sin procesar que proporciona el usuario, como "¿Cómo crear un bucket de Cloud Storage?". La consulta no debe superar los 500 caracteres. Los valores que superen los 500 caracteres generarán un error INVALID_ARGUMENT.
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 100; los valores superiores a 100 se convertirán en 100.
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 descrita en https://google.aip.dev/160.

Mientras que SearchDocumentChunks devuelve DocumentChunk, el filtro se aplica a los campos DocumentChunk.document.

Campos admitidos para el filtrado:

  • content_length_bytes (INTEGER): Es la longitud del campo Document.content en bytes.
  • 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 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 INTEGER admiten los operadores =, <, <=, > y >=.

Los campos STRING admiten los operadores = (igual a) y != (no igual a) para la coincidencia exacta en toda la cadena. No se admiten las coincidencias parciales, de prefijo ni 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".

Nota: Los nombres de los campos deben estar en snake_case (p.ej., data_source). Los valores del lado derecho de las expresiones de filtrado deben ser literales de cadena entre comillas dobles (p.ej., "docs.cloud.google.com").

Puedes combinar expresiones con los operadores lógicos AND, OR y NOT (o -). OR tiene mayor prioridad que AND. Usa paréntesis para la agrupación de precedencia explícita.

Ejemplos:

  • Filtrar por Document.content_length_bytes: content_length_bytes < 50000
  • 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 los 500 caracteres 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 proporcionada. Cada DocumentChunk de esta lista contiene un fragmento de contenido relevante 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

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.