Developer Knowledge API는 Google의 공개 개발자 문서에 프로그래매틱 방식으로 액세스할 수 있도록 지원하여 이 기술 자료를 자체 애플리케이션 및 워크플로에 통합할 수 있도록 합니다.
개요
Developer Knowledge API는 Google의 개발자 문서에 대한 머신 판독 가능 액세스를 위한 표준 소스로 설계되었습니다. 문서를 검색하고 가져오고 질문에 답변하는 기능을 제공합니다.
SearchDocumentChunks를 사용하여 질문에 따라 관련 페이지 URI와 콘텐츠 스니펫을 찾습니다.GetDocument또는BatchGetDocuments을 사용하여 검색 결과의 전체 콘텐츠를 가져옵니다.AnswerQuery를 사용하여 문서 코퍼스에서 가져온 질문에 대한 답변을 생성합니다.
빠르게 시작하려면 빠른 시작 가이드를 따르세요.
검색 가능한 콘텐츠의 코퍼스는 코퍼스 참조에 나열되어 있습니다.
Developer Knowledge API는 문서 페이지를 구조화되지 않은 마크다운 콘텐츠로 검색하고 가져오는 기능을 지원합니다.
API 사용 설정
Developer Knowledge API를 사용하려면 먼저 Google Cloud 프로젝트에서 사용 설정해야 합니다.
- Google API 라이브러리에서 Developer Knowledge API 페이지를 엽니다.
- API를 사용할 올바른 프로젝트가 선택되어 있는지 확인합니다.
- 사용 설정을 클릭합니다. API를 사용 설정하거나 사용하는 데 특정 IAM 역할이 필요하지 않습니다.
인증
다음 방법 중 하나를 사용하여 Developer Knowledge API에 대한 요청을 인증할 수 있습니다.
- API 키:
key쿼리 매개변수 또는X-Goog-Api-Key헤더를 사용하여 직접 REST 요청을 인증합니다. 예는 REST 빠른 시작을 참고하세요. - 애플리케이션 기본 사용자 인증 정보 (ADC), OAuth 2.0 또는 서비스 계정: 공식 클라이언트 라이브러리 또는 프로덕션 워크플로를 사용할 때 요청을 인증합니다. 사용자 인증 정보 설정에 대해 자세히 알아보려면 애플리케이션 기본 사용자 인증 정보 문서를 참고하세요.
포함된 문서
API에서 검색하는 문서에 대한 자세한 내용은 코퍼스 참조를 참고하세요.
Developer Knowledge API는 최신 Google 개발자 문서에 대한 액세스를 제공하는 것을 목표로 합니다. Google의 목표는 게시 후 48시간 이내에 콘텐츠를 다시 색인하여 2영업일 이내에 신규 또는 업데이트된 문서를 제공하는 것입니다.알려진 제한사항
- 마크다운 품질: 마크다운이 소스 HTML에서 생성됩니다. 불일치 또는 형식 문제가 있을 수 있습니다.
- 콘텐츠 범위: 코퍼스 참조의 공개 페이지만 포함됩니다. GitHub, OSS 사이트, 블로그, YouTube와 같은 다른 소스의 콘텐츠는 포함되지 않습니다.