Batch API

Gemini API รองรับ Batch API ซึ่งช่วยให้คุณประมวลผลคำขอหลายรายการในการเรียกใช้ครั้งเดียวได้ ดูรายละเอียดเพิ่มเติมได้ที่คู่มือ Batch API

เมธอด: models.batchGenerateContent

จัดคิวคำขอ models.generateContent เป็นชุดสำหรับการประมวลผลแบบเป็นชุด

ปลายทาง

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:batchGenerateContent

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

batch.model string

ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม

รูปแบบ: models/{model} ซึ่งจะอยู่ในรูปแบบ models/{model}

เนื้อความของคำขอ

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

ฟิลด์
batch.name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของกลุ่ม

รูปแบบ: batches/{batchId}

batch.displayName string

ต้องระบุ ชื่อที่ผู้ใช้กำหนดของกลุ่มนี้

batch.inputConfig object (InputConfig)

ต้องระบุ การกำหนดค่าอินพุตของอินสแตนซ์ที่ใช้ประมวลผลแบบเป็นชุด

batch.output object (GenerateContentBatchOutput)

เอาต์พุตเท่านั้น เอาต์พุตของคำขอแบบกลุ่ม

batch.createTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างกลุ่ม

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batch.endTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่การประมวลผลแบบกลุ่มเสร็จสมบูรณ์

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batch.updateTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตกลุ่มครั้งล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batch.batchStats object (BatchStats)

เอาต์พุตเท่านั้น สถิติเกี่ยวกับแบทช์

batch.state enum (BatchState)

เอาต์พุตเท่านั้น สถานะของกลุ่ม

batch.priority string (int64 format)

ไม่บังคับ ลำดับความสำคัญของกลุ่ม ระบบจะประมวลผลกลุ่มที่มีค่าลำดับความสำคัญสูงกว่าก่อนกลุ่มที่มีค่าลำดับความสำคัญต่ำกว่า อนุญาตให้ใช้ค่าลบได้ ค่าเริ่มต้นคือ 0

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation

เมธอด: models.asyncBatchEmbedContent

จัดคิวคำขอ models.embedContent เป็นชุดสำหรับการประมวลผลแบบเป็นชุด เรามีแฮนเดิล models.batchEmbedContents ใน GenerativeService แต่มีการซิงค์แล้ว เราจึงตั้งชื่อว่า Async เพื่อไม่ให้เกิดความสับสน

ปลายทาง

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:asyncBatchEmbedContent

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

batch.model string

ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม

รูปแบบ: models/{model} ซึ่งจะอยู่ในรูปแบบ models/{model}

เนื้อความของคำขอ

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

ฟิลด์
batch.name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของกลุ่ม

รูปแบบ: batches/{batchId}

batch.displayName string

ต้องระบุ ชื่อที่ผู้ใช้กำหนดของกลุ่มนี้

batch.inputConfig object (InputEmbedContentConfig)

ต้องระบุ การกำหนดค่าอินพุตของอินสแตนซ์ที่ใช้ประมวลผลแบบเป็นชุด

batch.output object (EmbedContentBatchOutput)

เอาต์พุตเท่านั้น เอาต์พุตของคำขอแบบกลุ่ม

batch.createTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างกลุ่ม

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batch.endTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่การประมวลผลแบบกลุ่มเสร็จสมบูรณ์

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batch.updateTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตกลุ่มครั้งล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batch.batchStats object (EmbedContentBatchStats)

เอาต์พุตเท่านั้น สถิติเกี่ยวกับแบทช์

batch.state enum (BatchState)

เอาต์พุตเท่านั้น สถานะของกลุ่ม

batch.priority string (int64 format)

ไม่บังคับ ลำดับความสำคัญของกลุ่ม ระบบจะประมวลผลกลุ่มที่มีค่าลำดับความสำคัญสูงกว่าก่อนกลุ่มที่มีค่าลำดับความสำคัญต่ำกว่า อนุญาตให้ใช้ค่าลบได้ ค่าเริ่มต้นคือ 0

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation

