Package google.developers.knowledge.v1alpha

색인

DeveloperKnowledge

Developer Knowledge API는 Google의 공개 개발자 문서에 프로그래매틱 방식으로 액세스할 수 있도록 지원하므로 이 기술 자료를 자체 애플리케이션 및 워크플로에 통합할 수 있습니다.

이 API는 Google의 개발자 문서에 대한 머신이 읽을 수 있는 액세스를 위한 표준 소스로 설계되었습니다.

일반적인 사용 사례는 먼저 DeveloperKnowledge.SearchDocumentChunks를 사용하여 쿼리를 기반으로 관련 페이지 URI를 찾은 다음 DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments를 사용하여 상위 결과의 전체 콘텐츠를 가져오는 것입니다.

모든 문서 콘텐츠는 마크다운 형식으로 제공됩니다.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

그라운딩된 생성을 사용하여 질문에 답변합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 OAuth 2.0 Overview를 참조하세요.
BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

각각 전체 마크다운 콘텐츠가 포함된 여러 문서를 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 OAuth 2.0 Overview를 참조하세요.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

전체 마크다운 콘텐츠가 포함된 단일 문서를 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 OAuth 2.0 Overview를 참조하세요.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Google의 개발자 문서에서 개발자 지식을 검색합니다. 사용자의 질문에 따라 DocumentChunk를 반환합니다. 동일한 Document의 청크가 여러 개 있을 수 있습니다. 전체 문서를 검색하려면 SearchDocumentChunksResponse.results에서 반환된 DocumentChunk.parent와 함께 DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments를 사용하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 OAuth 2.0 Overview를 참조하세요.

답변

질문에 대한 답변입니다.

필드
answer_text

string

답변의 텍스트가 포함됩니다.
citations[]

AnswerCitation

출력 전용입니다. 답변의 인용을 포함합니다.
references[]

AnswerReference

출력 전용입니다. 답변의 참조를 포함합니다.

AnswerCitation

세그먼트의 인용 정보입니다.

필드
start_index

int32

출력 전용입니다. 바이트(UTF-8 유니코드)로 측정된 세그먼트의 시작을 나타냅니다(포함). ASCII가 아닌 문자와 같은 멀티바이트 문자가 있으면 색인 측정값이 문자열 길이보다 깁니다.
end_index

int32

출력 전용입니다. 바이트(UTF-8 유니코드)로 측정된 세그먼트의 끝을 나타냅니다(제외). ASCII가 아닌 문자와 같은 멀티바이트 문자가 있으면 색인 측정값이 문자열 길이보다 깁니다.
sources[]

CitationSource

출력 전용입니다. 기여도가 부여된 세그먼트의 인용 출처를 포함합니다.

AnswerReference

소스에 대한 참조를 나타냅니다.

필드
통합 필드 content. 참조의 콘텐츠를 포함합니다. content은 다음 중 하나여야 합니다.
document_reference

DocumentReference

출력 전용입니다. 참조 문서입니다.

CitationSource

인용 출처입니다.

필드
reference_index

int32

출력 전용입니다. references 반복 필드에서 Answer.AnswerReference의 색인을 포함합니다.

DocumentReference

문서 참조를 나타냅니다.

필드
document_chunk

DocumentChunk

출력 전용입니다. 문서 청크를 포함합니다. document_chunk.id 필드가 설정되지 않아 비어 있습니다.

AnswerQueryRequest

DeveloperKnowledge.AnswerQuery에 대한 요청 메시지입니다.

필드
query

string

필수 항목입니다. 답변할 질문입니다.

AnswerQueryResponse

DeveloperKnowledge.AnswerQuery의 응답 메시지입니다.

필드
answer

Answer

질문에 대한 답변입니다.

BatchGetDocumentsRequest

DeveloperKnowledge.BatchGetDocuments에 대한 요청 메시지입니다.

필드
names[]

string

필수 항목입니다. 가져올 문서의 이름을 지정합니다. 한 번에 최대 20개의 문서를 검색할 수 있습니다. 문서는 요청의 names와 동일한 순서로 반환됩니다.

형식: documents/{uri_without_scheme} 예: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

선택사항입니다. 문서의 DocumentView을 지정합니다. 지정하지 않으면 DeveloperKnowledge.BatchGetDocuments의 기본값은 DOCUMENT_VIEW_CONTENT입니다.

BatchGetDocumentsResponse

DeveloperKnowledge.BatchGetDocuments의 응답 메시지입니다.

필드
documents[]

Document

요청된 문서를 포함합니다.

문서

문서는 개발자 지식 코퍼스의 콘텐츠를 나타냅니다.

필드
name

string

식별자. 문서의 리소스 이름을 포함합니다. 형식: documents/{uri_without_scheme} 예: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

출력 전용입니다. 콘텐츠의 URI를 제공합니다(예: docs.cloud.google.com/storage/docs/creating-buckets).
content

string

출력 전용입니다. 문서의 전체 콘텐츠를 마크다운 형식으로 포함합니다.
description

string

출력 전용입니다. 문서에 대한 설명을 제공합니다.
data_source

string

출력 전용입니다. 문서의 데이터 소스를 지정합니다. 데이터 소스 예: firebase.google.com
title

string

출력 전용입니다. 문서의 제목을 제공합니다.
update_time

Timestamp

출력 전용입니다. 문서의 콘텐츠 또는 메타데이터가 마지막으로 업데이트된 타임스탬프를 나타냅니다.
view

DocumentView

출력 전용입니다. 문서의 DocumentView을 지정합니다.

DocumentChunk

