이 가이드에서는 Developer Knowledge API를 시작하는 방법을 보여줍니다. Developer Knowledge API를 사용 설정하고, API 키를 가져오고, 첫 번째 API 호출을 통해 개발자 문서를 검색하고 가져오는 방법을 알아봅니다.
시작하기 전에
Developer Knowledge API를 사용하기 전에 다음 단계를 완료해야 합니다.
API 사용 설정
- Google API 라이브러리에서 Developer Knowledge API 페이지를 엽니다.
- API를 사용할 프로젝트가 올바르게 선택되어 있는지 확인합니다.
- 사용 설정을 클릭합니다. API를 사용 설정하거나 사용하는 데 필요한 특정 IAM 역할은 없습니다.
API 키 만들기 및 보안 설정
- API를 사용 설정한 프로젝트의 Google Cloud 콘솔에서 사용자 인증 정보 페이지로 이동합니다.
- 사용자 인증 정보 만들기를 클릭한 후 메뉴에서 API 키를 선택합니다.
- 이름 필드에 키 이름을 입력합니다.
-
API 제한사항 선택 드롭다운을 클릭한 다음 Developer Knowledge API를 입력합니다. 결과를 클릭한 다음 확인을 클릭합니다.
- 참고: Developer Knowledge API를 방금 사용 설정한 경우 목록에 표시되기까지 지연이 발생할 수 있습니다. 잠시 후 다시 시도해 보세요.
- 만들기를 클릭합니다.
그라운딩된 생성으로 질문에 답변하기
개발자 지식 API 키가 있으면 API를 사용할 수 있습니다. 다음 예에서는 쿼리를 요청하고 문서에 기반한 답변을 얻는 방법을 보여줍니다.
Developer Knowledge API 키를 환경 변수에 저장합니다.
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"YOUR_API_KEY를 생성한 API 키로 바꿉니다.curl을 사용하여AnswerQuery엔드포인트를 호출합니다.curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "How do I create a BigQuery dataset?"}'
이 명령어는 문서를 기반으로 질문에 대한 답변을 반환합니다.
문서 청크 검색
생성된 답변이 아닌 특정 문서 스니펫을 찾으려면 문서 청크를 직접 검색하면 됩니다.
curl을 사용하여 SearchDocumentChunks 엔드포인트를 호출합니다.
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
대답에는 문서의 일치하는 콘텐츠 청크와 상위 문서에 대한 참조가 포함됩니다.
문서 가져오기
searchDocumentChunks의 응답에는 문서 청크 목록이 포함됩니다.
각 문서 청크에는 문서의 리소스 이름이 포함된 parent 필드가 있으며, 이를 GetDocument와 함께 사용하여 문서의 전체 콘텐츠를 가져올 수 있습니다.
문서를 가져오려면 searchDocumentChunks에서 반환된 청크 중 하나의 parent 필드를 복사하여 환경 변수에 저장한 다음 curl를 사용하여 GetDocument 엔드포인트를 호출합니다.
export DOC_NAME="PARENT_FIELD_FROM_SEARCH"
curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"
그러면 지정된 문서의 전체 마크다운 콘텐츠가 반환됩니다.