Package google.developers.knowledge.v1alpha

색인

• DeveloperKnowledge(인터페이스)
• BatchGetDocumentsRequest(메시지)
• BatchGetDocumentsResponse(메시지)
• Document(메시지)
• DocumentChunk(메시지)
• GetDocumentRequest(메시지)
• SearchDocumentChunksRequest(메시지)
• SearchDocumentChunksResponse(메시지)

DeveloperKnowledge

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

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

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

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

BatchGetDocuments
rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse) 각각 전체 마크다운 콘텐츠가 포함된 여러 문서를 가져옵니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/devprofiles.full_control 자세한 내용은 OAuth 2.0 Overview를 참조하세요.

GetDocument
rpc GetDocument(GetDocumentRequest) returns (Document) 전체 마크다운 콘텐츠가 포함된 단일 문서를 가져옵니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/devprofiles.full_control 자세한 내용은 OAuth 2.0 Overview를 참조하세요.

SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse) Google의 개발자 문서에서 개발자 지식을 검색합니다. 이 메서드는 사용자의 질문에 따라 문서 청크를 반환합니다. 동일한 문서의 청크가 여러 개 있을 수 있습니다. 전체 문서를 검색하려면 SearchDocumentChunksResponse.results에서 반환된 DocumentChunk.parent와 함께 DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments를 사용하세요. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/devprofiles.full_control 자세한 내용은 OAuth 2.0 Overview를 참조하세요.

BatchGetDocumentsRequest

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

필드
names[]	string 필수 항목입니다. 가져올 문서의 이름입니다. 한 번에 최대 20개의 문서를 검색할 수 있습니다. 문서는 요청의 names와 동일한 순서로 반환됩니다. 형식: documents/{uri_without_scheme} 예: documents/docs.cloud.google.com/storage/docs/creating-buckets

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 출력 전용입니다. 문서에 대한 설명입니다.

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 출력 전용입니다. 문서 청크의 콘텐츠입니다.

GetDocumentRequest

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

필드
name	string 필수 항목입니다. 검색할 문서 이름입니다. 형식: documents/{uri_without_scheme} 예: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

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

필드
query	string 필수 항목입니다. 사용자가 제공한 원시 쿼리 문자열입니다(예: 'Cloud Storage 버킷을 만드는 방법').
page_size	int32 선택사항입니다. 반환할 최대 결과 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 5개의 결과가 반환됩니다. 최댓값은 20이며, 20을 초과하는 값은 INVALID_ARGUMENT 오류를 발생시킵니다.
page_token	string 선택사항입니다. 이전 SearchDocumentChunks 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

SearchDocumentChunksResponse

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

필드
results[]	DocumentChunk 지정된 쿼리의 검색 결과입니다. 이 목록의 각 DocumentChunk에는 검색어와 관련된 콘텐츠 스니펫이 포함되어 있습니다. DeveloperKnowledge.GetDocument 또는 DeveloperKnowledge.BatchGetDocuments와 함께 각 결과의 DocumentChunk.parent 필드를 사용하여 전체 문서 콘텐츠를 가져옵니다.
next_page_token	string 선택사항입니다. 다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.