Package google.developers.knowledge.v1alpha

ดัชนี

DeveloperKnowledge

Developer Knowledge API ให้สิทธิ์เข้าถึงเอกสารประกอบสำหรับนักพัฒนาแอปแบบสาธารณะของ Google แบบเป็นโปรแกรม ซึ่งช่วยให้คุณผสานรวมฐานความรู้นี้เข้ากับแอปพลิเคชันและเวิร์กโฟลว์ของคุณเองได้

API นี้ออกแบบมาให้เป็นแหล่งข้อมูลที่เชื่อถือได้สำหรับการเข้าถึงเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ของ Google ในรูปแบบที่เครื่องอ่านได้

Use Case ทั่วไปคือการใช้ DeveloperKnowledge.SearchDocumentChunks เพื่อค้นหา URI ของหน้าเว็บที่เกี่ยวข้องตามคำค้นหาก่อน แล้วจึงใช้ 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/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/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

ดึงข้อมูลเอกสารเดียวที่มีเนื้อหามาร์กดาวน์ทั้งหมด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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 เดียวกัน หากต้องการดึงข้อมูลเอกสารทั้งหมด ให้ใช้ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments กับ DocumentChunk.parent ที่แสดงใน SearchDocumentChunksResponse.results

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

คำตอบ

คำตอบสำหรับคำค้นหา

ช่อง
answer_text

string

มีข้อความของคำตอบ
citations[]

AnswerCitation

เอาต์พุตเท่านั้น มีการอ้างอิงสำหรับคำตอบ
references[]

AnswerReference

เอาต์พุตเท่านั้น มีข้อมูลอ้างอิงสำหรับคำตอบ

AnswerCitation

ข้อมูลการอ้างอิงสำหรับส่วน

ช่อง
start_index

int32

เอาต์พุตเท่านั้น ระบุจุดเริ่มต้นของกลุ่ม โดยวัดเป็นไบต์ (Unicode UTF-8) รวม หากมีอักขระแบบหลายไบต์ เช่น อักขระที่ไม่ใช่ ASCII การวัดดัชนีจะยาวกว่าความยาวของสตริง
end_index

int32

เอาต์พุตเท่านั้น ระบุจุดสิ้นสุดของกลุ่ม โดยวัดเป็นไบต์ (Unicode UTF-8) หากมีอักขระแบบหลายไบต์ เช่น อักขระที่ไม่ใช่ ASCII การวัดดัชนีจะยาวกว่าความยาวของสตริง
sources[]

CitationSource

เอาต์พุตเท่านั้น มีแหล่งที่มาของการอ้างอิงสำหรับกลุ่มที่ระบุแหล่งที่มา

AnswerReference

แสดงการอ้างอิงถึงแหล่งที่มา

ช่อง
ฟิลด์ Union content มีเนื้อหาของข้อมูลอ้างอิง content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
document_reference

DocumentReference

เอาต์พุตเท่านั้น เอกสารอ้างอิง

CitationSource

แหล่งอ้างอิง

ช่อง
reference_index

int32

เอาต์พุตเท่านั้น มีดัชนีของ Answer.AnswerReference ในฟิลด์ที่ซ้ำได้ references

DocumentReference

แสดงการอ้างอิงถึงเอกสาร

ช่อง
document_chunk

DocumentChunk

เอาต์พุตเท่านั้น มีข้อความในเอกสาร ระบบไม่ได้ตั้งค่าฟิลด์ document_chunk.id และจะปล่อยให้ว่างไว้

AnswerQueryRequest

ขอข้อความสำหรับ DeveloperKnowledge.AnswerQuery

ช่อง
query

string

ต้องระบุ คำค้นหาที่จะตอบ

AnswerQueryResponse

ข้อความตอบกลับสำหรับ DeveloperKnowledge.AnswerQuery

ช่อง
answer

Answer

คำตอบของคำค้นหา

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

ตัวระบุ มีชื่อทรัพยากรของเอกสาร รูปแบบ: 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 แสดงถึงเนื้อหาชิ้นหนึ่งจาก Document ในคลังความรู้ของนักพัฒนาซอฟต์แวร์ หากต้องการดึงเนื้อหาเอกสารทั้งหมด ให้ส่ง parent ไปยัง DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments

ช่อง
parent

string

เอาต์พุตเท่านั้น มีชื่อทรัพยากรของเอกสารที่มาจากก้อนข้อมูลนี้ รูปแบบ: documents/{uri_without_scheme} ตัวอย่าง: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

เอาต์พุตเท่านั้น ระบุรหัสของก้อนข้อมูลนี้ภายในเอกสาร รหัสก้อนข้อมูลจะไม่ซ้ำกันภายในเอกสาร แต่จะไม่ซ้ำกันทั่วโลกในเอกสารต่างๆ รหัสกลุ่มไม่คงที่และอาจเปลี่ยนแปลงเมื่อเวลาผ่านไป
content

string

เอาต์พุตเท่านั้น มีเนื้อหาของเอกสารที่แบ่งเป็นส่วนๆ
document

Document

เอาต์พุตเท่านั้น แสดงข้อมูลเมตาเกี่ยวกับ Document ที่ก้อนข้อมูลนี้มาจาก ระบบจะตั้งค่า DocumentView ของข้อความ Document นี้เป็น DOCUMENT_VIEW_BASIC เราได้รวมไว้ที่นี่เพื่อความสะดวก เพื่อให้ไคลเอ็นต์ไม่ต้องเรียกใช้ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments หากต้องการเฉพาะฟิลด์ข้อมูลเมตา มิฉะนั้น ลูกค้าควรใช้ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments เพื่อดึงเนื้อหาเอกสารทั้งหมด

DocumentView

ระบุว่าจะรวมฟิลด์ใดของ Document

Enum
DOCUMENT_VIEW_UNSPECIFIED ค่าเริ่มต้น / ไม่ได้ตั้งค่า ดูค่าเริ่มต้นของแต่ละเมธอด API หากไม่ได้ระบุ DocumentView
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): การประทับเวลาเมื่อมีการอัปเดตเอกสารครั้งล่าสุด การอัปเดตที่มีความหมายคือการอัปเดตที่เปลี่ยนแปลงเนื้อหา 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 ใช้เครื่องหมายวงเล็บเพื่อจัดกลุ่มลำดับความสำคัญที่ชัดเจน

ตัวอย่าง

  • 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 เพื่อดึงข้อมูลหน้าถัดไปได้ หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป