문서에서 답변 생성

Developer Knowledge API를 사용하면 Google 개발자 제품에 관해 질문하고 자연어로 된 직접적인 답변을 받을 수 있습니다. 각 쿼리에 대해 API는 개발자 지식 코퍼스 (API 참조에서 그라운딩된 생성이라고 함)에서 가져온 응답을 작성하고 관련 문서 페이지에 대한 인용을 포함합니다.

시작하기 전에

선호하는 도구의 환경을 설정합니다.

gcloud

gcloud CLI를 설치 및 구성하고 Developer Knowledge API를 사용 설정합니다.

REST

API를 사용 설정하고 Developer Knowledge API 키를 생성합니다. 그런 다음 키를 환경 변수에 저장합니다.

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

YOUR_API_KEY를 Developer Knowledge API 키로 바꿉니다.

질문에 답변

gcloud developer-knowledge answer-query 명령어 또는 answerQuery REST 메서드를 사용하여 질문합니다.

다음 예에서는 BigQuery 데이터 세트를 만드는 방법을 묻는 질문을 전송합니다.

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

응답에는 answer.answerText 필드의 텍스트 답변과 answer 객체의 citations 및 references이 포함됩니다.

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

문서 소스 필터링

답변을 생성하는 데 사용되는 문서 소스를 제한하려면 gcloud CLI의 --query-filter 플래그 또는 REST 요청 본문의 filter 필드를 사용하여 필터 표현식을 전달합니다. 지원되는 필터 필드 및 연산자에 대한 자세한 내용은 검색 결과 필터링을 참고하세요.

다음 예시에서는 문서 소스를 docs.cloud.google.com로 제한합니다.

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How do I create a BigQuery dataset?",
    "filter": "data_source = \"docs.cloud.google.com\""
  }'

AnswerQuery와 SearchDocumentChunks 중에서 선택하세요.

API 또는 개발자 지식 MCP 서버를 사용하는 경우 원하는 항목에 가장 적합한 방법을 선택하세요.

  • AnswerQuery (또는 answer_query MCP 도구): 일반적인 '방법' 질문, 제품 비교, 소스 문서 링크가 포함된 완전한 요약이 필요한 단계별 안내에 가장 적합합니다.
  • SearchDocumentChunks (또는 search_documents MCP 도구): 정확한 CLI 플래그, 코드 구문, 매개변수 이름 또는 IAM 권한 (예: service.resource.verb)을 조회하는 데 가장 적합합니다. 전체 질문 대신 2~5개의 구체적인 키워드를 사용하세요.

다음 단계