Method: documents.searchDocumentChunks

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

HTTP 요청

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

URL은 gRPC 트랜스코딩 문법을 사용합니다.

쿼리 매개변수

매개변수
query

string

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

integer

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

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

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

string

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

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

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

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
필드
results[]

object (DocumentChunk)

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

string

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/devprofiles.full_control

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

DocumentChunk

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

JSON 표현 
{
  "parent": string,
  "id": string,
  "content": string
}
필드
parent

string

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

string

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

string

출력 전용입니다. 문서 청크의 콘텐츠입니다.