本页面介绍了如何开始使用 Developer Knowledge API 的 Cloud 客户端库。客户端库不会构建原始 HTTP 请求,而是提供惯用类型、内置身份验证、自动分页和重试处理,从而减少您需要编写的代码量。
如需详细了解 Google API 的客户端库,请参阅 客户端库说明。
安装客户端库
选择您的编程语言以安装官方 Developer Knowledge API 客户端库:
C#
将 NuGet 软件包添加到您的 .NET 项目:
dotnet add package Google.Developers.DeveloperKnowledge.V1
如需了解详情,请参阅 设置 C# 开发环境。
Go
将模块添加到您的 Go 项目:
go get cloud.google.com/go/developerknowledge/apiv1
如需了解详情,请参阅 设置 Go 开发环境。
Java
如果您使用 Maven,请将以下依赖项添加到您的 pom.xml 文件:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
如果您使用 Gradle,请将以下依赖项添加到您的 build.gradle 文件:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
如需了解详情,请参阅 设置 Java 开发环境。
Node.js 和 TypeScript
使用 npm 安装软件包:
npm install @google/developer-knowledge
如需了解详情,请参阅 设置 Node.js 开发环境。
PHP
使用 Composer 安装软件包:
composer require google/developer-knowledge
如需了解详情,请参阅在 Google Cloud 上使用 PHP。
Python
使用 pip 安装软件包:
pip install --upgrade google-developer-knowledge
如需了解详情,请参阅 设置 Python 开发环境。
Ruby
安装 gem:
gem install google-developers-developer_knowledge
如需了解详情,请参阅 设置 Ruby 开发环境。
设置身份验证
在发出 API 请求之前,请确保您已在 Google Cloud 项目中 启用 Developer Knowledge API。
为了对 Developer Knowledge API 的调用进行身份验证,客户端库支持 应用默认凭证 (ADC)。这些库会在一组指定的位置查找凭据,并使用这些凭据对发送到 API 的请求进行身份验证。借助 ADC,您可以在各种环境(例如本地开发或生产环境)中为您的应用提供凭据,而无需修改应用代码。
对于生产环境,设置 ADC 的方式取决于服务和上下文:
- Google Cloud 环境:当您的应用在 Cloud Run、 Google Kubernetes Engine、Compute Engine 或 Cloud Run 函数上运行时,ADC 会自动使用与计算资源关联的服务账号。
- 外部或本地环境:使用
工作负载身份联合,或将
GOOGLE_APPLICATION_CREDENTIALS环境变量设置为凭据配置文件的路径。
如需详细了解生产凭据选项,请参阅 设置应用默认凭据。
对于本地开发环境,您可以使用与您的 Google 账号关联的凭据设置 ADC:
- 安装并初始化 gcloud CLI。
为您的 Google 账号创建本地身份验证凭据:
gcloud auth application-default login登录屏幕随即出现。登录后,您的凭据会存储在 ADC 使用的本地凭据文件中。
其他资源
选择一个语言标签页,以查找指向每个客户端库的 API 参考文档、代码示例、最佳实践、问题跟踪器和源代码库的链接:
C#
以下列表包含指向与 C# 客户端库相关的更多资源的链接:
Go
以下列表包含指向与 Go 客户端库相关的更多资源的链接:
Java
以下列表包含指向与 Java 客户端库相关的更多资源的链接:
Node.js 和 TypeScript
以下列表包含指向与 Node.js 和 TypeScript 客户端库相关的更多资源的链接:
PHP
以下列表包含指向与 PHP 客户端库相关的更多资源的链接:
Python
以下列表包含指向与 Python 客户端库相关的更多资源的链接:
Ruby
以下列表包含指向与 Ruby 客户端库相关的更多资源的链接:
后续步骤
- 按照
客户端库快速入门中的说明查看和运行代码示例
,包括
AnswerQuery、SearchDocumentChunks、GetDocument和BatchGetDocuments。 - 详细了解 搜索和检索文档中的查询过滤器、分页和字段掩码。
- 使用根据文档生成答案中的 有依据的生成功能。
- 查看 错误处理、速率限制和配额管理中的重试策略和状态代码。
- 浏览语料库参考文档,查看所有受支持的文档网域。