Package google.developers.knowledge.v1

インデックス

DeveloperKnowledge

Developer Knowledge API を使用すると、Google の公開デベロッパー ドキュメントにプログラムでアクセスできます。これにより、このナレッジベースを独自のアプリケーションやワークフローに統合できます。

この API は、Google のデベロッパー ドキュメントへの機械可読アクセス用の正規のソースとなるように設計されています。

一般的なユースケースは、まず DeveloperKnowledge.SearchDocumentChunks を使用してクエリに基づいて関連するページ URI を見つけ、次に DeveloperKnowledge.GetDocument または DeveloperKnowledge.BatchGetDocuments を使用して上位の結果のコンテンツ全体を取得することです。

ドキュメントのコンテンツはすべて Markdown 形式で提供されます。

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

複数のドキュメントを取得します。各ドキュメントには完全な Markdown コンテンツが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

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

rpc GetDocument(GetDocumentRequest) returns (Document)

完全な Markdown コンテンツを含む単一のドキュメントを取得します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

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

BatchGetDocumentsRequest

DeveloperKnowledge.BatchGetDocuments のリクエスト メッセージです。

フィールド
names[]

string

必須。取得するドキュメントの名前を指定します。バッチで取得できるドキュメントの最大数は 20 です。ドキュメントは、リクエストの names と同じ順序で返されます。

形式: documents/{uri_without_scheme} 例: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

省略可。ドキュメントの DocumentView を指定します。指定しない場合、DeveloperKnowledge.BatchGetDocuments はデフォルトで DOCUMENT_VIEW_CONTENT になります。

BatchGetDocumentsResponse

DeveloperKnowledge.BatchGetDocuments に対するレスポンス メッセージです。

フィールド
documents[]

Document

リクエストされたドキュメントが含まれます。

ドキュメント

ドキュメントは、デベロッパー ナレッジ コーパスのコンテンツの一部を表します。

フィールド
name

string

ID。ドキュメントのリソース名が含まれます。形式: 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

出力専用。ドキュメントの完全なコンテンツ（Markdown 形式）が含まれます。
description

string

出力専用。ドキュメントの説明を提供します。
data_source

string

出力専用。ドキュメントのデータソースを指定します。データソースの例: firebase.google.com
title

string

出力専用。ドキュメントのタイトルを指定します。
update_time

Timestamp

出力専用。ドキュメントのコンテンツまたはメタデータが最後に更新されたときのタイムスタンプを表します。
view

DocumentView

出力専用。ドキュメントの DocumentView を指定します。

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

出力専用。ドキュメント チャンクのコンテンツが含まれます。
document

Document

出力専用。このチャンクの Document に関するメタデータを表します。この Document メッセージの DocumentView は DOCUMENT_VIEW_BASIC に設定されます。クライアントがメタデータ フィールドのみを必要とする場合に DeveloperKnowledge.GetDocument や DeveloperKnowledge.BatchGetDocuments を呼び出す必要がないように、便宜上ここに含めています。それ以外の場合、クライアントは DeveloperKnowledge.GetDocument または DeveloperKnowledge.BatchGetDocuments を使用してドキュメントのコンテンツ全体を取得する必要があります。

DocumentView

Document のどのフィールドを含めるかを指定します。

列挙型
DOCUMENT_VIEW_UNSPECIFIED デフォルト値 / 未設定値。DocumentView が指定されていない場合のデフォルト値については、各 API メソッドをご覧ください。
DOCUMENT_VIEW_BASIC

基本メタデータ フィールド（name、uri、data_source、title、description、update_time、view）のみが含まれます。

これは DeveloperKnowledge.SearchDocumentChunks のデフォルトのビューです。
DOCUMENT_VIEW_FULL すべての Document フィールドが含まれます。
DOCUMENT_VIEW_CONTENT

DOCUMENT_VIEW_BASIC フィールドと content フィールドが含まれます。

これは、DeveloperKnowledge.GetDocument と DeveloperKnowledge.BatchGetDocuments のデフォルトのビューです。

GetDocumentRequest

DeveloperKnowledge.GetDocument のリクエスト メッセージです。

フィールド
name

string

必須。取得するドキュメントの名前を指定します。形式: documents/{uri_without_scheme} 例: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

省略可。ドキュメントの DocumentView を指定します。指定しない場合、DeveloperKnowledge.GetDocument はデフォルトで DOCUMENT_VIEW_CONTENT になります。

SearchDocumentChunksRequest

DeveloperKnowledge.SearchDocumentChunks のリクエスト メッセージです。

フィールド
query

string

必須。ユーザーが指定した未加工のクエリ文字列（「Cloud Storage バケットを作成する方法」など）を提供します。
page_size

int32

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

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

最大値は 20 です。20 を超える値は INVALID_ARGUMENT エラーになります。
page_token

string

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

string

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

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

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

  • 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 など）。

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

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

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

例:

  • 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 エラーになります。

SearchDocumentChunksResponse

DeveloperKnowledge.SearchDocumentChunks に対するレスポンス メッセージです。

フィールド
results[]

DocumentChunk

指定されたクエリの検索結果が含まれます。このリストの各 DocumentChunk には、検索クエリに関連するコンテンツのスニペットが含まれています。各結果の DocumentChunk.parent フィールドを DeveloperKnowledge.GetDocument または DeveloperKnowledge.BatchGetDocuments とともに使用して、ドキュメントのコンテンツ全体を取得します。
next_page_token

string

省略可。次のページを取得するために page_token として送信できるトークンを提供します。このフィールドを省略すると、後続のページはなくなります。