เมธอด: batches.get

รับสถานะล่าสุดของการดำเนินการที่ใช้เวลานาน ไคลเอ็นต์สามารถใช้วิธีนี้เพื่อสำรวจผลการดำเนินการเป็นระยะๆ ตามที่บริการ API แนะนำ

ปลายทาง

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

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

name string

ชื่อของทรัพยากรการดำเนินการ ซึ่งจะอยู่ในรูปแบบ batches/{batches}

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation

เมธอด: batches.list

แสดงการดำเนินการในรายการที่ตรงกับตัวกรองที่ระบุในคำขอ หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ ระบบจะแสดง UNIMPLEMENTED

ปลายทาง

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

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

name string

ชื่อของทรัพยากรหลักของการดำเนินการ ซึ่งจะอยู่ในรูปแบบ batches

พารามิเตอร์การค้นหา

filter string

ตัวกรองรายการมาตรฐาน

pageSize integer

ขนาดหน้าของรายการมาตรฐาน

pageToken string

โทเค็นหน้ารายการมาตรฐาน

returnPartialSuccess boolean

เมื่อตั้งค่าเป็น true ระบบจะแสดงผลการดำเนินการที่เข้าถึงได้ตามปกติ และแสดงผลการดำเนินการที่เข้าถึงไม่ได้ในช่อง [ListOperationsResponse.unreachable]

ซึ่งจะเกิดขึ้นได้ก็ต่อเมื่อtrueเมื่ออ่านในคอลเล็กชัน เช่น เมื่อตั้งค่า parent เป็น "projects/example/locations/-"

โดยค่าเริ่มต้น ระบบจะไม่รองรับฟิลด์นี้ และจะทำให้เกิดUNIMPLEMENTEDข้อผิดพลาดหากตั้งค่าไว้ เว้นแต่จะมีการระบุไว้เป็นอย่างอื่นในเอกสารประกอบเฉพาะบริการหรือผลิตภัณฑ์

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ ListOperationsResponse

วิธีการ: batches.cancel

เริ่มการยกเลิกแบบไม่พร้อมกันในการดำเนินการที่ใช้เวลานาน เซิร์ฟเวอร์จะพยายามยกเลิกการดำเนินการอย่างเต็มที่ แต่ไม่รับประกันว่าจะสำเร็จ หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ ระบบจะแสดง google.rpc.Code.UNIMPLEMENTED ไคลเอ็นต์สามารถใช้ Operations.GetOperation หรือวิธีอื่นๆ เพื่อตรวจสอบว่าการยกเลิกสำเร็จหรือไม่ หรือการดำเนินการเสร็จสมบูรณ์แม้จะมีการยกเลิกหรือไม่ เมื่อยกเลิกสำเร็จ ระบบจะไม่ลบการดำเนินการ แต่จะเปลี่ยนเป็นการดำเนินการที่มีค่า Operation.error โดยมี google.rpc.Status.code เป็น 1 ซึ่งสอดคล้องกับ Code.CANCELLED

ปลายทาง

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

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

name string

ชื่อของทรัพยากรการดำเนินการที่จะยกเลิก ซึ่งจะอยู่ในรูปแบบ batches/{batches}

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นออบเจ็กต์ JSON ว่าง

วิธีการ: batches.delete

ลบการดำเนินการที่ใช้เวลานาน วิธีนี้บ่งบอกว่าไคลเอ็นต์ไม่สนใจผลการดำเนินการอีกต่อไป แต่จะไม่ยกเลิกการดำเนินการ หากเซิร์ฟเวอร์ไม่รองรับวิธีนี้ ระบบจะแสดง google.rpc.Code.UNIMPLEMENTED

ปลายทาง

ลบ https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

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

name string

ชื่อของทรัพยากรการดำเนินการที่จะลบ ซึ่งจะอยู่ในรูปแบบ batches/{batches}

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นออบเจ็กต์ JSON ว่าง

GenerateContentBatch

ทรัพยากรที่แสดงถึงคำขอ GenerateContent แบบเป็นกลุ่ม

