Package google.developers.knowledge.v1

インデックス

DeveloperKnowledge

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

この API は、Google のデベロッパー向けドキュメントに機械で読み取り可能なアクセスを提供する正規のソースとなるように設計されています。

一般的なユースケースは、まず DeveloperKnowledge.SearchDocumentChunks を使用してクエリに基づいて関連するドキュメント チャンクを検索し、次にドキュメント リソース名（DocumentChunk.parent や documents/{uri_without_scheme} など）を指定して DeveloperKnowledge.GetDocument または DeveloperKnowledge.BatchGetDocuments を使用して、上位の結果の完全なコンテンツを取得することです。

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

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

グラウンディングされた生成を使用してクエリに回答します。

認可スコープ

次の 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 をご覧ください。
BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

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

認可スコープ

次の 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 をご覧ください。
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Markdown コンテンツ全体を含む 1 つのドキュメントを取得します。

認可スコープ

次の 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 をご覧ください。
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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

回答

クエリに対する回答。

フィールド
answer_text

string

回答のテキストが含まれます。
citations[]

AnswerCitation

出力専用。回答の引用が含まれます。
references[]

AnswerReference

出力専用。回答の参照が含まれます。

AnswerCitation

セグメントの引用情報。

フィールド
start_index

int32

出力専用。セグメントの開始位置をバイト単位（UTF-8 Unicode）で示します（両端を含む）。ASCII 以外の文字などのマルチバイト文字がある場合、インデックスの測定値は文字列の長さよりも長くなります。
end_index

int32

出力専用。セグメントの終了位置をバイト単位（UTF-8 Unicode）で示します（終点を含まない）。ASCII 以外の文字などのマルチバイト文字がある場合、インデックスの測定値は文字列の長さよりも長くなります。
sources[]

CitationSource

出力専用。アトリビューション セグメントの引用元が含まれます。

AnswerReference

ソースへの参照を表します。

フィールド
共用体フィールド content。参照のコンテンツが含まれます。content は次のいずれかになります。
document_reference

DocumentReference

出力専用。参照ドキュメント。

CitationSource

引用元。

フィールド
reference_index

int32

出力専用。references 繰り返しフィールド内の Answer.AnswerReference のインデックスが含まれます。

DocumentReference

ドキュメントへの参照を表します。

フィールド
document_chunk

DocumentChunk

出力専用。ドキュメント チャンクが含まれます。document_chunk.id フィールドは設定されず、空になります。

AnswerQueryRequest

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

フィールド
query

string

必須。回答するクエリ。
filter

string

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

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

  • content_length_bytes（整数）: 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"）にする必要があります。

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

AnswerQueryResponse

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

フィールド
answer

Answer

クエリに対する回答。

BatchGetDocumentsRequest

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

フィールド
names[]

string

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

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

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

DocumentView

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

BatchGetDocumentsResponse

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

フィールド
documents[]

Document

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

ドキュメント

ドキュメントは、Developer Knowledge コーパスのドキュメント ページを表します。たとえば、https://docs.cloud.google.com/storage/docs/creating-buckets のページなどです。

フィールド
name

string

ID。ドキュメントのリソース名が含まれます。形式: documents/{uri_without_scheme} 例: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

出力専用。コンテンツの URI（https://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 を指定します。
content_length_bytes

int32

出力専用。content フィールドの長さ（バイト単位）。

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 を使用してドキュメントのコンテンツ全体を取得する必要があります。
relevance_score

double

出力専用。検索クエリに対するチャンクの関連性スコアを表します。スコアが高いほど、チャンクの関連性が高いことを示します。スコアの範囲は [0.0, 1.0] です。

DocumentView

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

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

基本的なメタデータ フィールドのみが含まれます。

  • name
  • uri
  • data_source
  • title
  • description
  • update_time
  • view
  • content_length_bytes

これは 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

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

DocumentView

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

SearchDocumentChunksRequest

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

フィールド
query

string

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

int32

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

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

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

string

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

string

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

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

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

  • content_length_bytes（整数）: 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 エラーになります。

SearchDocumentChunksResponse

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

フィールド
results[]

DocumentChunk

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

string

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