Package google.developers.knowledge.v1alpha

Indice

DeveloperKnowledge

L'API Developer Knowledge fornisce accesso programmatico alla documentazione per sviluppatori pubblica di Google, consentendoti di integrare questa knowledge base nelle tue applicazioni e nei tuoi flussi di lavoro.

L'API è progettata per essere la fonte canonica per l'accesso leggibile dalla macchina alla documentazione per gli sviluppatori di Google.

Un caso d'uso tipico è utilizzare prima DeveloperKnowledge.SearchDocumentChunks per trovare URI di pagine pertinenti in base a una query, quindi utilizzare DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments per recuperare i contenuti completi dei primi risultati.

Tutti i contenuti del documento sono forniti in formato Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Recupera più documenti, ognuno con il proprio contenuto Markdown completo.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Recupera un singolo documento con tutti i suoi contenuti Markdown.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Cerca le conoscenze degli sviluppatori nella documentazione per gli sviluppatori di Google. Restituisce DocumentChunk in base alla query dell'utente. Potrebbero esserci molti chunk dello stesso Document. Per recuperare i documenti completi, utilizza DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments con DocumentChunk.parent restituito in SearchDocumentChunksResponse.results.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

BatchGetDocumentsRequest

Messaggio di richiesta per DeveloperKnowledge.BatchGetDocuments.

Campi
names[]

string

Obbligatorio. Specifica i nomi dei documenti da recuperare. È possibile recuperare un massimo di 20 documenti in un batch. I documenti vengono restituiti nello stesso ordine di names nella richiesta.

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

BatchGetDocumentsResponse

Messaggio di risposta per DeveloperKnowledge.BatchGetDocuments.

Campi
documents[]

Document

Contiene i documenti richiesti.

Documento

Un documento rappresenta un contenuto del corpus di conoscenze per sviluppatori.

Campi
name

string

Identificatore. Contiene il nome risorsa del documento. Formato: documents/{uri_without_scheme} Esempio: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Solo output. Fornisce l'URI dei contenuti, ad esempio docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Solo output. Contiene l'intero contenuto del documento in formato Markdown.
description

string

Solo output. Fornisce una descrizione del documento.
title

string

Solo output. Fornisce il titolo del documento.

DocumentChunk

Un DocumentChunk rappresenta una parte di contenuti di un Document nel corpus DeveloperKnowledge. Per recuperare l'intero contenuto del documento, passa parent a DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments.

Campi
parent

string

Solo output. Contiene il nome della risorsa del documento da cui proviene questo chunk. Formato: documents/{uri_without_scheme} Esempio: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Solo output. Specifica l'ID di questo blocco all'interno del documento. L'ID blocco è univoco all'interno di un documento, ma non a livello globale tra i documenti. L'ID blocco non è stabile e potrebbe cambiare nel tempo.
content

string

Solo output. Contiene i contenuti del blocco del documento.

GetDocumentRequest

Messaggio di richiesta per DeveloperKnowledge.GetDocument.

Campi
name

string

Obbligatorio. Specifica il nome del documento da recuperare. Formato: documents/{uri_without_scheme} Esempio: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Messaggio di richiesta per DeveloperKnowledge.SearchDocumentChunks.

Campi
query

string

Obbligatorio. Fornisce la stringa di query non elaborata fornita dall'utente, ad esempio "Come creare un bucket Cloud Storage?".
page_size

int32

Facoltativo. Specifica il numero massimo di risultati da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore.

Se non specificato, verranno restituiti al massimo 5 risultati.

Il valore massimo è 20; i valori superiori a 20 genereranno un errore INVALID_ARGUMENT.
page_token

string

Facoltativo. Contiene un token di pagina, ricevuto da una precedente chiamata SearchDocumentChunks. Forniscilo per recuperare la pagina successiva.

SearchDocumentChunksResponse

Messaggio di risposta per DeveloperKnowledge.SearchDocumentChunks.

Campi
results[]

DocumentChunk

Contiene i risultati di ricerca per la query specificata. Ogni DocumentChunk di questo elenco contiene un snippet di contenuti pertinenti alla query di ricerca. Utilizza il campo DocumentChunk.parent di ogni risultato con DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments per recuperare i contenuti completi del documento.
next_page_token

string

Facoltativo. Fornisce un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.