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.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Risponde a una query utilizzando la generazione basata su dati reali.

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

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Recupera più documenti, ognuno con i propri contenuti Markdown completi.

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

Risposta

Una risposta a una query.

Campi
answer_text

string

Contiene il testo della risposta.
citations[]

AnswerCitation

Solo output. Contiene le citazioni per la risposta.
references[]

AnswerReference

Solo output. Contiene riferimenti per la risposta.

AnswerCitation

Informazioni sulla citazione per un segmento.

Campi
start_index

int32

Solo output. Indica l'inizio del segmento, misurato in byte (Unicode UTF-8), inclusi. Se sono presenti caratteri multibyte, ad esempio caratteri non ASCII, la misurazione dell'indice è superiore alla lunghezza della stringa.
end_index

int32

Solo output. Indica la fine del segmento, misurata in byte (Unicode UTF-8), esclusa. Se sono presenti caratteri multibyte, ad esempio caratteri non ASCII, la misurazione dell'indice è superiore alla lunghezza della stringa.
sources[]

CitationSource

Solo output. Contiene le fonti delle citazioni per il segmento attribuito.

AnswerReference

Rappresenta un riferimento a una fonte.

Campi
Campo unione content. Contiene i contenuti del riferimento. content può essere solo uno dei seguenti tipi:
document_reference

DocumentReference

Solo output. Il documento di riferimento.

CitationSource

Fonte della citazione.

Campi
reference_index

int32

Solo output. Contiene l'indice di Answer.AnswerReference nel campo ripetuto references.

DocumentReference

Rappresenta un riferimento a un documento.

Campi
document_chunk

DocumentChunk

Solo output. Contiene il blocco del documento. Il campo document_chunk.id non è impostato e sarà vuoto.

AnswerQueryRequest

Messaggio di richiesta per DeveloperKnowledge.AnswerQuery.

Campi
query

string

Obbligatorio. La query a cui rispondere.

AnswerQueryResponse

Messaggio di risposta per DeveloperKnowledge.AnswerQuery.

Campi
answer

Answer

La risposta alla query.

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
view

DocumentView

Facoltativo. Specifica il DocumentView del documento. Se non specificato, il valore predefinito di DeveloperKnowledge.BatchGetDocuments è DOCUMENT_VIEW_CONTENT.

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

string

Solo output. Specifica l'origine dati del documento. Origine dati di esempio: firebase.google.com
title

string

Solo output. Fornisce il titolo del documento.
update_time

Timestamp

Solo output. Rappresenta il timestamp dell'ultimo aggiornamento dei contenuti o dei metadati del documento.
view

DocumentView

Solo output. Specifica il DocumentView 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 chunk non è stabile e potrebbe cambiare nel tempo.
content

string

Solo output. Contiene i contenuti del blocco del documento.
document

Document

Solo output. Rappresenta i metadati relativi al Document da cui proviene questo chunk. Il DocumentView di questo messaggio Document verrà impostato su DOCUMENT_VIEW_BASIC. È incluso qui per comodità, in modo che i clienti non debbano chiamare DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments se hanno bisogno solo dei campi dei metadati. In caso contrario, i client devono utilizzare DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments per recuperare l'intero contenuto del documento.

DocumentView

Specifica i campi di Document inclusi.

Enum
DOCUMENT_VIEW_UNSPECIFIED Il valore predefinito / non impostato. Se DocumentView non è specificato, consulta il valore predefinito di ogni metodo API.
DOCUMENT_VIEW_BASIC

Include solo i campi dei metadati di base: - name - uri - data_source - title - description - update_time - view

Questa è la visualizzazione predefinita per DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Include tutti i campi Document.
DOCUMENT_VIEW_CONTENT

Include i campi DOCUMENT_VIEW_BASIC e il campo content.

Questa è la visualizzazione predefinita per DeveloperKnowledge.GetDocument e DeveloperKnowledge.BatchGetDocuments.

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
view

DocumentView

Facoltativo. Specifica il DocumentView del documento. Se non specificato, il valore predefinito di DeveloperKnowledge.GetDocument è DOCUMENT_VIEW_CONTENT.

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

string

Facoltativo. Applica un filtro rigoroso ai risultati di ricerca. L'espressione supporta un sottoinsieme della sintassi descritta all'indirizzo https://google.aip.dev/160.

Mentre SearchDocumentChunks restituisce DocumentChunk, il filtro viene applicato ai campi DocumentChunk.document.

Campi supportati per il filtro:

  • data_source (STRING): l'origine del documento, ad esempio docs.cloud.google.com. Consulta https://developers.google.com/knowledge/reference/corpus-reference per l'elenco completo delle origini dati nel corpus.
  • update_time (TIMESTAMP): il timestamp dell'ultimo aggiornamento significativo del documento. Un aggiornamento significativo è quello che modifica i contenuti o i metadati Markdown del documento.
  • uri (STRINGA): l'URI del documento, ad es. https://docs.cloud.google.com/bigquery/docs/tables.

I campi STRING supportano gli operatori = (uguale a) e != (diverso da) per la corrispondenza esatta dell'intera stringa. La corrispondenza parziale, la corrispondenza del prefisso e la corrispondenza con espressione regolare non sono supportate.

I campi TIMESTAMP supportano gli operatori =, <, <=, > e >=. I timestamp devono essere nel formato RFC-3339, ad esempio "2025-01-01T00:00:00Z".

Puoi combinare le espressioni utilizzando gli operatori logici AND, OR e NOT (o -). OR ha una priorità più alta rispetto a AND. Utilizza le parentesi per il raggruppamento esplicito della precedenza.

Esempi:

  • 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 stringa filter non deve superare i 500 caratteri; i valori più lunghi di 500 caratteri genereranno un errore INVALID_ARGUMENT.

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.