ฟิลด์
model string

ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม

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

name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของกลุ่ม

รูปแบบ: batches/{batchId}

displayName string

ต้องระบุ ชื่อที่ผู้ใช้กำหนดของกลุ่มนี้

inputConfig object (InputConfig)

ต้องระบุ การกำหนดค่าอินพุตของอินสแตนซ์ที่ใช้ประมวลผลแบบเป็นชุด

output object (GenerateContentBatchOutput)

เอาต์พุตเท่านั้น เอาต์พุตของคำขอแบบกลุ่ม

createTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างกลุ่ม

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

endTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่การประมวลผลแบบกลุ่มเสร็จสมบูรณ์

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

updateTime string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตกลุ่มครั้งล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

batchStats object (BatchStats)

เอาต์พุตเท่านั้น สถิติเกี่ยวกับแบทช์

state enum (BatchState)

เอาต์พุตเท่านั้น สถานะของกลุ่ม

priority string (int64 format)

ไม่บังคับ ลำดับความสำคัญของกลุ่ม ระบบจะประมวลผลกลุ่มที่มีค่าลำดับความสำคัญสูงกว่าก่อนกลุ่มที่มีค่าลำดับความสำคัญต่ำกว่า อนุญาตให้ใช้ค่าลบได้ ค่าเริ่มต้นคือ 0

การแสดง JSON 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputConfig

กำหนดค่าอินพุตสำหรับคำขอแบบกลุ่ม

ฟิลด์
source Union type
ต้องระบุ แหล่งที่มาของอินพุต source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
fileName string

ชื่อของ File ที่มีคำขออินพุต

requests object (InlinedRequests)

คำขอที่จะประมวลผลในกลุ่ม

การแสดง JSON 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

InlinedRequests

คำขอที่จะประมวลผลในกลุ่มหากระบุเป็นส่วนหนึ่งของคำขอสร้างกลุ่ม

ฟิลด์
requests[] object (InlinedRequest)

ต้องระบุ คำขอที่จะประมวลผลในกลุ่ม

การแสดง JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

คำขอที่จะประมวลผลในกลุ่ม

ฟิลด์
request object (GenerateContentRequest)

ต้องระบุ คำขอที่จะประมวลผลในกลุ่ม

metadata object (Struct format)

ไม่บังคับ ข้อมูลเมตาที่จะเชื่อมโยงกับคำขอ

การแสดง JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

เอาต์พุตของคำขอแบบกลุ่ม โดยจะแสดงในฟิลด์ BatchGenerateContentResponse หรือ GenerateContentBatch.output

ฟิลด์
output Union type
เอาต์พุตของคำขอแบบกลุ่ม output ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
responsesFile string

เอาต์พุตเท่านั้น รหัสไฟล์ของไฟล์ที่มีคำตอบ ไฟล์จะเป็นไฟล์ JSONL ที่มีคำตอบเดียวต่อบรรทัด การตอบกลับจะเป็นข้อความ GenerateContentResponse ที่จัดรูปแบบเป็น JSON คำตอบจะเขียนตามลำดับเดียวกับคำขอที่ป้อน

inlinedResponses object (InlinedResponses)

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

การแสดง JSON 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

InlinedResponses

คำตอบสำหรับคำขอในกลุ่ม

ฟิลด์
inlinedResponses[] object (InlinedResponse)

เอาต์พุตเท่านั้น คำตอบสำหรับคำขอในกลุ่ม

การแสดง JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

InlinedResponse

การตอบกลับคำขอเดียวในกลุ่ม

ฟิลด์
metadata object (Struct format)

เอาต์พุตเท่านั้น ข้อมูลเมตาที่เชื่อมโยงกับคำขอ

output Union type
เอาต์พุตของคำขอ output ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
error object (Status)

เอาต์พุตเท่านั้น ข้อผิดพลาดที่พบขณะประมวลผลคำขอ

response object (GenerateContentResponse)

เอาต์พุตเท่านั้น การตอบกลับคำขอ

