ไลบรารีของไคลเอ็นต์ Developer Knowledge API

หน้านี้แสดงวิธีเริ่มต้นใช้งานไลบรารีของไคลเอ็นต์ Cloud สำหรับ Developer Knowledge API ไลบรารีของไคลเอ็นต์มีประเภทที่เหมาะสม การตรวจสอบสิทธิ์ในตัว การแบ่งหน้าอัตโนมัติ และการจัดการการลองใหม่ ซึ่งจะช่วยลดปริมาณโค้ดที่คุณต้องเขียนแทนที่จะสร้างคำขอ HTTP ดิบ

ดูข้อมูลเพิ่มเติมเกี่ยวกับไลบรารีของไคลเอ็นต์สำหรับ Google APIs ได้ที่หัวข้อคำอธิบายไลบรารีของไคลเอ็นต์

เคล็ดลับ: หากต้องการดูตัวอย่างโค้ด Go, Java, Node.js และ Python แบบสมบูรณ์สำหรับการค้นหา กลุ่มเอกสาร การดึงข้อมูลเอกสาร และการสร้างคำตอบที่อิงตามข้อมูล โปรดดูคู่มือฉบับย่อ: ใช้ไลบรารีของไคลเอ็นต์กับ Developer Knowledge API

ติดตั้งไลบรารีของไคลเอ็นต์

เลือกภาษาโปรแกรมเพื่อติดตั้งไลบรารีไคลเอ็นต์ Developer Knowledge API อย่างเป็นทางการ

Go

เพิ่มโมดูลลงในโปรเจ็กต์ Go

go get cloud.google.com/go/developerknowledge/apiv1

ดูข้อมูลเพิ่มเติมได้ที่ การตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ Go

Java

หากใช้ Maven ให้เพิ่มทรัพยากร Dependency ต่อไปนี้ลงในไฟล์ pom.xml

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-developer-knowledge</artifactId>
  <version>0.6.0</version>
</dependency>

หากใช้ Gradle ให้เพิ่มทรัพยากร Dependency ต่อไปนี้ลงในไฟล์ build.gradle

implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'

ดูข้อมูลเพิ่มเติมได้ที่ การตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ Java

Node.js และ TypeScript

ติดตั้งแพ็กเกจโดยใช้ npm ดังนี้

npm install @google/developer-knowledge

ดูข้อมูลเพิ่มเติมได้ที่ การตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ Node.js

PHP

ติดตั้งแพ็กเกจโดยใช้ Composer ดังนี้

composer require google/developer-knowledge

ดูข้อมูลเพิ่มเติมได้ที่การใช้ PHP ใน Google Cloud

Python

ติดตั้งแพ็กเกจโดยใช้ pip ดังนี้

pip install --upgrade google-developer-knowledge

ดูข้อมูลเพิ่มเติมได้ที่ การตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ Python

Ruby

ติดตั้ง Gem

gem install google-developers-developer_knowledge

ดูข้อมูลเพิ่มเติมได้ที่ การตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ Ruby

ตั้งค่าการตรวจสอบสิทธิ์

ก่อนที่จะส่งคำขอ API โปรดตรวจสอบว่าคุณได้เปิดใช้ Developer Knowledge API ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google แล้ว

ไลบรารีของไคลเอ็นต์รองรับข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) เพื่อตรวจสอบสิทธิ์การเรียก Developer Knowledge API ไลบรารีจะค้นหา ข้อมูลเข้าสู่ระบบในชุดตำแหน่งที่กำหนดไว้ และใช้ข้อมูลเข้าสู่ระบบเหล่านั้นเพื่อ ตรวจสอบสิทธิ์คำขอไปยัง API ADC ช่วยให้คุณใช้ข้อมูลเข้าสู่ระบบกับแอปพลิเคชันได้ในสภาพแวดล้อมต่างๆ เช่น การพัฒนาในเครื่องหรือเวอร์ชันที่ใช้งานจริง โดยไม่ต้องแก้ไขโค้ดของแอปพลิเคชัน

สำหรับสภาพแวดล้อมที่ใช้งานจริง วิธีตั้งค่า ADC จะขึ้นอยู่กับบริการและบริบท ดังนี้

• สภาพแวดล้อม Google Cloud: เมื่อแอปพลิเคชันทํางานบน Cloud Run, Google Kubernetes Engine, Compute Engine หรือฟังก์ชัน Cloud Run ADC จะใช้บัญชีบริการที่แนบกับทรัพยากรการประมวลผลโดยอัตโนมัติ
• สภาพแวดล้อมภายนอกหรือในองค์กร: ใช้การรวมศูนย์ Workload Identity หรือตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS เป็นเส้นทางของไฟล์การกำหนดค่าข้อมูลเข้าสู่ระบบ

ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือกข้อมูลเข้าสู่ระบบเวอร์ชันที่ใช้งานจริงได้ที่ ตั้งค่าข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน

สำหรับสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ในเครื่อง คุณสามารถตั้งค่า ADC ด้วยข้อมูลเข้าสู่ระบบที่เชื่อมโยงกับการรับรองที่เชื่อมโยงกับบัญชี Google ได้โดยทำดังนี้

1. ติดตั้งและเริ่มต้น gcloud CLI

2. สร้างข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ในเครื่องสำหรับบัญชี Google โดยทำดังนี้

   gcloud auth application-default login
   

   หน้าจอลงชื่อเข้าใช้จะปรากฏขึ้น หลังจากลงชื่อเข้าใช้แล้ว ระบบจะจัดเก็บข้อมูลเข้าสู่ระบบไว้ใน ไฟล์ข้อมูลเข้าสู่ระบบในเครื่องที่ ADC ใช้

แหล่งข้อมูลเพิ่มเติม

เลือกแท็บภาษาเพื่อค้นหาลิงก์ไปยังเอกสารอ้างอิง API, ตัวอย่างโค้ด แนวทางปฏิบัติแนะนำ, เครื่องมือติดตามปัญหา และที่เก็บซอร์สโค้ดสำหรับไลบรารีของไคลเอ็นต์แต่ละรายการ

Go

รายการต่อไปนี้มีลิงก์ไปยังแหล่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับไคลเอ็นต์ ไลบรารีสำหรับ Go

• เอกสารอ้างอิง API
• แพ็กเกจใน pkg.go.dev
• ตัวอย่างโค้ดใน GitHub
• แนวทางปฏิบัติแนะนำสำหรับไลบรารีของไคลเอ็นต์
• เครื่องมือติดตามปัญหา
• ซอร์สโค้ด

Java

รายการต่อไปนี้มีลิงก์ไปยังแหล่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับไลบรารีของไคลเอ็นต์สำหรับ Java

• เอกสารอ้างอิง API
• อาร์ติแฟกต์ใน Maven Central
• ตัวอย่างโค้ดใน GitHub
• แนวทางปฏิบัติแนะนำสำหรับไลบรารีของไคลเอ็นต์
• เครื่องมือติดตามปัญหา
• ซอร์สโค้ด

Node.js และ TypeScript

รายการต่อไปนี้มีลิงก์ไปยังแหล่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับไลบรารีไคลเอ็นต์ สำหรับ Node.js และ TypeScript

• แพ็กเกจใน npm
• ตัวอย่างโค้ดใน GitHub
• แนวทางปฏิบัติแนะนำสำหรับไลบรารีของไคลเอ็นต์
• เครื่องมือติดตามปัญหา
• ซอร์สโค้ด

PHP

รายการต่อไปนี้มีลิงก์ไปยังแหล่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับไลบรารีของไคลเอ็นต์สำหรับ PHP

• เอกสารอ้างอิง API
• แพ็กเกจใน Packagist
• ตัวอย่างโค้ดใน GitHub
• แนวทางปฏิบัติแนะนำสำหรับไลบรารีของไคลเอ็นต์
• เครื่องมือติดตามปัญหา
• ซอร์สโค้ด

Python

รายการต่อไปนี้มีลิงก์ไปยังแหล่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับไลบรารีของไคลเอ็นต์สำหรับ Python

• เอกสารอ้างอิง API
• แพ็กเกจใน PyPI
• ตัวอย่างโค้ดใน GitHub
• แนวทางปฏิบัติแนะนำสำหรับไลบรารีของไคลเอ็นต์
• เครื่องมือติดตามปัญหา
• ซอร์สโค้ด

Ruby

รายการต่อไปนี้มีลิงก์ไปยังแหล่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับไลบรารีไคลเอ็นต์สำหรับ Ruby

• เอกสารอ้างอิง API
• Gem ใน RubyGems
• ตัวอย่างโค้ดใน GitHub
• แนวทางปฏิบัติแนะนำสำหรับไลบรารีของไคลเอ็นต์
• เครื่องมือติดตามปัญหา
• ซอร์สโค้ด

ขั้นตอนถัดไป

• ทําตามคู่มือเริ่มต้นใช้งานไลบรารีของไคลเอ็นต์เพื่อดูและเรียกใช้โค้ดตัวอย่าง สําหรับ AnswerQuery, SearchDocumentChunks, GetDocument และ BatchGetDocuments
• ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวกรองการค้นหา การแบ่งหน้า และมาสก์ฟิลด์ได้ในค้นหาและดึงข้อมูลเอกสาร
• ใช้การสร้างที่อิงตามข้อมูลกับสร้างคำตอบจากเอกสารประกอบ
• ดูกลยุทธ์การลองใหม่และรหัสสถานะได้ใน การจัดการข้อผิดพลาด การจำกัดอัตราคำขอ และการจัดการโควต้า
• เรียกดูข้อมูลอ้างอิงของคลังข้อความเพื่อดูโดเมนเอกสารประกอบทั้งหมดที่รองรับ