Method: documents.searchDocumentChunks

Google のデベロッパー向けドキュメント全体でデベロッパーの知識を検索します。このメソッドは、ユーザーのクエリに基づいてドキュメント チャンクを返します。同じドキュメントのチャンクが多数存在する可能性があります。ドキュメント全体を取得するには、SearchDocumentChunksResponse.results で返された DocumentChunk.parent を使用して DeveloperKnowledge.GetDocument または DeveloperKnowledge.BatchGetDocuments を使用します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
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 には、検索クエリに関連するコンテンツのスニペットが含まれています。各結果の DocumentChunk.parent フィールドを DeveloperKnowledge.GetDocument または DeveloperKnowledge.BatchGetDocuments とともに使用して、ドキュメントのコンテンツ全体を取得します。
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

出力専用。ドキュメント チャンクの内容。