Package google.developers.knowledge.v1

Índice

DeveloperKnowledge

A API Developer Knowledge oferece acesso programático à documentação pública para desenvolvedores do Google, permitindo que você integre essa base de conhecimento aos seus próprios aplicativos e fluxos de trabalho.

A API foi projetada para ser a fonte canônica de acesso legível por máquina à documentação para desenvolvedores do Google.

Um caso de uso típico é primeiro usar DeveloperKnowledge.SearchDocumentChunks para encontrar URIs de página relevantes com base em uma consulta e depois usar DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments para buscar o conteúdo completo dos principais resultados.

Todo o conteúdo do documento é fornecido no formato Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Recupera vários documentos, cada um com todo o conteúdo em Markdown.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte OAuth 2.0 Overview.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Recupera um único documento com todo o conteúdo em Markdown.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte OAuth 2.0 Overview.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Pesquisa conhecimento para desenvolvedores na documentação do Google para desenvolvedores. Retorna DocumentChunks com base na consulta do usuário. Pode haver vários blocos do mesmo Document. Para recuperar documentos completos, use DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments com o DocumentChunk.parent retornado no SearchDocumentChunksResponse.results.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte OAuth 2.0 Overview.

BatchGetDocumentsRequest

Mensagem de solicitação para DeveloperKnowledge.BatchGetDocuments.

Campos
names[]

string

Obrigatório. Especifica os nomes dos documentos a serem recuperados. É possível recuperar no máximo 20 documentos em um lote. Os documentos são retornados na mesma ordem do names na solicitação.

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

DocumentView

Opcional. Especifica o DocumentView do documento. Se não for especificado, DeveloperKnowledge.BatchGetDocuments será usado como padrão para DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Mensagem de resposta para DeveloperKnowledge.BatchGetDocuments.

Campos
documents[]

Document

Contém os documentos solicitados.

Documento

Um documento representa uma parte do conteúdo do corpus de conhecimento do desenvolvedor.

Campos
name

string

Identificador. Contém o nome do recurso do documento. Formato: documents/{uri_without_scheme} Exemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Apenas saída. Fornece o URI do conteúdo, como docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Apenas saída. Contém todo o conteúdo do documento no formato Markdown.
description

string

Apenas saída. Fornece uma descrição do documento.
data_source

string

Apenas saída. Especifica a fonte de dados do documento. Exemplo de fonte de dados: firebase.google.com
title

string

Apenas saída. Fornece o título do documento.
update_time

Timestamp

Apenas saída. Representa o carimbo de data/hora da última atualização do conteúdo ou dos metadados do documento.
view

DocumentView

Apenas saída. Especifica o DocumentView do documento.

DocumentChunk

Um DocumentChunk representa uma parte do conteúdo de um Document no corpus DeveloperKnowledge. Para buscar todo o conteúdo do documento, transmita parent para DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments.

Campos
parent

string

Apenas saída. Contém o nome do recurso do documento de origem do trecho. Formato: documents/{uri_without_scheme} Exemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Apenas saída. Especifica o ID deste trecho no documento. O ID do fragmento é exclusivo em um documento, mas não globalmente em todos os documentos. O ID do bloco não é estável e pode mudar com o tempo.
content

string

Apenas saída. Contém o conteúdo do trecho do documento.
document

Document

Apenas saída. Representa metadados sobre o Document de origem deste trecho. O DocumentView desta mensagem Document será definido como DOCUMENT_VIEW_BASIC. Ele é incluído aqui por conveniência para que os clientes não precisem chamar DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments se precisarem apenas dos campos de metadados. Caso contrário, os clientes precisam usar DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments para buscar o conteúdo completo do documento.

DocumentView

Especifica quais campos do Document estão incluídos.

Tipos enumerados
DOCUMENT_VIEW_UNSPECIFIED O valor padrão / não definido. Consulte cada método de API para saber o valor padrão se DocumentView não for especificado.
DOCUMENT_VIEW_BASIC

Inclui apenas os campos de metadados básicos: - name - uri - data_source - title - description - update_time - view

Essa é a visualização padrão do DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Inclui todos os campos Document.
DOCUMENT_VIEW_CONTENT

Inclui os campos DOCUMENT_VIEW_BASIC e content.

Essa é a visualização padrão para DeveloperKnowledge.GetDocument e DeveloperKnowledge.BatchGetDocuments.

GetDocumentRequest

Mensagem de solicitação para DeveloperKnowledge.GetDocument.

Campos
name

string

Obrigatório. Especifica o nome do documento a ser recuperado. Formato: documents/{uri_without_scheme} Exemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

Opcional. Especifica o DocumentView do documento. Se não for especificado, DeveloperKnowledge.GetDocument será usado como padrão para DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

Mensagem de solicitação para DeveloperKnowledge.SearchDocumentChunks.

Campos
query

string

Obrigatório. Fornece a string de consulta bruta fornecida pelo usuário, como "Como criar um bucket do Cloud Storage?".
page_size

int32

Opcional. Especifica o número máximo de resultados a serem retornados. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo cinco resultados serão retornados.

O valor máximo é 20. Valores acima de 20 vão resultar em um erro INVALID_ARGUMENT.
page_token

string

Opcional. Contém um token de página recebido de uma chamada SearchDocumentChunks anterior. Forneça isso para recuperar a página subsequente.
filter

string

Opcional. Aplica um filtro restrito aos resultados da pesquisa. A expressão é compatível com um subconjunto da sintaxe descrita em https://google.aip.dev/160.

Embora SearchDocumentChunks retorne DocumentChunks, o filtro é aplicado aos campos DocumentChunk.document.

Campos compatíveis com a filtragem:

  • data_source (STRING): a origem do documento, por exemplo, docs.cloud.google.com. Consulte https://developers.google.com/knowledge/reference/corpus-reference para conferir a lista completa de fontes de dados no corpus.
  • update_time (TIMESTAMP): o carimbo de data/hora da última atualização significativa do documento. Uma atualização significativa é aquela que muda o conteúdo ou os metadados do documento em Markdown.
  • uri (STRING): o URI do documento, por exemplo, https://docs.cloud.google.com/bigquery/docs/tables.

Os campos STRING são compatíveis com os operadores = (igual a) e != (diferente de) para correspondência exata em toda a string. Não há suporte para correspondência parcial, de prefixo e de regexp.

Os campos TIMESTAMP são compatíveis com os operadores =, <, <=, > e >=. Os carimbos de data/hora precisam estar no formato RFC-3339, por exemplo, "2025-01-01T00:00:00Z".

É possível combinar expressões usando os operadores lógicos AND, OR e NOT (ou -). OR tem maior precedência do que AND. Use parênteses para agrupar a precedência de forma explícita.

Exemplos:

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

A string filter não pode exceder 500 caracteres. Valores maiores que isso resultam em um erro INVALID_ARGUMENT.

SearchDocumentChunksResponse

Mensagem de resposta para DeveloperKnowledge.SearchDocumentChunks.

Campos
results[]

DocumentChunk

Contém os resultados da pesquisa para a consulta especificada. Cada DocumentChunk nessa lista contém um snippet de conteúdo relevante para a consulta de pesquisa. Use o campo DocumentChunk.parent de cada resultado com DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments para recuperar o conteúdo completo do documento.
next_page_token

string

Opcional. Fornece um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.