การแสดง JSON 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

BatchStats

สถิติเกี่ยวกับแบทช์

ฟิลด์
requestCount string (int64 format)

เอาต์พุตเท่านั้น จำนวนคำขอในกลุ่ม

successfulRequestCount string (int64 format)

เอาต์พุตเท่านั้น จำนวนคำขอที่ประมวลผลสำเร็จ

failedRequestCount string (int64 format)

เอาต์พุตเท่านั้น จำนวนคำขอที่ประมวลผลไม่สำเร็จ

pendingRequestCount string (int64 format)

เอาต์พุตเท่านั้น จำนวนคำขอที่ยังคงรอดำเนินการ

การแสดง JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

เมธอด: batches.updateEmbedContentBatch

อัปเดตกลุ่มคำขอ EmbedContent สำหรับการประมวลผลแบบกลุ่ม

ปลายทาง

patch https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

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

embedContentBatch.name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของกลุ่ม

รูปแบบ: batches/{batchId} ซึ่งจะอยู่ในรูปแบบ batches/{batches}

พารามิเตอร์การค้นหา

updateMask string (FieldMask format)

ไม่บังคับ รายการช่องที่จะอัปเดต

ซึ่งเป็นรายการชื่อฟิลด์แบบสมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อความของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ EmbedContentBatch

ฟิลด์
model string

ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม

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

displayName string

ต้องระบุ ชื่อที่ผู้ใช้กำหนดของกลุ่มนี้

inputConfig object (InputEmbedContentConfig)

ต้องระบุ การกำหนดค่าอินพุตของอินสแตนซ์ที่ใช้ประมวลผลแบบเป็นชุด

priority string (int64 format)

ไม่บังคับ ลำดับความสำคัญของกลุ่ม ระบบจะประมวลผลกลุ่มที่มีค่าลำดับความสำคัญสูงกว่าก่อนกลุ่มที่มีค่าลำดับความสำคัญต่ำกว่า อนุญาตให้ใช้ค่าลบได้ ค่าเริ่มต้นคือ 0

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ EmbedContentBatch

EmbedContentRequest

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

ฟิลด์
model string

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

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

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

content object (Content)

ต้องระบุ เนื้อหาที่จะฝัง ระบบจะนับเฉพาะฟิลด์ parts.text

taskType enum (TaskType)

ไม่บังคับ ประเภทงานที่ไม่บังคับที่จะใช้การฝัง ไม่รองรับในรุ่นก่อนหน้า (models/embedding-001)

title string

ไม่บังคับ ชื่อที่ไม่บังคับสำหรับข้อความ ใช้ได้เมื่อ TaskType เป็น RETRIEVAL_DOCUMENT เท่านั้น

หมายเหตุ: การระบุ title สำหรับ RETRIEVAL_DOCUMENT จะช่วยให้ได้การฝังที่มีคุณภาพดีขึ้นสำหรับการดึงข้อมูล

outputDimensionality integer

ไม่บังคับ มิติข้อมูลที่ลดลงสำหรับเอาต์พุตการฝัง (ไม่บังคับ) หากตั้งค่าไว้ ระบบจะตัดค่าที่มากเกินไปใน Embedding เอาต์พุตจากท้าย รองรับเฉพาะรุ่นใหม่กว่าตั้งแต่ปี 2024 เป็นต้นไป คุณตั้งค่านี้ไม่ได้หากใช้โมเดลก่อนหน้า (models/embedding-001)

การแสดง JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

เมธอด: batches.updateGenerateContentBatch

อัปเดตคำขอ GenerateContent หลายรายการสำหรับการประมวลผลแบบเป็นกลุ่ม

ปลายทาง

patch https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

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

generateContentBatch.name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของกลุ่ม

รูปแบบ: batches/{batchId} ซึ่งจะอยู่ในรูปแบบ batches/{batches}

พารามิเตอร์การค้นหา

updateMask string (FieldMask format)

ไม่บังคับ รายการช่องที่จะอัปเดต

