Method: documents.searchDocumentChunks

Google のデベロッパー ドキュメント全体でデベロッパーの知識を検索します。ユーザーのクエリに基づいて DocumentChunk を返します。同じ Document から複数のチャンクが返されることがあります。ドキュメント全体を取得するには、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 呼び出しから受信したページトークンが含まれます。後続のページを取得するにはこれを指定します。
filter

string

省略可。検索結果に厳密なフィルタを適用します。この式は、https://google.aip.dev/160 で説明されている構文のサブセットをサポートしています。

documents.searchDocumentChunks は DocumentChunk を返しますが、フィルタは DocumentChunk.document フィールドに適用されます。

フィルタリングに対応するフィールド:

  • dataSource（STRING）: ドキュメントのソース（docs.cloud.google.com など）。コーパス内のデータソースの完全なリストについては、https://developers.google.com/knowledge/reference/corpus-reference をご覧ください。
  • updateTime（TIMESTAMP）: ドキュメントが最後に意味のある更新されたときのタイムスタンプ。意味のある更新とは、ドキュメントの Markdown コンテンツまたはメタデータを変更する更新です。
  • uri（STRING）: ドキュメント URI（https://docs.cloud.google.com/bigquery/docs/tables など）。

STRING フィールドでは、文字列全体に対する完全一致 の =（等しい）演算子と !=（等しくない）演算子がサポートされています。部分一致、接頭辞一致、正規表現一致はサポートされていません。

TIMESTAMP フィールドでは、=、<、<=、>、>= 演算子がサポートされています。タイムスタンプは RFC-3339 形式（"2025-01-01T00:00:00Z" など）にする必要があります。

式は、論理演算子 AND、OR、NOT（または -）を使用して組み合わせることができます。OR は AND よりも優先順位が高くなります。優先順位を明示的にグループ化するには、かっこを使用します。

例:

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

filter 文字列は 500 文字以下にする必要があります。500 文字を超える値は INVALID_ARGUMENT エラーになります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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
  • https://www.googleapis.com/auth/cloud-platform

詳細については、OAuth 2.0 Overview をご覧ください。