การฝังคือการแสดงตัวเลขของการป้อนข้อความ ช่วยเปิดกรณีการใช้งานเฉพาะที่หลากหลาย เช่น การจัดกลุ่ม การวัดความคล้ายคลึงกัน และการดึงข้อมูล โปรดดูข้อมูลเบื้องต้นในคู่มือการฝัง
เมธอด: model.embedContent
สร้างเวกเตอร์การฝังข้อความจากอินพุต Content
โดยใช้โมเดลการฝัง Gemini ที่ระบุ
ปลายทาง
โพสต์
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent
พารามิเตอร์เส้นทาง
model
string
ต้องระบุ ชื่อทรัพยากรของโมเดล ซึ่งจะเป็นรหัสให้โมเดลใช้งาน
ชื่อนี้ควรตรงกับชื่อโมเดลที่แสดงผลโดยเมธอด models.list
รูปแบบ: models/{model}
จะอยู่ในรูปแบบ models/{model}
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
content
object (Content
)
ต้องระบุ เนื้อหาที่จะฝัง ระบบจะนับเฉพาะช่อง parts.text
เท่านั้น
taskType
enum (TaskType
)
ไม่บังคับ ประเภทงานที่ไม่บังคับซึ่งจะใช้การฝัง ตั้งค่าได้เฉพาะ models/embedding-001
title
string
ไม่บังคับ ชื่อที่ไม่บังคับสำหรับข้อความ ใช้งานได้เมื่อ TaskType เป็น RETRIEVAL_DOCUMENT
เท่านั้น
หมายเหตุ: การระบุ title
สำหรับ RETRIEVAL_DOCUMENT
จะทำให้การฝังมีคุณภาพดีขึ้นสำหรับการดึงข้อมูล
outputDimensionality
integer
ไม่บังคับ ขนาดที่ลดลง (ไม่บังคับ) สำหรับการฝังเอาต์พุต หากมีการตั้งค่า ระบบจะตัดทอนค่าที่มากเกินไปในการฝังเอาต์พุตออกจากส่วนท้าย รองรับโดยรุ่นใหม่กว่าตั้งแต่ปี 2024 เท่านั้น คุณไม่สามารถตั้งค่านี้ได้หากใช้รูปแบบก่อนหน้า (models/embedding-001
)
ตัวอย่างคำขอ
Python
Node.js
เปลือกหอย
เนื้อหาการตอบกลับ
การตอบกลับ EmbedContentRequest
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
embedding
object (ContentEmbedding
)
เอาต์พุตเท่านั้น การฝังที่สร้างจากเนื้อหาอินพุต
การแสดง JSON |
---|
{
"embedding": {
object ( |
เมธอด: model.batchEmbedContents
- ปลายทาง
- พารามิเตอร์เส้นทาง
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ตัวอย่างคำขอ
- EmbedContentRequest
สร้างเวกเตอร์ที่ฝังหลายรายการจากอินพุต Content
ซึ่งประกอบด้วยกลุ่มสตริงที่แสดงเป็นออบเจ็กต์ EmbedContentRequest
ปลายทาง
โพสต์
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents
พารามิเตอร์เส้นทาง
model
string
ต้องระบุ ชื่อทรัพยากรของโมเดล ซึ่งจะเป็นรหัสให้โมเดลใช้งาน
ชื่อนี้ควรตรงกับชื่อโมเดลที่แสดงผลโดยเมธอด models.list
รูปแบบ: models/{model}
จะอยู่ในรูปแบบ models/{model}
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
requests[]
object (EmbedContentRequest
)
ต้องระบุ คำขอฝังสำหรับกลุ่ม โมเดลในคำขอเหล่านี้แต่ละรายการต้องตรงกับโมเดลที่ระบุ BatchEmbedContentsRequest.model
ตัวอย่างคำขอ
Python
Node.js
เปลือกหอย
เนื้อหาการตอบกลับ
การตอบกลับ BatchEmbedContentsRequest
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
embeddings[]
object (ContentEmbedding
)
เอาต์พุตเท่านั้น การฝังสำหรับแต่ละคำขอ ในลำดับเดียวกับที่ระบุไว้ในคำขอแบบกลุ่ม
การแสดง JSON |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
คำขอที่มี Content
สำหรับโมเดลที่จะฝัง
model
string
ต้องระบุ ชื่อทรัพยากรของโมเดล ซึ่งจะเป็นรหัสให้โมเดลใช้งาน
ชื่อนี้ควรตรงกับชื่อโมเดลที่แสดงผลโดยเมธอด models.list
รูปแบบ: models/{model}
content
object (Content
)
ต้องระบุ เนื้อหาที่จะฝัง ระบบจะนับเฉพาะช่อง parts.text
เท่านั้น
taskType
enum (TaskType
)
ไม่บังคับ ประเภทงานที่ไม่บังคับซึ่งจะใช้การฝัง ตั้งค่าได้เฉพาะ models/embedding-001
title
string
ไม่บังคับ ชื่อที่ไม่บังคับสำหรับข้อความ ใช้งานได้เมื่อ TaskType เป็น RETRIEVAL_DOCUMENT
เท่านั้น
หมายเหตุ: การระบุ title
สำหรับ RETRIEVAL_DOCUMENT
จะทำให้การฝังมีคุณภาพดีขึ้นสำหรับการดึงข้อมูล
outputDimensionality
integer
ไม่บังคับ ขนาดที่ลดลง (ไม่บังคับ) สำหรับการฝังเอาต์พุต หากมีการตั้งค่า ระบบจะตัดทอนค่าที่มากเกินไปในการฝังเอาต์พุตออกจากส่วนท้าย รองรับโดยรุ่นใหม่กว่าตั้งแต่ปี 2024 เท่านั้น คุณไม่สามารถตั้งค่านี้ได้หากใช้รูปแบบก่อนหน้า (models/embedding-001
)
ContentEmbedding
รายการ Float ที่แสดงการฝัง
values[]
number
ค่าที่ฝัง
การแสดง JSON |
---|
{ "values": [ number ] } |
TaskType
ประเภทงานที่จะใช้การฝัง
Enum | |
---|---|
TASK_TYPE_UNSPECIFIED |
ไม่ได้ตั้งค่า ซึ่งจะเป็นค่าเริ่มต้นเป็นค่า enum อื่นๆ ค่าใดค่าหนึ่ง |
RETRIEVAL_QUERY |
ระบุว่าข้อความที่ระบุเป็นคำค้นหาในการตั้งค่าการค้นหา/ดึงข้อมูล |
RETRIEVAL_DOCUMENT |
ระบุว่าข้อความที่ระบุเป็นเอกสารจากคลังข้อมูลที่กำลังค้นหา |
SEMANTIC_SIMILARITY |
ระบุว่าจะใช้ข้อความที่กำหนดสำหรับ STS |
CLASSIFICATION |
ระบุว่าข้อความที่ให้ไว้จะได้รับการจัดประเภท |
CLUSTERING |
ระบุว่าจะมีการใช้การฝังสำหรับการจัดคลัสเตอร์ |
QUESTION_ANSWERING |
ระบุว่าจะใช้ข้อความที่ระบุในการตอบคำถาม |
FACT_VERIFICATION |
ระบุว่าจะใช้ข้อความที่ระบุสำหรับการยืนยันข้อเท็จจริง |