ซึ่งเป็นรายการชื่อฟิลด์แบบสมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อความของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ GenerateContentBatch

ฟิลด์
model string

ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม

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

displayName string

ต้องระบุ ชื่อที่ผู้ใช้กำหนดของกลุ่มนี้

inputConfig object (InputConfig)

ต้องระบุ การกำหนดค่าอินพุตของอินสแตนซ์ที่ใช้ประมวลผลแบบเป็นชุด

priority string (int64 format)

ไม่บังคับ ลำดับความสำคัญของกลุ่ม ระบบจะประมวลผลกลุ่มที่มีค่าลำดับความสำคัญสูงกว่าก่อนกลุ่มที่มีค่าลำดับความสำคัญต่ำกว่า อนุญาตให้ใช้ค่าลบได้ ค่าเริ่มต้นคือ 0

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GenerateContentBatch

GenerateContentRequest

ขอให้โมเดลสร้างข้อความที่สมบูรณ์

ฟิลด์
model string

ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม

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

contents[] object (Content)

ต้องระบุ เนื้อหาของการสนทนาปัจจุบันกับโมเดล

สำหรับคำค้นหาแบบเทิร์นเดียว นี่คืออินสแตนซ์เดียว สำหรับคำค้นหาแบบหลายรอบ เช่น แชท นี่คือฟิลด์ที่ทำซ้ำซึ่งมีประวัติการสนทนาและคำขอล่าสุด

tools[] object (Tool)

ไม่บังคับ รายการToolsที่Modelอาจใช้เพื่อสร้างคำตอบถัดไป

Tool คือโค้ดที่ช่วยให้ระบบโต้ตอบกับระบบภายนอกเพื่อดำเนินการหรือชุดการดำเนินการนอกเหนือจากความรู้และขอบเขตของ Model Tool ที่รองรับคือ Function และ codeExecution ดูข้อมูลเพิ่มเติมได้ที่คู่มือการเรียกใช้ฟังก์ชันและการเรียกใช้โค้ด

toolConfig object (ToolConfig)

ไม่บังคับ การกำหนดค่าเครื่องมือสำหรับToolที่ระบุในคำขอ ดูตัวอย่างการใช้งานได้ที่คำแนะนำในการเรียกใช้ฟังก์ชัน

safetySettings[] object (SafetySetting)

ไม่บังคับ รายการSafetySettingอินสแตนซ์ที่ไม่ซ้ำกันสำหรับการบล็อกเนื้อหาที่ไม่ปลอดภัย

โดยจะมีผลบังคับใช้ในวันที่ GenerateContentRequest.contents และ GenerateContentResponse.candidates ไม่ควรมีการตั้งค่ามากกว่า 1 รายการสำหรับSafetyCategory แต่ละประเภท API จะบล็อกเนื้อหาและการตอบกลับที่ไม่เป็นไปตามเกณฑ์ที่กำหนดโดยการตั้งค่าเหล่านี้ รายการนี้จะลบล้างการตั้งค่าเริ่มต้นสำหรับแต่ละรายการที่SafetyCategoryระบุไว้ใน safetySettings หากไม่มี SafetySetting สำหรับ SafetyCategory ที่ระบุในรายการ API จะใช้การตั้งค่าความปลอดภัยเริ่มต้นสำหรับหมวดหมู่นั้น ระบบรองรับหมวดหมู่ที่เป็นอันตราย HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY ดูข้อมูลโดยละเอียดเกี่ยวกับการตั้งค่าความปลอดภัยที่มีได้ในคำแนะนำ นอกจากนี้ โปรดดูคำแนะนำด้านความปลอดภัยเพื่อดูวิธีรวมข้อควรพิจารณาด้านความปลอดภัยในแอปพลิเคชัน AI

systemInstruction object (Content)

ไม่บังคับ นักพัฒนาแอปตั้งค่าคำสั่งของระบบ ปัจจุบันมีเฉพาะข้อความ

generationConfig object (GenerationConfig)

ไม่บังคับ ตัวเลือกการกำหนดค่าสำหรับการสร้างโมเดลและเอาต์พุต

