Package google.developers.knowledge.v1alpha

ดัชนี

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)

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

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

ต้องใช้ขอบเขต 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

BatchGetDocumentsRequest

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

ช่อง
names[]

string

ต้องระบุ ระบุชื่อเอกสารที่จะดึงข้อมูล เรียกข้อมูลเอกสารได้สูงสุด 20 รายการต่อชุด ระบบจะแสดงผลเอกสารตามลำดับเดียวกับ names ในคำขอ

รูปแบบ: documents/{uri_without_scheme} ตัวอย่าง: documents/docs.cloud.google.com/storage/docs/creating-buckets

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

เอาต์พุตเท่านั้น ระบุคำอธิบายของเอกสาร
title

string

เอาต์พุตเท่านั้น ระบุชื่อเอกสาร

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

เอาต์พุตเท่านั้น มีเนื้อหาของก้อนเอกสาร

GetDocumentRequest

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

ช่อง
name

string

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

SearchDocumentChunksRequest

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

ช่อง
query

string

ต้องระบุ ระบุสตริงการค้นหาดิบที่ผู้ใช้ระบุ เช่น "วิธีสร้างที่เก็บข้อมูล Cloud Storage"
page_size

int32

ไม่บังคับ ระบุจำนวนผลลัพธ์สูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลลัพธ์อย่างน้อย 5 รายการ

ค่าสูงสุดคือ 20 ค่าที่สูงกว่า 20 จะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT
page_token

string

ไม่บังคับ มีโทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ SearchDocumentChunks ก่อนหน้า ระบุค่านี้เพื่อดึงข้อมูลหน้าถัดไป

SearchDocumentChunksResponse

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

ช่อง
results[]

DocumentChunk

มีผลการค้นหาสำหรับคำค้นหาที่ระบุ DocumentChunkแต่ละรายการในรายการนี้มีข้อมูลโค้ดของเนื้อหาที่เกี่ยวข้องกับคำค้นหา ใช้ฟิลด์ DocumentChunk.parent ของผลลัพธ์แต่ละรายการกับ DeveloperKnowledge.GetDocument หรือ DeveloperKnowledge.BatchGetDocuments เพื่อดึงเนื้อหาเอกสารทั้งหมด
next_page_token

string

ไม่บังคับ ระบุโทเค็นที่ส่งเป็น page_token เพื่อดึงข้อมูลหน้าถัดไปได้ หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป