Method: models.batchEmbedContents

สร้างการฝังหลายรายการจากโมเดลที่ได้รับข้อความอินพุตในการเรียกแบบพร้อมกัน

คำขอ HTTP

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:batchEmbedContents

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
model

string

ต้องระบุ ชื่อทรัพยากรของโมเดล ใช้เป็นรหัสให้โมเดลใช้

ชื่อนี้ควรตรงกับชื่อโมเดลที่เมธอด models.list แสดงผล

รูปแบบ: models/{model}

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "requests": [
    {
      object (EmbedContentRequest)
    }
  ]
}
ช่อง
requests[]

object (EmbedContentRequest)

ต้องระบุ ฝังคำขอสำหรับกลุ่ม โมเดลในแต่ละคำขอเหล่านี้ต้องตรงกับโมเดลที่ระบุ BatchEmbedContentsRequest.model

เนื้อหาการตอบกลับ

การตอบกลับ BatchEmbedContentsRequest

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "embeddings": [
    {
      object (ContentEmbedding)
    }
  ]
}
ช่อง
embeddings[]

object (ContentEmbedding)

เอาต์พุตเท่านั้น การฝังสำหรับแต่ละคำขอ โดยเรียงตามลำดับเดียวกับที่ให้ไว้ในคำขอแบบกลุ่ม

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

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

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์

EmbedContentRequest

คำขอที่มี Content สำหรับโมเดลที่จะฝัง

การแสดง JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
ช่อง
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) ระบุค่านี้ไม่ได้