cachedContent string

ไม่บังคับ ชื่อของเนื้อหาที่แคชไว้เพื่อใช้เป็นบริบทในการแสดงผลการคาดคะเน รูปแบบ: cachedContents/{cachedContent}

การแสดง JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}

BatchState

สถานะของกลุ่ม

Enum
BATCH_STATE_UNSPECIFIED ไม่ได้ระบุสถานะของกลุ่ม
BATCH_STATE_PENDING บริการกำลังเตรียมที่จะเรียกใช้ชุด
BATCH_STATE_RUNNING การประมวลผลแบบกลุ่มกำลังดำเนินการ
BATCH_STATE_SUCCEEDED การประมวลผลแบบกลุ่มเสร็จสมบูรณ์แล้ว
BATCH_STATE_FAILED การประมวลผลแบบกลุ่มล้มเหลว
BATCH_STATE_CANCELLED ระบบยกเลิกแบทช์แล้ว
BATCH_STATE_EXPIRED แบทช์หมดอายุแล้ว

ทรัพยากร REST: batches

ทรัพยากร: การดำเนินการ

ทรัพยากรนี้แสดงการดำเนินการที่ใช้เวลานานซึ่งเป็นผลลัพธ์ของการเรียก API เครือข่าย

ฟิลด์
name string

ชื่อที่เซิร์ฟเวอร์กำหนด ซึ่งจะไม่ซ้ำกันภายในบริการเดียวกันที่แสดงผลชื่อนั้นในตอนแรกเท่านั้น หากใช้การแมป HTTP เริ่มต้น name ควรเป็นชื่อทรัพยากรที่ลงท้ายด้วย operations/{unique_id}

metadata object

ข้อมูลเมตาเฉพาะบริการที่เชื่อมโยงกับการดำเนินการ โดยปกติแล้วไฟล์นี้จะมีข้อมูลความคืบหน้าและข้อมูลเมตาทั่วไป เช่น เวลาที่สร้าง บริการบางอย่างอาจไม่มีข้อมูลเมตาดังกล่าว เมธอดที่แสดงผลการดำเนินการที่ใช้เวลานานควรบันทึกประเภทข้อมูลเมตา (หากมี)

ออบเจ็กต์ที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม "@type" มี URI ที่ระบุประเภท เช่น { "id": 1234, "@type": "types.example.com/standard/id" }

done boolean

หากค่าเป็น false แสดงว่าการดำเนินการยังอยู่ระหว่างดำเนินการ หากเป็น true การดำเนินการจะเสร็จสมบูรณ์ และจะมี error หรือ response ให้ใช้งาน

result Union type
ผลลัพธ์ของการดำเนินการ ซึ่งอาจเป็น error หรือ response ที่ถูกต้อง หาก done == false จะไม่มีการตั้งค่า error หรือ response หาก done == true จะตั้งค่า error หรือ response ได้เพียงอย่างเดียว บริการบางอย่างอาจไม่แสดงผลลัพธ์ result ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
error object (Status)

ผลลัพธ์ข้อผิดพลาดของการดำเนินการในกรณีที่ล้มเหลวหรือยกเลิก

response object

การตอบกลับตามปกติที่สำเร็จของการดำเนินการ หากเมธอดเดิมไม่แสดงข้อมูลเมื่อสำเร็จ เช่น Delete การตอบกลับจะเป็น google.protobuf.Empty หากเมธอดเดิมเป็นมาตรฐาน Get/Create/Update การตอบกลับควรเป็นทรัพยากร สำหรับเมธอดอื่นๆ การตอบกลับควรมีประเภท XxxResponse โดยที่ Xxx คือชื่อเมธอดเดิม เช่น หากชื่อเมธอดเดิมคือ TakeSnapshot() ประเภทการตอบกลับที่อนุมานได้คือ TakeSnapshotResponse

ออบเจ็กต์ที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม "@type" มี URI ที่ระบุประเภท เช่น { "id": 1234, "@type": "types.example.com/standard/id" }

การแสดง JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}