Package google.developers.knowledge.v1alpha

Í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, em seguida, 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 o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

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 o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

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. Esse método retorna partes de documentos com base na consulta do usuário. Pode haver muitos trechos do mesmo documento. Para recuperar documentos completos, use DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments com o DocumentChunk.parent retornado no SearchDocumentChunksResponse.results.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

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

BatchGetDocumentsRequest

Mensagem de solicitação para DeveloperKnowledge.BatchGetDocuments.

Campos
names[]

string

Obrigatório. 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

BatchGetDocumentsResponse

Mensagem de resposta para DeveloperKnowledge.BatchGetDocuments.

Campos
documents[]

Document

Documentos solicitados.

Documento

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

Campos
name

string

Identificador. 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. O URI do conteúdo, como docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Apenas saída. O conteúdo completo do documento no formato Markdown.
description

string

Apenas saída. Uma descrição 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. O nome do recurso do documento de origem deste fragmento. Formato: documents/{uri_without_scheme} Exemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Apenas saída. 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. O conteúdo do trecho do documento.

GetDocumentRequest

Mensagem de solicitação para DeveloperKnowledge.GetDocument.

Campos
name

string

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

SearchDocumentChunksRequest

Mensagem de solicitação para DeveloperKnowledge.SearchDocumentChunks.

Campos
query

string

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

int32

Opcional. 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. Um token de página recebido de uma chamada SearchDocumentChunks anterior. Forneça isso para recuperar a página subsequente.

SearchDocumentChunksResponse

Mensagem de resposta para DeveloperKnowledge.SearchDocumentChunks.

Campos
results[]

DocumentChunk

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