Questa pagina mostra come iniziare a utilizzare le librerie client di Cloud per l'API Developer Knowledge. Anziché creare richieste HTTP non elaborate, le librerie client forniscono tipi idiomatici, autenticazione integrata, paginazione automatica e gestione dei tentativi che riducono la quantità di codice da scrivere.
Per saperne di più sulle librerie client per le API di Google, consulta Descrizione delle librerie client.
Installa la libreria client
Seleziona il tuo linguaggio di programmazione per installare la libreria client API Developer Knowledge ufficiale:
Go
Aggiungi il modulo al tuo progetto Go:
go get cloud.google.com/go/developerknowledge/apiv1
Per saperne di più, consulta Configurazione di un ambiente di sviluppo Go.
Java
Se utilizzi Maven, aggiungi la seguente dipendenza al file pom.xml:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Se utilizzi Gradle, aggiungi la seguente dipendenza al file build.gradle:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Per saperne di più, consulta Configurazione di un ambiente di sviluppo Java.
Node.js e TypeScript
Installa il pacchetto utilizzando npm:
npm install @google/developer-knowledge
Per saperne di più, consulta Configurazione di un ambiente di sviluppo Node.js.
PHP
Installa il pacchetto utilizzando Composer:
composer require google/developer-knowledge
Per saperne di più, consulta Utilizzo di PHP su Google Cloud.
Python
Installa il pacchetto utilizzando pip:
pip install --upgrade google-developer-knowledge
Per saperne di più, consulta Configurazione di un ambiente di sviluppo Python.
Ruby
Installa il gem:
gem install google-developers-developer_knowledge
Per saperne di più, consulta Configurazione di un ambiente di sviluppo Ruby.
Configura l'autenticazione
Prima di effettuare richieste API, assicurati di aver abilitato l'API Developer Knowledge nel tuo progetto Google Cloud.
Per autenticare le chiamate all'API Developer Knowledge, le librerie client supportano le Credenziali predefinite dell'applicazione (ADC). Le librerie cercano le credenziali in una serie di località definite e le utilizzano per autenticare le richieste all'API. Con le ADC, puoi rendere disponibili le credenziali per la tua applicazione in vari ambienti, ad esempio per lo sviluppo locale o la produzione, senza dover modificare il codice dell'applicazione.
Per gli ambienti di produzione, la modalità di configurazione delle credenziali ADC dipende dal servizio e dal contesto:
- Ambienti Google Cloud: quando l'applicazione viene eseguita su Cloud Run, Google Kubernetes Engine, Compute Engine o Cloud Run Functions, ADC utilizza automaticamente l'account di servizio collegato alla risorsa di calcolo.
- Ambienti esterni o on-premise: utilizza la federazione delle identità per i workload o imposta la variabile di ambiente
GOOGLE_APPLICATION_CREDENTIALSsul percorso di un file di configurazione delle credenziali.
Per scoprire di più sulle opzioni delle credenziali di produzione, consulta Configurare le credenziali predefinite dell'applicazione.
Per un ambiente di sviluppo locale, puoi configurare come ADC le credenziali associate al tuo Account Google:
- Installa e inizializza gcloud CLI.
Crea credenziali di autenticazione locale per il tuo Account Google:
gcloud auth application-default loginViene visualizzata una schermata di accesso. Dopo aver eseguito l'accesso, le tue credenziali vengono archiviate nel file delle credenziali locali utilizzato da ADC.
Risorse aggiuntive
Seleziona una scheda della lingua per trovare link a documentazione di riferimento delle API, esempi di codice, best practice, issue tracker e repository del codice sorgente per ogni libreria client:
Go
Il seguente elenco contiene link ad altre risorse relative alla libreria client per Go:
Java
Il seguente elenco contiene link ad altre risorse relative alla libreria client per Java:
Node.js e TypeScript
Il seguente elenco contiene link ad altre risorse relative alla libreria client per Node.js e TypeScript:
PHP
Il seguente elenco contiene link ad altre risorse relative alla libreria client per PHP:
Python
Il seguente elenco contiene link ad altre risorse relative alla libreria client per Python:
Ruby
Il seguente elenco contiene link ad altre risorse relative alla libreria client per Ruby:
Passaggi successivi
- Segui la
guida rapida alle librerie client per visualizzare ed eseguire esempi di codice
per
AnswerQuery,SearchDocumentChunks,GetDocumenteBatchGetDocuments. - Scopri di più su filtri di query, paginazione e maschere di campo in Cerca e recupera documenti.
- Utilizza la generazione fondata con Genera risposte dalla documentazione.
- Esamina le strategie di ripetizione e i codici di stato in Gestione degli errori, limitazione della frequenza e gestione delle quote.
- Consulta il corpus di riferimento per visualizzare tutti i domini della documentazione supportati.