Method: documents.searchDocumentChunks

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
query

string

必須。ユーザーが提供した元のクエリ文字列（「Cloud Storage バケットを作成する方法」など）を提供します。クエリは 500 文字以内で指定してください。500 文字を超える値は INVALID_ARGUMENT エラーになります。
pageSize

integer

省略可。返す結果の最大数を指定します。サービスから返される数は、この値より少ない場合があります。

指定されていない場合は、最大で 5 件の結果が返されます。

最大値は 100 です。100 を超える値は 100 に強制変換されます。
pageToken

string

省略可。前回の documents.searchDocumentChunks 呼び出しから受け取ったページトークンが含まれます。後続のページを取得するにはこれを指定します。
filter

string

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

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

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

  • content_length_bytes（INTEGER）: Document.content フィールドの長さ（バイト単位）。
  • data_source（STRING）: ドキュメントのソース（例: docs.cloud.google.com）。コーパス内のデータソースの完全なリストについては、https://developers.google.com/knowledge/reference/corpus-reference をご覧ください。
  • update_time（TIMESTAMP）: ドキュメントが最後に更新されたときのタイムスタンプ。意味のある更新とは、ドキュメントのマークダウン コンテンツまたはメタデータを変更する更新のことです。
  • uri（STRING）: ドキュメント URI（例: https://docs.cloud.google.com/bigquery/docs/tables）。

INTEGER フィールドは、=、<、<=、>、>= 演算子をサポートしています。

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

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

注: フィールド名は snake_case で指定する必要があります（例: data_source）。フィルタリング式の右側の値は、二重引用符で囲まれた文字列リテラルである必要があります（例: "docs.cloud.google.com"）。

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

例:

  • フィルタ条件（Document.content_length_bytes）: content_length_bytes < 50000
  • 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 エラーになります。

リクエストの本文

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

レスポンスの本文

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

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