google-developer-knowledge

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Google Developer Knowledge

Google开发者知识库

Use this skill to search and retrieve content from Google's public developer documentation corpus using the Developer Knowledge API.
This skill uses simple bash scripts with curl (no dependencies required).
使用此技能,通过Developer Knowledge API从Google公开开发者文档库中搜索和检索内容。
本技能使用基于curl的简单bash脚本(无依赖项要求)。

Prerequisites

前提条件

  1. Enable the API: Enable the Developer Knowledge API in your Google Cloud project.
  2. Create an API Key:
    • Go to the Credentials page
    • Click Create credentialsAPI key
    • Restrict the key to Developer Knowledge API only
  3. Set Environment Variable:
    • DEVELOPERKNOWLEDGE_API_KEY
      : Your Developer Knowledge API key
  1. 启用API:在你的Google Cloud项目中启用Developer Knowledge API
  2. 创建API密钥
    • 前往凭据页面
    • 点击创建凭据API密钥
    • 将密钥限制为仅可访问Developer Knowledge API
  3. 设置环境变量
    • DEVELOPERKNOWLEDGE_API_KEY
      :你的Developer Knowledge API密钥

Searchable Corpus

可搜索文档库

The API searches these domains:
  • ai.google.dev
  • developer.android.com
  • developer.chrome.com
  • developers.google.com
  • docs.cloud.google.com
  • firebase.google.com
  • web.dev
  • www.tensorflow.org
该API搜索以下域名:
  • ai.google.dev
  • developer.android.com
  • developer.chrome.com
  • developers.google.com
  • docs.cloud.google.com
  • firebase.google.com
  • web.dev
  • www.tensorflow.org

Usage

使用方法

1. Search for Documents

1. 搜索文档

Search for document chunks matching a query. Returns snippets and parent document references.
bash
./skills/google-developer-knowledge/scripts/search_docs.sh "How to use Gemini API in Python"
With pagination:
bash
./skills/google-developer-knowledge/scripts/search_docs.sh "BigQuery" --page-size 10
搜索与查询匹配的文档片段。返回片段内容及父文档引用。
bash
./skills/google-developer-knowledge/scripts/search_docs.sh "How to use Gemini API in Python"
带分页功能:
bash
./skills/google-developer-knowledge/scripts/search_docs.sh "BigQuery" --page-size 10

2. Get a Single Document

2. 获取单个文档

Retrieve the full content of a document using its name from search results.
bash
./skills/google-developer-knowledge/scripts/get_document.sh "documents/ai.google.dev/gemini-api/docs/get-started/python"
Save to file:
bash
./skills/google-developer-knowledge/scripts/get_document.sh "documents/ai.google.dev/..." --output doc.json
使用搜索结果中的文档名称检索完整文档内容。
bash
./skills/google-developer-knowledge/scripts/get_document.sh "documents/ai.google.dev/gemini-api/docs/get-started/python"
保存到文件:
bash
./skills/google-developer-knowledge/scripts/get_document.sh "documents/ai.google.dev/..." --output doc.json

3. Batch Get Documents

3. 批量获取文档

Retrieve up to 20 documents in a single API call.
bash
./skills/google-developer-knowledge/scripts/batch_get_documents.sh \
  "documents/ai.google.dev/gemini-api/docs/get-started/python" \
  "documents/ai.google.dev/gemini-api/docs/models"
在单次API调用中检索最多20个文档。
bash
./skills/google-developer-knowledge/scripts/batch_get_documents.sh \
  "documents/ai.google.dev/gemini-api/docs/get-started/python" \
  "documents/ai.google.dev/gemini-api/docs/models"

Options

选项

search_docs.sh
  • query
    : The search query (required)
  • --page-size
    : Number of results (1-20, default 5)
  • --page-token
    : Token for next page of results
  • --output
    : Save results to JSON file
get_document.sh
  • name
    : Document name from search results (required)
  • --output
    : Save content to file
batch_get_documents.sh
  • names
    : Space-separated document names (up to 20)
  • --output
    : Save all documents to directory
search_docs.sh
  • query
    :搜索查询词(必填)
  • --page-size
    :结果数量(1-20,默认5)
  • --page-token
    :下一页结果的令牌
  • --output
    :将结果保存到JSON文件
get_document.sh
  • name
    :搜索结果中的文档名称(必填)
  • --output
    :将内容保存到文件
batch_get_documents.sh
  • names
    :空格分隔的文档名称(最多20个)
  • --output
    :将所有文档保存到目录