En esta página, se muestra cómo comenzar a usar las bibliotecas cliente de Cloud para la API de Developer Knowledge. En lugar de crear solicitudes HTTP sin procesar, las bibliotecas cliente proporcionan tipos idiomáticos, autenticación integrada, paginación automática y control de reintentos que reducen la cantidad de código que debes escribir.
Para obtener más información sobre las bibliotecas cliente de las APIs de Google, consulta Explicación de las bibliotecas cliente.
Instala la biblioteca cliente
Selecciona tu lenguaje de programación para instalar la biblioteca cliente oficial de la API de Developer Knowledge:
Go
Agrega el módulo a tu proyecto de Go:
go get cloud.google.com/go/developerknowledge/apiv1
Para obtener más información, consulta Configura un entorno de desarrollo de Go.
Java
Si usas Maven, agrega la siguiente dependencia a tu archivo pom.xml:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Si usas Gradle, agrega la siguiente dependencia a tu archivo build.gradle:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Para obtener más información, consulta Configura un entorno de desarrollo de Java.
Node.js y TypeScript
Instala el paquete con npm:
npm install @google/developer-knowledge
Para obtener más información, consulta Configura un entorno de desarrollo de Node.js.
PHP
Instala el paquete con Composer:
composer require google/developer-knowledge
Para obtener más información, consulta Usa PHP en Google Cloud.
Python
Instala el paquete con pip:
pip install --upgrade google-developer-knowledge
Para obtener más información, consulta Configura un entorno de desarrollo de Python.
Ruby
Instala la gema:
gem install google-developers-developer_knowledge
Para obtener más información, consulta Configura un entorno de desarrollo de Ruby.
Configura la autenticación
Antes de realizar solicitudes a la API, asegúrate de habilitar la API de Developer Knowledge en tu proyecto de Google Cloud.
Para autenticar las llamadas a la API de Developer Knowledge, las bibliotecas cliente admiten las credenciales predeterminadas de la aplicación (ADC). Las bibliotecas buscan credenciales en un conjunto de ubicaciones definidas y las usan para autenticar solicitudes a la API. Con ADC, puedes hacer que las credenciales estén disponibles para tu aplicación en una variedad de entornos, como el desarrollo o producción local, sin necesidad de modificar el código de la aplicación.
En los entornos de producción, la forma en que configuras ADC depende del servicio y el contexto:
- Entornos de Google Cloud: Cuando tu aplicación se ejecuta en Cloud Run, Google Kubernetes Engine, Compute Engine o Cloud Run Functions, ADC usa automáticamente la cuenta de servicio adjunta al recurso de procesamiento.
- Entornos externos o locales: Usa la federación de identidades para cargas de trabajo o establece la variable de entorno
GOOGLE_APPLICATION_CREDENTIALSen la ruta de acceso a un archivo de configuración de credenciales.
Para obtener más información sobre las opciones de credenciales de producción, consulta Configura las credenciales predeterminadas de la aplicación.
Para un entorno de desarrollo local, puedes configurar ADC con las credenciales asociadas a tu Cuenta de Google:
- Instala e inicializa la CLI de gcloud.
Crea credenciales de autenticación locales para tu Cuenta de Google:
gcloud auth application-default loginAparecerá una pantalla de acceso. Después de acceder, tus credenciales se almacenan en el archivo de credenciales local que usa ADC.
Recursos adicionales
Selecciona una pestaña de idioma para encontrar vínculos a la documentación de referencia de la API, muestras de código, prácticas recomendadas, rastreadores de problemas y repositorios de código fuente para cada biblioteca cliente:
Go
La siguiente lista contiene vínculos a más recursos relacionados con la biblioteca cliente para Go:
Java
La siguiente lista contiene vínculos a más recursos relacionados con la biblioteca cliente para Java:
Node.js y TypeScript
La siguiente lista contiene vínculos a más recursos relacionados con la biblioteca cliente para Node.js y TypeScript:
PHP
La siguiente lista contiene vínculos a más recursos relacionados con la biblioteca cliente para PHP:
Python
La siguiente lista contiene vínculos a más recursos relacionados con la biblioteca cliente para Python:
Ruby
La siguiente lista contiene vínculos a más recursos relacionados con la biblioteca cliente para Ruby:
¿Qué sigue?
- Sigue la guía de inicio rápido de las bibliotecas cliente para ver y ejecutar muestras de código de
AnswerQuery,SearchDocumentChunks,GetDocumentyBatchGetDocuments. - Obtén más información sobre los filtros de búsqueda, la paginación y las máscaras de campo en Cómo buscar y recuperar documentos.
- Usa la generación fundamentada con Generar respuestas a partir de la documentación.
- Revisa las estrategias de reintento y los códigos de estado en Manejo de errores, límite de frecuencia y administración de cuotas.
- Explora la referencia del corpus para ver todos los dominios de documentación admitidos.