Nesta página, mostramos como começar a usar as bibliotecas de cliente do Cloud para a API Developer Knowledge. Em vez de construir solicitações HTTP brutas, as bibliotecas de cliente fornecem tipos idiomáticos, autenticação integrada, paginação automática e tratamento de novas tentativas que reduzem a quantidade de código que você precisa escrever.
Para saber mais sobre as bibliotecas de cliente das APIs do Google, consulte Explicações sobre bibliotecas de cliente.
Instale a biblioteca de cliente
Selecione sua linguagem de programação para instalar a biblioteca de cliente oficial da API Developer Knowledge:
Go
Adicione o módulo ao seu projeto Go:
go get cloud.google.com/go/developerknowledge/apiv1
Para saber mais, consulte Como configurar um ambiente de desenvolvimento do Go.
Java
Se você usa o Maven, adicione a seguinte dependência ao arquivo pom.xml:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Se você usa o Gradle, adicione a seguinte dependência ao arquivo build.gradle:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Para saber mais, consulte Como configurar um ambiente de desenvolvimento em Java.
Node.js e TypeScript
Instale o pacote usando npm:
npm install @google/developer-knowledge
Para saber mais, consulte Como configurar um ambiente de desenvolvimento em Node.js.
PHP
Instale o pacote usando o Composer:
composer require google/developer-knowledge
Para saber mais, consulte Como usar o PHP no Google Cloud.
Python
Instale o pacote usando pip:
pip install --upgrade google-developer-knowledge
Para saber mais, consulte Como configurar um ambiente de desenvolvimento em Python.
Ruby
Instale a gem:
gem install google-developers-developer_knowledge
Para saber mais, consulte Como configurar um ambiente de desenvolvimento em Ruby.
Configurar a autenticação
Antes de fazer solicitações de API, verifique se você ativou a API Developer Knowledge no seu projeto na nuvem do Google Cloud.
Para autenticar chamadas à API Developer Knowledge, as bibliotecas de cliente oferecem suporte ao Application Default Credentials (ADC). As bibliotecas procuram credenciais em um conjunto de locais definidos e as usam para autenticar solicitações à API. Com o ADC, é possível disponibilizar credenciais para seu aplicativo em uma variedade de ambientes, como desenvolvimento local ou produção, sem precisar modificar o código do aplicativo.
Em ambientes de produção, a maneira como você configura o ADC depende do serviço e do contexto:
- Ambientes do Google Cloud: quando o aplicativo é executado no Cloud Run, no Google Kubernetes Engine, no Compute Engine ou no Cloud Run functions, o ADC usa automaticamente a conta de serviço anexada ao recurso de computação.
- Ambientes externos ou locais: use a
federação de identidade da carga de trabalho ou defina a
variável de ambiente
GOOGLE_APPLICATION_CREDENTIALScomo o caminho de um arquivo de configuração de credenciais.
Para saber mais sobre as opções de credenciais de produção, consulte Configurar o Application Default Credentials.
Para um ambiente de desenvolvimento local, é possível configurar o ADC com as credenciais associadas à sua Conta do Google:
- Instale e inicialize a CLI gcloud.
Crie as credenciais de autenticação para sua Conta do Google:
gcloud auth application-default loginUma tela de login será exibida. Após o login, suas credenciais são armazenadas no arquivo de credenciais local usado pelo ADC.
Outros recursos
Selecione uma guia de idioma para encontrar links da documentação de referência da API, exemplos de código, práticas recomendadas, rastreadores de problemas e repositórios de código-fonte para cada biblioteca de cliente:
Go
Confira na lista a seguir os links para mais recursos relacionados à biblioteca de cliente para Go:
Java
Confira na lista a seguir os links para mais recursos relacionados à biblioteca de cliente para Java:
Node.js e TypeScript
Confira na lista a seguir os links para mais recursos relacionados à biblioteca de cliente para Node.js e TypeScript:
PHP
Confira na lista a seguir os links para mais recursos relacionados à biblioteca de cliente para PHP:
Python
Confira na lista a seguir os links para mais recursos relacionados à biblioteca de cliente para Python:
Ruby
Confira na lista a seguir os links para mais recursos relacionados à biblioteca de cliente para Ruby:
A seguir
- Siga o guia de início rápido das bibliotecas de cliente para conferir e executar exemplos de código para
AnswerQuery,SearchDocumentChunks,GetDocumenteBatchGetDocuments. - Saiba mais sobre filtros de consulta, paginação e máscaras de campo em Pesquisar e recuperar documentos.
- Use a geração embasada com Gerar respostas com base na documentação.
- Revise as estratégias de nova tentativa e os códigos de status em Tratamento de erros, limitação de taxa e gerenciamento de cota.
- Consulte a referência de corpus para conferir todos os domínios de documentação compatíveis.