DocumentChunk는 DeveloperKnowledge 말뭉치의 Document에 있는 콘텐츠 조각을 나타냅니다. 전체 문서 콘텐츠를 가져오려면 parent를 DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments에 전달합니다.

필드
parent

string

출력 전용입니다. 이 청크가 속한 문서의 리소스 이름을 포함합니다. 형식: documents/{uri_without_scheme} 예: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

출력 전용입니다. 문서 내 이 청크의 ID를 지정합니다. 청크 ID는 문서 내에서 고유하지만 문서 간에 전역적으로 고유하지는 않습니다. 청크 ID는 안정적이지 않으며 시간이 지남에 따라 변경될 수 있습니다.
content

string

출력 전용입니다. 문서 청크의 콘텐츠를 포함합니다.
document

Document

출력 전용입니다. 이 청크가 속한 Document에 관한 메타데이터를 나타냅니다. 이 Document 메시지의 DocumentView이 DOCUMENT_VIEW_BASIC로 설정됩니다. 메타데이터 필드만 필요한 경우 클라이언트가 DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments를 호출하지 않아도 되도록 편의를 위해 여기에 포함되어 있습니다. 그렇지 않으면 클라이언트는 DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments을 사용하여 전체 문서 콘텐츠를 가져와야 합니다.

DocumentView

Document에 포함된 필드를 지정합니다.

열거형
DOCUMENT_VIEW_UNSPECIFIED 기본값 / 설정되지 않은 값입니다. DocumentView가 지정되지 않은 경우 각 API 메서드의 기본값을 참고하세요.
DOCUMENT_VIEW_BASIC

기본 메타데이터 필드만 포함합니다. - name - uri - data_source - title - description - update_time - view

DeveloperKnowledge.SearchDocumentChunks의 기본 보기입니다.
DOCUMENT_VIEW_FULL 모든 Document 필드를 포함합니다.
DOCUMENT_VIEW_CONTENT

DOCUMENT_VIEW_BASIC 필드와 content 필드가 포함됩니다.

DeveloperKnowledge.GetDocument 및 DeveloperKnowledge.BatchGetDocuments의 기본 보기입니다.

GetDocumentRequest

DeveloperKnowledge.GetDocument에 대한 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져올 문서의 이름을 지정합니다. 형식: documents/{uri_without_scheme} 예: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

선택사항입니다. 문서의 DocumentView을 지정합니다. 지정하지 않으면 DeveloperKnowledge.GetDocument의 기본값은 DOCUMENT_VIEW_CONTENT입니다.

SearchDocumentChunksRequest

DeveloperKnowledge.SearchDocumentChunks에 대한 요청 메시지입니다.

필드
query

string

필수 항목입니다. 사용자가 제공한 원시 쿼리 문자열을 제공합니다(예: 'Cloud Storage 버킷을 만드는 방법').
page_size

int32

선택사항입니다. 반환할 최대 결과 수를 지정합니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 5개의 결과가 반환됩니다.

최댓값은 20이며, 20을 초과하는 값은 INVALID_ARGUMENT 오류를 발생시킵니다.
page_token

string

선택사항입니다. 이전 SearchDocumentChunks 호출에서 받은 페이지 토큰을 포함합니다. 후속 페이지를 검색하려면 이를 입력합니다.
filter

string

선택사항입니다. 검색 결과에 엄격한 필터를 적용합니다. 이 표현식은 https://google.aip.dev/160에 설명된 문법의 하위 집합을 지원합니다.

SearchDocumentChunks는 DocumentChunk를 반환하지만 필터는 DocumentChunk.document 필드에 적용됩니다.

필터링 지원 필드:

  • data_source(STRING): 문서의 소스입니다(예: docs.cloud.google.com). 코퍼스의 데이터 소스 전체 목록은 https://developers.google.com/knowledge/reference/corpus-reference를 참고하세요.
  • update_time (타임스탬프): 문서가 마지막으로 의미 있게 업데이트된 시간의 타임스탬프입니다. 의미 있는 업데이트는 문서의 마크다운 콘텐츠 또는 메타데이터를 변경하는 업데이트입니다.
  • uri(문자열): 문서 URI입니다(예: https://docs.cloud.google.com/bigquery/docs/tables).

STRING 필드는 전체 문자열에 대한 일치검색을 위해 = (같음) 및 != (같지 않음) 연산자를 지원합니다. 부분 일치, 접두사 일치, 정규식 일치는 지원되지 않습니다.

TIMESTAMP 필드는 =, <, <=, >, >= 연산자를 지원합니다. 타임스탬프는 RFC-3339 형식이어야 합니다(예: "2025-01-01T00:00:00Z").

AND, OR, NOT (또는 -) 논리 연산자를 사용하여 표현식을 결합할 수 있습니다. OR의 우선순위가 AND보다 높습니다. 명시적 우선순위 그룹화에는 괄호를 사용합니다.

예:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

filter 문자열은 500자를 초과할 수 없습니다. 500자를 초과하는 값은 INVALID_ARGUMENT 오류를 발생시킵니다.

SearchDocumentChunksResponse

DeveloperKnowledge.SearchDocumentChunks의 응답 메시지입니다.

필드
results[]

DocumentChunk

지정된 쿼리의 검색 결과를 포함합니다. 이 목록의 각 DocumentChunk에는 검색어와 관련된 콘텐츠 스니펫이 포함되어 있습니다. DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments와 함께 각 결과의 DocumentChunk.parent 필드를 사용하여 전체 문서 콘텐츠를 가져옵니다.
next_page_token

string

선택사항입니다. 다음 페이지를 가져오기 위해 page_token으로 전송할 수 있는 토큰을 제공합니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.