이 페이지에서는 Developer Knowledge API용 Cloud 클라이언트 라이브러리를 시작하는 방법을 설명합니다. 클라이언트 라이브러리는 원시 HTTP 요청을 구성하는 대신 작성해야 하는 코드의 양을 줄여 주는 관용적 유형, 기본 인증, 자동 페이지로 나누기, 재시도 처리를 제공합니다.
Google API용 클라이언트 라이브러리에 대해 자세히 알아보려면 클라이언트 라이브러리 설명을 참고하세요.
클라이언트 라이브러리 설치
프로그래밍 언어를 선택하여 공식 Developer Knowledge API 클라이언트 라이브러리를 설치합니다.
Go
Go 프로젝트에 모듈을 추가합니다.
go get cloud.google.com/go/developerknowledge/apiv1
자세한 내용은 Go 개발 환경 설정을 참고하세요.
자바
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 Functions에서 실행되는 경우 ADC는 컴퓨팅 리소스에 연결된 서비스 계정을 자동으로 사용합니다.
- 외부 또는 온프레미스 환경: 워크로드 아이덴티티 제휴를 사용하거나
GOOGLE_APPLICATION_CREDENTIALS환경 변수를 사용자 인증 정보 구성 파일의 경로로 설정합니다.
프로덕션 사용자 인증 정보 옵션에 대해 자세히 알아보려면 애플리케이션 기본 사용자 인증 정보 설정을 참고하세요.
로컬 개발 환경의 경우 Google 계정과 연결된 사용자 인증 정보를 사용하여 ADC를 설정할 수 있습니다.
- gcloud CLI를 설치하고 초기화합니다.
Google 계정의 로컬 인증 사용자 인증 정보를 만듭니다.
gcloud auth application-default login로그인 화면이 표시됩니다. 로그인하면 사용자 인증 정보는 ADC에서 사용하는 로컬 사용자 인증 정보 파일에 저장됩니다.
추가 리소스
언어 탭을 선택하여 각 클라이언트 라이브러리의 API 참조 문서, 코드 샘플, 권장사항, 문제 추적기, 소스 코드 저장소 링크를 확인하세요.
Go
다음 목록에는 Go용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.
자바
다음 목록에는 Java용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.
Node.js 및 TypeScript
다음 목록에는 Node.js 및 TypeScript용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.
PHP
다음 목록에는 PHP용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.
Python
다음 목록에는 Python용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.
Ruby
다음 목록에는 Ruby용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.
다음 단계
- 클라이언트 라이브러리 빠른 시작에 따라
AnswerQuery,SearchDocumentChunks,GetDocument,BatchGetDocuments의 코드 샘플을 보고 실행합니다. - 문서 검색 및 가져오기에서 쿼리 필터, 페이지로 나누기, 필드 마스크에 대해 자세히 알아보세요.
- 문서에서 답변 생성과 함께 그라운딩된 생성 기능을 사용합니다.
- 오류 처리, 비율 제한, 할당량 관리에서 재시도 전략과 상태 코드를 검토하세요.
- 코퍼스 참조를 탐색하여 지원되는 모든 문서 도메인을 확인하세요.