Gemini API รองรับการสร้างเนื้อหาด้วยรูปภาพ เสียง โค้ด เครื่องมือ และอื่นๆ อ่านต่อและดูตัวอย่างโค้ดที่เน้นงาน หรืออ่านคำแนะนำที่ครอบคลุมเพื่อดูรายละเอียดเกี่ยวกับฟีเจอร์แต่ละอย่าง
- การสร้างข้อความ
- การมองเห็น
- เสียง
- การฝัง
- บริบทแบบยาว
- การรันโค้ด
- โหมด JSON
- การเรียกใช้ฟังก์ชัน
- คำสั่งของระบบ
เมธอด: models.generateContent
สร้างคำตอบของโมเดลเมื่อได้รับอินพุต GenerateContentRequest ดูข้อมูลการใช้งานโดยละเอียดได้ในคำแนะนำในการสร้างข้อความ ความสามารถในการป้อนข้อมูลจะแตกต่างกันไปในแต่ละรุ่น รวมถึงรุ่นที่ปรับแต่งแล้ว ดูรายละเอียดได้ที่คำแนะนำเกี่ยวกับโมเดลและคำแนะนำในการปรับแต่ง
ปลายทาง
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
พารามิเตอร์เส้นทาง
model
string
ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม
รูปแบบ: models/{model} ซึ่งจะอยู่ในรูปแบบ models/{model}
เนื้อความของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
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}
store
boolean
ไม่บังคับ กำหนดค่าลักษณะการทำงานของการบันทึกสำหรับคำขอที่ระบุ หากตั้งค่าไว้ การตั้งค่านี้จะมีความสำคัญเหนือกว่าการกำหนดค่าการบันทึกระดับโปรเจ็กต์
ตัวอย่างคำขอ
ข้อความ
Python
Node.js
Go
เปลือกหอย
Java
รูปภาพ
Python
Node.js
Go
เปลือกหอย
Java
เสียง
Python
Node.js
Go
เปลือกหอย
วิดีโอ
Python
Node.js
Go
เปลือกหอย
Python
Go
เปลือกหอย
แชท
Python
Node.js
Go
เปลือกหอย
Java
แคช
Python
Node.js
Go
โมเดลที่ปรับแต่งแล้ว
Python
โหมด JSON
Python
Node.js
Go
เปลือกหอย
Java
การรันโค้ด
Python
Go
Java
การเรียกใช้ฟังก์ชัน
Python
Go
Node.js
เปลือกหอย
Java
การกำหนดค่าการสร้าง
Python
Node.js
Go
เปลือกหอย
Java
การตั้งค่าความปลอดภัย
Python
Node.js
Go
เปลือกหอย
Java
คำสั่งของระบบ
Python
Node.js
Go
เปลือกหอย
Java
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GenerateContentResponse
เมธอด: models.streamGenerateContent
สร้างการตอบกลับแบบสตรีมจากโมเดลเมื่อได้รับอินพุต GenerateContentRequest
ปลายทาง
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
พารามิเตอร์เส้นทาง
model
string
ต้องระบุ ชื่อของ Model ที่จะใช้ในการสร้างข้อความเติม
รูปแบบ: models/{model} ซึ่งจะอยู่ในรูปแบบ models/{model}
เนื้อความของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
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}
store
boolean
ไม่บังคับ กำหนดค่าลักษณะการทำงานของการบันทึกสำหรับคำขอที่ระบุ หากตั้งค่าไว้ การตั้งค่านี้จะมีความสำคัญเหนือกว่าการกำหนดค่าการบันทึกระดับโปรเจ็กต์
ตัวอย่างคำขอ
ข้อความ
Python
Node.js
Go
เปลือกหอย
Java
รูปภาพ
Python
Node.js
Go
เปลือกหอย
Java
เสียง
Python
Go
เปลือกหอย
วิดีโอ
Python
Node.js
Go
เปลือกหอย
Python
Go
เปลือกหอย
แชท
Python
Node.js
Go
เปลือกหอย
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีสตรีมของอินสแตนซ์ GenerateContentResponse
GenerateContentResponse
การตอบกลับจากโมเดลที่รองรับคำตอบที่เป็นไปได้หลายรายการ
ระบบจะรายงานการจัดประเภทความปลอดภัยและการกรองเนื้อหาสำหรับทั้งพรอมต์ใน GenerateContentResponse.prompt_feedback และสำหรับแต่ละคำตอบใน finishReason และใน safetyRatings API จะมีลักษณะดังนี้ - แสดงผู้สมัครรับเลือกทั้งหมดที่ขอหรือไม่มีเลย - จะไม่แสดงผู้สมัครรับเลือกเลยก็ต่อเมื่อมีบางอย่างผิดปกติกับพรอมต์ (ดู promptFeedback) - รายงานความคิดเห็นเกี่ยวกับผู้สมัครรับเลือกแต่ละรายใน finishReason และ safetyRatings
candidates[]
object (Candidate)
คำตอบที่เป็นตัวเลือกจากโมเดล
promptFeedback
object (PromptFeedback)
แสดงความคิดเห็นของพรอมต์ที่เกี่ยวข้องกับตัวกรองเนื้อหา
usageMetadata
object (UsageMetadata)
เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับการใช้โทเค็นของคำขอการสร้าง
modelVersion
string
เอาต์พุตเท่านั้น เวอร์ชันโมเดลที่ใช้สร้างคำตอบ
responseId
string
เอาต์พุตเท่านั้น responseId ใช้เพื่อระบุคำตอบแต่ละรายการ
modelStatus
object (ModelStatus)
เอาต์พุตเท่านั้น สถานะโมเดลปัจจุบันของโมเดลนี้
| การแสดง JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
ชุดข้อมูลเมตาของความคิดเห็นที่พรอมต์ระบุใน GenerateContentRequest.content
blockReason
enum (BlockReason)
ไม่บังคับ หากตั้งค่าไว้ ระบบจะบล็อกพรอมต์และไม่แสดงคำตอบ เปลี่ยนคำพูดในพรอมต์
safetyRatings[]
object (SafetyRating)
การจัดประเภทความปลอดภัยของพรอมต์ มีคะแนนได้สูงสุด 1 รายการต่อหมวดหมู่
| การแสดง JSON |
|---|
{ "blockReason": enum ( |
BlockReason
ระบุเหตุผลที่ระบบบล็อกพรอมต์
| Enum | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
SAFETY |
ระบบบล็อกพรอมต์เนื่องจากเหตุผลด้านความปลอดภัย ตรวจสอบ safetyRatings เพื่อดูว่าหมวดหมู่ความปลอดภัยใดที่บล็อก |
OTHER |
ระบบบล็อกพรอมต์เนื่องจากไม่ทราบสาเหตุ |
BLOCKLIST |
ระบบบล็อกพรอมต์เนื่องจากมีคำที่รวมอยู่ในรายการบล็อกคำศัพท์ |
PROHIBITED_CONTENT |
พรอมต์ถูกบล็อกเนื่องจากมีเนื้อหาต้องห้าม |
IMAGE_SAFETY |
ผู้สมัครถูกบล็อกเนื่องจากมีเนื้อหาการสร้างรูปภาพที่ไม่ปลอดภัย |
UsageMetadata
ข้อมูลเมตาเกี่ยวกับการใช้โทเค็นของคำขอสร้าง
promptTokenCount
integer
จำนวนโทเค็นในพรอมต์ เมื่อตั้งค่า cachedContent แล้ว ค่านี้จะยังคงเป็นขนาดพรอมต์ที่มีประสิทธิภาพทั้งหมด ซึ่งหมายความว่าค่านี้รวมถึงจำนวนโทเค็นในเนื้อหาที่แคชไว้
cachedContentTokenCount
integer
จำนวนโทเค็นในส่วนที่แคชของพรอมต์ (เนื้อหาที่แคช)
candidatesTokenCount
integer
จำนวนโทเค็นทั้งหมดในตัวเลือกคำตอบที่สร้างขึ้นทั้งหมด
toolUsePromptTokenCount
integer
เอาต์พุตเท่านั้น จำนวนโทเค็นที่อยู่ในพรอมต์การใช้เครื่องมือ
thoughtsTokenCount
integer
เอาต์พุตเท่านั้น จำนวนโทเค็นของความคิดสำหรับโมเดลการคิด
totalTokenCount
integer
จำนวนโทเค็นทั้งหมดสำหรับคำขอการสร้าง (พรอมต์ + ตัวเลือกคำตอบ)
promptTokensDetails[]
object (ModalityTokenCount)
เอาต์พุตเท่านั้น รายการรูปแบบที่ประมวลผลในอินพุตคำขอ
cacheTokensDetails[]
object (ModalityTokenCount)
เอาต์พุตเท่านั้น รายการรูปแบบของเนื้อหาที่แคชไว้ในอินพุตคำขอ
candidatesTokensDetails[]
object (ModalityTokenCount)
เอาต์พุตเท่านั้น รายการรูปแบบที่แสดงในการตอบกลับ
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
เอาต์พุตเท่านั้น รายการรูปแบบที่ประมวลผลสำหรับอินพุตคำขอการใช้เครื่องมือ
| การแสดง JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
สถานะของโมเดลพื้นฐาน โดยใช้เพื่อระบุระยะของโมเดลพื้นฐานและเวลาเลิกใช้งาน (หากมี)
modelStage
enum (ModelStage)
ระยะของโมเดลพื้นฐาน
retirementTime
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"
message
string
ข้อความที่อธิบายสถานะของโมเดล
| การแสดง JSON |
|---|
{
"modelStage": enum ( |
ModelStage
กำหนดระยะของโมเดลพื้นฐาน
| Enum | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
ระยะของโมเดลที่ไม่ได้ระบุ |
UNSTABLE_EXPERIMENTAL |
โมเดลพื้นฐานต้องได้รับการปรับแต่งหลายอย่าง |
EXPERIMENTAL |
โมเดลในขั้นตอนนี้มีไว้เพื่อการทดลองเท่านั้น |
PREVIEW |
โมเดลในขั้นตอนนี้มีความสมบูรณ์มากกว่าโมเดลทดลอง |
STABLE |
โมเดลในขั้นตอนนี้ถือว่าเสถียรและพร้อมใช้งานจริง |
LEGACY |
หากโมเดลอยู่ในขั้นตอนนี้ แสดงว่าโมเดลนี้กำลังจะเลิกใช้งานในอนาคตอันใกล้นี้ เฉพาะลูกค้าเดิมเท่านั้นที่ใช้โมเดลนี้ได้ |
DEPRECATED |
โมเดลในขั้นตอนนี้เลิกใช้งานแล้ว ใช้โมเดลเหล่านี้ไม่ได้ |
RETIRED |
โมเดลในขั้นตอนนี้จะเลิกใช้งาน ใช้โมเดลเหล่านี้ไม่ได้ |
ผู้สมัคร
- การแสดง JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- เว็บ
- รูปภาพ
- RetrievedContext
- CustomMetadata
- StringList
- Maps
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- กลุ่ม
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- ผู้สมัคร
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
คำตอบที่เป็นไปได้ที่สร้างขึ้นจากโมเดล
content
object (Content)
เอาต์พุตเท่านั้น เนื้อหาที่สร้างขึ้นซึ่งโมเดลส่งคืน
finishReason
enum (FinishReason)
ไม่บังคับ เอาต์พุตเท่านั้น เหตุผลที่โมเดลหยุดสร้างโทเค็น
หากว่างเปล่า แสดงว่าโมเดลยังไม่ได้หยุดสร้างโทเค็น
safetyRatings[]
object (SafetyRating)
รายการคะแนนสำหรับความปลอดภัยของผู้สมัครรับการตอบกลับ
มีคะแนนได้สูงสุด 1 รายการต่อหมวดหมู่
citationMetadata
object (CitationMetadata)
เอาต์พุตเท่านั้น ข้อมูลการอ้างอิงสำหรับคำตอบที่โมเดลสร้างขึ้น
ช่องนี้อาจมีข้อมูลการอ่านสำหรับข้อความใดๆ ที่รวมอยู่ใน content โดยข้อความเหล่านี้เป็นข้อความที่ "ท่อง" มาจากเนื้อหาที่มีลิขสิทธิ์ในข้อมูลการฝึกของ LLM พื้นฐาน
tokenCount
integer
เอาต์พุตเท่านั้น จำนวนโทเค็นสำหรับคำตอบนี้
groundingAttributions[]
object (GroundingAttribution)
เอาต์พุตเท่านั้น ข้อมูลการระบุแหล่งที่มาสำหรับแหล่งข้อมูลที่มีส่วนร่วมในคำตอบที่อิงตามข้อเท็จจริง
ระบบจะป้อนข้อมูลในช่องนี้สำหรับการโทร GenerateAnswer
groundingMetadata
object (GroundingMetadata)
เอาต์พุตเท่านั้น ข้อมูลเมตาพื้นฐานสำหรับผู้สมัคร
ระบบจะป้อนข้อมูลในช่องนี้สำหรับการโทร GenerateContent
avgLogprobs
number
เอาต์พุตเท่านั้น คะแนนความน่าจะเป็นของบันทึกเฉลี่ยของผู้สมัคร
logprobsResult
object (LogprobsResult)
เอาต์พุตเท่านั้น คะแนนความน่าจะเป็นของบันทึกสำหรับโทเค็นการตอบกลับและโทเค็นยอดนิยม
urlContextMetadata
object (UrlContextMetadata)
เอาต์พุตเท่านั้น ข้อมูลเมตาที่เกี่ยวข้องกับเครื่องมือดึงข้อมูลบริบท URL
index
integer
เอาต์พุตเท่านั้น ดัชนีของผู้สมัครในรายการผู้สมัครรับการตอบกลับ
finishMessage
string
ไม่บังคับ เอาต์พุตเท่านั้น รายละเอียดเหตุผลที่โมเดลหยุดสร้างโทเค็น ระบบจะป้อนข้อมูลนี้เมื่อตั้งค่า finishReason เท่านั้น
| การแสดง JSON |
|---|
{ "content": { object ( |
FinishReason
กำหนดเหตุผลที่โมเดลหยุดสร้างโทเค็น
| Enum | |
|---|---|
FINISH_REASON_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
STOP |
จุดหยุดตามธรรมชาติของโมเดลหรือลำดับการหยุดที่ระบุ |
MAX_TOKENS |
มีโทเค็นถึงจำนวนสูงสุดตามที่ระบุไว้ในคำขอแล้ว |
SAFETY |
ระบบแจ้งว่าเนื้อหาที่แนะนำในการตอบกลับไม่ปลอดภัย |
RECITATION |
ระบบแจ้งว่าเนื้อหาของผู้สมัครรับเลือกตั้งไม่เหมาะสมเนื่องจากเหตุผลด้านการท่อง |
LANGUAGE |
ระบบแจ้งว่าเนื้อหาที่เป็นคำตอบใช้ภาษาที่ไม่รองรับ |
OTHER |
ไม่ทราบสาเหตุ |
BLOCKLIST |
ระบบหยุดสร้างโทเค็นเนื่องจากเนื้อหามีคำที่ไม่อนุญาต |
PROHIBITED_CONTENT |
ระบบหยุดสร้างโทเค็นเนื่องจากอาจมีเนื้อหาที่ไม่อนุญาต |
SPII |
ระบบหยุดสร้างโทเค็นเนื่องจากเนื้อหาอาจมีข้อมูลส่วนบุคคลที่ระบุตัวบุคคลนั้นได้ (PII) ที่ละเอียดอ่อน |
MALFORMED_FUNCTION_CALL |
การเรียกใช้ฟังก์ชันที่โมเดลสร้างขึ้นไม่ถูกต้อง |
IMAGE_SAFETY |
ระบบหยุดสร้างโทเค็นเนื่องจากรูปภาพที่สร้างขึ้นมีการละเมิดด้านความปลอดภัย |
IMAGE_PROHIBITED_CONTENT |
หยุดการสร้างรูปภาพเนื่องจากรูปภาพที่สร้างขึ้นมีเนื้อหาอื่นๆ ที่ไม่อนุญาต |
IMAGE_OTHER |
การสร้างรูปภาพหยุดลงเนื่องจากปัญหาอื่นๆ |
NO_IMAGE |
ระบบคาดว่าโมเดลจะสร้างรูปภาพ แต่ไม่มีการสร้างรูปภาพ |
IMAGE_RECITATION |
หยุดการสร้างรูปภาพเนื่องจากการท่อง |
UNEXPECTED_TOOL_CALL |
โมเดลสร้างการเรียกใช้เครื่องมือ แต่ไม่ได้เปิดใช้เครื่องมือใดๆ ในคำขอ |
TOO_MANY_TOOL_CALLS |
โมเดลเรียกใช้เครื่องมือหลายรายการติดต่อกันมากเกินไป ระบบจึงหยุดการดำเนินการ |
MISSING_THOUGHT_SIGNATURE |
คำขอไม่มีลายเซ็นความคิดอย่างน้อย 1 รายการ |
MALFORMED_RESPONSE |
เสร็จแล้วเนื่องจากการตอบกลับมีรูปแบบไม่ถูกต้อง |
GroundingAttribution
การระบุแหล่งที่มาของแหล่งข้อมูลที่ช่วยให้ได้คำตอบ
sourceId
object (AttributionSourceId)
เอาต์พุตเท่านั้น ตัวระบุแหล่งที่มาที่ทำให้เกิดการระบุแหล่งที่มานี้
content
object (Content)
เนื้อหาต้นฉบับที่ประกอบกันเป็นการระบุแหล่งที่มานี้
| การแสดง JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
ตัวระบุแหล่งที่มาที่ทำให้เกิดการระบุแหล่งที่มานี้
source
Union type
source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นgroundingPassage
object (GroundingPassageId)
ตัวระบุสำหรับข้อความที่แทรกในบรรทัด
semanticRetrieverChunk
object (SemanticRetrieverChunk)
ตัวระบุสำหรับ Chunk ที่ดึงข้อมูลผ่านเครื่องมือดึงข้อมูลเชิงความหมาย
| การแสดง JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
ตัวระบุสำหรับชิ้นส่วนภายใน GroundingPassage
passageId
string
เอาต์พุตเท่านั้น รหัสของข้อความที่ตรงกับGroundingPassage.idของ GenerateAnswerRequest
partIndex
integer
เอาต์พุตเท่านั้น ดัชนีของส่วนภายใน GenerateAnswerRequest ของ GroundingPassage.content
| การแสดง JSON |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
ตัวระบุสำหรับ Chunk ที่ดึงข้อมูลผ่านเครื่องมือดึงข้อมูลเชิงความหมายที่ระบุใน GenerateAnswerRequest โดยใช้ SemanticRetrieverConfig
source
string
เอาต์พุตเท่านั้น ชื่อของแหล่งที่มาที่ตรงกับ SemanticRetrieverConfig.source ของคำขอ เช่น corpora/123 หรือ corpora/123/documents/abc
chunk
string
เอาต์พุตเท่านั้น ชื่อของ Chunk ที่มีข้อความระบุแหล่งที่มา ตัวอย่าง: corpora/123/documents/abc/chunks/xyz
| การแสดง JSON |
|---|
{ "source": string, "chunk": string } |
GroundingMetadata
ข้อมูลเมตาที่แสดงผลต่อไคลเอ็นต์เมื่อเปิดใช้การอ้างอิง
groundingChunks[]
object (GroundingChunk)
รายการการอ้างอิงที่รองรับซึ่งดึงมาจากแหล่งข้อมูลพื้นฐานที่ระบุ เมื่อสตรีม ข้อมูลนี้จะมีเฉพาะก้อนข้อมูลพื้นฐานที่ไม่ได้รวมอยู่ในข้อมูลเมตาพื้นฐานของการตอบกลับก่อนหน้า
groundingSupports[]
object (GroundingSupport)
รายการการสนับสนุนการอ้างอิง
webSearchQueries[]
string
คำค้นหาใน Web Search สำหรับการค้นหาเว็บเพิ่มเติม
imageSearchQueries[]
string
คำค้นหารูปภาพที่ใช้สำหรับการอ้างอิง
searchEntryPoint
object (SearchEntryPoint)
ไม่บังคับ รายการค้นหาของ Google สำหรับการค้นหาเว็บที่ติดตาม
retrievalMetadata
object (RetrievalMetadata)
ข้อมูลเมตาที่เกี่ยวข้องกับการดึงข้อมูลในโฟลว์การอ้างอิง
googleMapsWidgetContextToken
string
ไม่บังคับ ชื่อทรัพยากรของโทเค็นบริบทของวิดเจ็ต Google Maps ที่ใช้กับวิดเจ็ต PlacesContextElement เพื่อแสดงข้อมูลตามบริบทได้ จะมีการป้อนข้อมูลในกรณีที่เปิดใช้การเชื่อมต่อแหล่งข้อมูลกับ Google Maps เท่านั้น
| การแสดง JSON |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
จุดแรกเข้าของ Google Search
renderedContent
string
ไม่บังคับ ข้อมูลโค้ดเนื้อหาเว็บที่ฝังในหน้าเว็บหรือ WebView ของแอปได้
sdkBlob
string (bytes format)
ไม่บังคับ JSON ที่เข้ารหัส Base64 ซึ่งแสดงอาร์เรย์ของทูเพิล <ข้อความค้นหา, URL การค้นหา>
สตริงที่เข้ารหัส Base64
| การแสดง JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
GroundingChunk แสดงถึงส่วนของหลักฐานสนับสนุนที่อ้างอิงคำตอบของโมเดล ซึ่งอาจเป็นข้อมูลจากเว็บ บริบทที่ดึงมาจากไฟล์ หรือข้อมูลจาก Google Maps
chunk_type
Union type
chunk_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นweb
object (Web)
Chunk ที่เชื่อมต่อแหล่งข้อมูลจากเว็บ
image
object (Image)
ไม่บังคับ การเชื่อมต่อแหล่งข้อมูลจากก้อนข้อมูลในการค้นหารูปภาพ
retrievedContext
object (RetrievedContext)
ไม่บังคับ กลุ่มข้อมูลพื้นฐานจากบริบทที่ดึงข้อมูลโดยเครื่องมือค้นหาไฟล์
maps
object (Maps)
ไม่บังคับ Grounding Chunk จาก Google Maps
| การแสดง JSON |
|---|
{ // chunk_type "web": { object ( |
เว็บ
ข้อความจากเว็บ
uri
string
เอาต์พุตเท่านั้น การอ้างอิง URI ของก้อน
title
string
เอาต์พุตเท่านั้น ชื่อของกลุ่ม
| การแสดง JSON |
|---|
{ "uri": string, "title": string } |
รูปภาพ
ข้อมูลจาก Google Lens
sourceUri
string
URI ของหน้าเว็บสำหรับการระบุแหล่งที่มา
imageUri
string
URL ของชิ้นงานรูปภาพ
title
string
ชื่อของหน้าเว็บที่รูปภาพมาจาก
domain
string
โดเมนรูทของหน้าเว็บที่รูปภาพมาจาก เช่น "example.com"
| การแสดง JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
Chunk จากบริบทที่เครื่องมือค้นหาไฟล์ดึงมา
customMetadata[]
object (CustomMetadata)
ไม่บังคับ ข้อมูลเมตาที่ได้จากผู้ใช้เกี่ยวกับบริบทที่ดึงมา
uri
string
ไม่บังคับ การอ้างอิง URI ของเอกสารการดึงข้อมูลเชิงความหมาย
title
string
ไม่บังคับ ชื่อเอกสาร
text
string
ไม่บังคับ ข้อความของก้อน
fileSearchStore
string
ไม่บังคับ ชื่อของ FileSearchStore ที่มีเอกสาร ตัวอย่าง: fileSearchStores/123
| การแสดง JSON |
|---|
{
"customMetadata": [
{
object ( |
CustomMetadata
ข้อมูลเมตาที่ผู้ใช้ระบุเกี่ยวกับ GroundingFact
key
string
คีย์ของข้อมูลเมตา
value
Union type
value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นstringValue
string
ไม่บังคับ ค่าสตริงของข้อมูลเมตา
stringListValue
object (StringList)
ไม่บังคับ รายการค่าสตริงสำหรับข้อมูลเมตา
numericValue
number
ไม่บังคับ ค่าตัวเลขของข้อมูลเมตา ช่วงที่คาดไว้สำหรับค่านี้จะขึ้นอยู่กับ key ที่เฉพาะเจาะจงที่ใช้
| การแสดง JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
รายการค่าสตริง
values[]
string
ค่าสตริงของรายการ
| การแสดง JSON |
|---|
{ "values": [ string ] } |
แผนที่
กลุ่มข้อมูลพื้นฐานจาก Google Maps ก้อนข้อมูลของ Maps จะสอดคล้องกับสถานที่เดียว
uri
string
การอ้างอิง URI ของสถานที่
title
string
ชื่อสถานที่
text
string
ข้อความอธิบายคำตอบเกี่ยวกับสถานที่
placeId
string
รหัสของสถานที่ในรูปแบบ places/{placeId} ผู้ใช้สามารถใช้รหัสนี้เพื่อค้นหาสถานที่ดังกล่าวได้
placeAnswerSources
object (PlaceAnswerSources)
แหล่งข้อมูลที่ให้คำตอบเกี่ยวกับฟีเจอร์ของสถานที่หนึ่งๆ ใน Google Maps
| การแสดง JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
แหล่งข้อมูลที่ให้คำตอบเกี่ยวกับฟีเจอร์ของสถานที่หนึ่งๆ ใน Google Maps ข้อความ PlaceAnswerSources แต่ละข้อความจะสอดคล้องกับสถานที่ที่เฉพาะเจาะจงใน Google Maps เครื่องมือ Google Maps ใช้แหล่งข้อมูลเหล่านี้เพื่อตอบคำถามเกี่ยวกับฟีเจอร์ของสถานที่ (เช่น "บาร์ Foo มี Wi-Fi ไหม" หรือ "Foo Bar มีทางสำหรับรถเข็นไหม") ปัจจุบันเรารองรับเฉพาะตัวอย่างรีวิวเป็นแหล่งที่มา
reviewSnippets[]
object (ReviewSnippet)
ข้อมูลรีวิวที่ใช้ในการสร้างคำตอบเกี่ยวกับฟีเจอร์ของสถานที่หนึ่งๆ ใน Google Maps
| การแสดง JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
แคปซูลข้อมูลรีวิวของผู้ใช้ที่ตอบคำถามเกี่ยวกับฟีเจอร์ของสถานที่หนึ่งๆ ใน Google Maps
reviewId
string
รหัสของตัวอย่างรีวิว
googleMapsUri
string
ลิงก์ที่สอดคล้องกับรีวิวของผู้ใช้ใน Google Maps
title
string
ชื่อของรีวิว
| การแสดง JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
การสนับสนุนการอ้างอิง
groundingChunkIndices[]
integer
ไม่บังคับ รายการดัชนี (ใน "grounding_chunk" ใน response.candidate.grounding_metadata) ที่ระบุการอ้างอิงที่เชื่อมโยงกับการกล่าวอ้าง เช่น [1,3,4] หมายความว่า grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] คือเนื้อหาที่ดึงมาซึ่งเชื่อมโยงกับคำกล่าวอ้าง หากการตอบกลับเป็นการสตรีม groundingChunkIndices จะอ้างอิงถึงดัชนีในการตอบกลับทั้งหมด ไคลเอ็นต์มีหน้าที่รวบรวมก้อนข้อมูลพื้นฐานจากคำตอบทั้งหมด (โดยรักษลําดับเดิมไว้)
confidenceScores[]
number
ไม่บังคับ คะแนนความเชื่อมั่นของการอ้างอิงที่สนับสนุน ค่าอยู่ในช่วง 0 ถึง 1 โดย 1 คือมั่นใจมากที่สุด รายการนี้ต้องมีขนาดเท่ากับ groundingChunkIndices
renderedParts[]
integer
เอาต์พุตเท่านั้น ดัชนีในpartsฟิลด์ของเนื้อหาของผู้สมัคร ดัชนีเหล่านี้จะระบุว่าส่วนที่แสดงส่วนใดที่เชื่อมโยงกับแหล่งที่มาของการสนับสนุนนี้
segment
object (Segment)
ส่วนของเนื้อหาที่การสนับสนุนนี้เกี่ยวข้อง
| การแสดง JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
กลุ่ม
ส่วนของเนื้อหา
partIndex
integer
ดัชนีของออบเจ็กต์ Part ภายในออบเจ็กต์ Content หลัก
startIndex
integer
ดัชนีเริ่มต้นในพาร์ทที่ระบุ ซึ่งวัดเป็นไบต์ ออฟเซ็ตจากจุดเริ่มต้นของพาร์ต (รวมจุดเริ่มต้น) โดยเริ่มที่ 0
endIndex
integer
ดัชนีสิ้นสุดในส่วนที่ระบุ ซึ่งวัดเป็นไบต์ ออฟเซ็ตจากจุดเริ่มต้นของพาร์ท โดยไม่รวมจุดเริ่มต้นและเริ่มที่ 0
text
string
ข้อความที่สอดคล้องกับส่วนจากคำตอบ
| การแสดง JSON |
|---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
ข้อมูลเมตาที่เกี่ยวข้องกับการดึงข้อมูลในโฟลว์การอ้างอิง
googleSearchDynamicRetrievalScore
number
ไม่บังคับ คะแนนที่บ่งบอกว่าข้อมูลจาก Google Search มีแนวโน้มที่จะช่วยตอบพรอมต์ได้มากน้อยเพียงใด คะแนนอยู่ในช่วง [0, 1] โดยที่ 0 คือความเป็นไปได้น้อยที่สุด และ 1 คือความเป็นไปได้มากที่สุด ระบบจะสร้างคะแนนนี้เมื่อเปิดใช้การอ้างอิงจาก Google Search และการดึงข้อมูลแบบไดนามิกเท่านั้น ระบบจะเปรียบเทียบกับเกณฑ์เพื่อพิจารณาว่าจะทริกเกอร์การค้นหาของ Google หรือไม่
| การแสดง JSON |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
ผลลัพธ์ Logprobs
topCandidates[]
object (TopCandidates)
ความยาว = จำนวนขั้นตอนการถอดรหัสทั้งหมด
chosenCandidates[]
object (Candidate)
ความยาว = จำนวนขั้นตอนการถอดรหัสทั้งหมด ผู้สมัครที่เลือกอาจอยู่ใน topCandidates หรือไม่อยู่ก็ได้
logProbabilitySum
number
ผลรวมของความน่าจะเป็นของบันทึกสำหรับโทเค็นทั้งหมด
| การแสดง JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
ผู้สมัครที่มีความน่าจะเป็นของบันทึกสูงสุดในแต่ละขั้นตอนการถอดรหัส
candidates[]
object (Candidate)
จัดเรียงตามความน่าจะเป็นของบันทึกจากมากไปน้อย
| การแสดง JSON |
|---|
{
"candidates": [
{
object ( |
ผู้สมัคร
ผู้สมัครรับโทเค็นและคะแนน logprobs
token
string
ค่าสตริงโทเค็นของผู้สมัคร
tokenId
integer
ค่ารหัสโทเค็นของผู้สมัคร
logProbability
number
ความน่าจะเป็นของบันทึกของผู้สมัคร
| การแสดง JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
ข้อมูลเมตาที่เกี่ยวข้องกับเครื่องมือดึงข้อมูลบริบท URL
urlMetadata[]
object (UrlMetadata)
รายการบริบท URL
| การแสดง JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
บริบทของการดึงข้อมูล URL เดียว
retrievedUrl
string
URL ที่เครื่องมือดึงข้อมูล
urlRetrievalStatus
enum (UrlRetrievalStatus)
สถานะของการดึงข้อมูล URL
| การแสดง JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
สถานะของการดึงข้อมูล URL
| Enum | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
URL_RETRIEVAL_STATUS_SUCCESS |
การดึงข้อมูล URL สำเร็จ |
URL_RETRIEVAL_STATUS_ERROR |
การดึงข้อมูล URL ล้มเหลวเนื่องจากเกิดข้อผิดพลาด |
URL_RETRIEVAL_STATUS_PAYWALL |
ดึงข้อมูล URL ไม่สำเร็จเนื่องจากเนื้อหาอยู่หลังเพย์วอลล์ |
URL_RETRIEVAL_STATUS_UNSAFE |
การดึงข้อมูล URL ไม่สำเร็จเนื่องจากเนื้อหาไม่ปลอดภัย |
CitationMetadata
ชุดการระบุแหล่งที่มาของเนื้อหา
citationSources[]
object (CitationSource)
การอ้างอิงแหล่งที่มาสำหรับคำตอบที่เฉพาะเจาะจง
| การแสดง JSON |
|---|
{
"citationSources": [
{
object ( |
CitationSource
การอ้างอิงแหล่งที่มาสำหรับส่วนหนึ่งของคำตอบที่เฉพาะเจาะจง
startIndex
integer
ไม่บังคับ จุดเริ่มต้นของส่วนของคำตอบที่มาจากแหล่งที่มานี้
ดัชนีระบุจุดเริ่มต้นของกลุ่ม โดยวัดเป็นไบต์
endIndex
integer
ไม่บังคับ จุดสิ้นสุดของกลุ่มที่มาของการระบุแหล่งที่มา (ไม่รวมจุดสิ้นสุด)
uri
string
ไม่บังคับ URI ที่ระบุว่าเป็นแหล่งที่มาของข้อความบางส่วน
license
string
ไม่บังคับ ใบอนุญาตสำหรับโปรเจ็กต์ GitHub ที่ระบุว่าเป็นแหล่งที่มาของกลุ่ม
ต้องระบุข้อมูลใบอนุญาตสำหรับการอ้างอิงโค้ด
| การแสดง JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- การแสดง JSON
- รูปแบบ
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
ตัวเลือกการกำหนดค่าสำหรับการสร้างโมเดลและเอาต์พุต พารามิเตอร์บางรายการอาจกำหนดค่าไม่ได้ในบางโมเดล
stopSequences[]
string
ไม่บังคับ ชุดลำดับอักขระ (สูงสุด 5 รายการ) ที่จะหยุดการสร้างเอาต์พุต หากระบุไว้ API จะหยุดเมื่อพบ stop_sequence ครั้งแรก ระบบจะไม่รวมลำดับการหยุดเป็นส่วนหนึ่งของคำตอบ
responseMimeType
string
ไม่บังคับ ประเภท MIME ของข้อความตัวเลือกที่สร้างขึ้น ประเภท MIME ที่รองรับ ได้แก่ text/plain: (ค่าเริ่มต้น) เอาต์พุตข้อความ application/json: การตอบกลับ JSON ในคำตอบที่เป็นไปได้ text/x.enum: ENUM เป็นการตอบกลับสตริงในตัวเลือกการตอบกลับ ดูรายการประเภท MIME ของข้อความที่รองรับทั้งหมดได้ในเอกสาร
responseSchema
object (Schema)
ไม่บังคับ สคีมาเอาต์พุตของข้อความผู้สมัครที่สร้างขึ้น สคีมาต้องเป็นส่วนย่อยของสคีมา OpenAPI และอาจเป็นออบเจ็กต์ ไพรม์ หรืออาร์เรย์
หากตั้งค่าไว้ ก็ต้องตั้งค่า responseMimeType ที่เข้ากันได้ด้วย MIME ประเภทที่เข้ากันได้: application/json: สคีมาสำหรับการตอบกลับ JSON ดูรายละเอียดเพิ่มเติมได้ในคู่มือการสร้างข้อความ JSON
_responseJsonSchema
value (Value format)
ไม่บังคับ สคีมาเอาต์พุตของคำตอบที่สร้างขึ้น ซึ่งเป็นอีกทางเลือกหนึ่งแทน responseSchema ที่ยอมรับ JSON Schema
หากตั้งค่าไว้ คุณต้องละเว้น responseSchema แต่ต้องระบุ responseMimeType
แม้ว่าจะส่ง JSON Schema แบบเต็มได้ แต่ระบบก็ไม่รองรับฟีเจอร์บางอย่าง โดยเฉพาะอย่างยิ่ง ระบบรองรับเฉพาะพร็อพเพอร์ตี้ต่อไปนี้
$id$defs$ref$anchortypeformattitledescriptionenum(สำหรับสตริงและตัวเลข)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(ตีความเหมือนกับanyOf)propertiesadditionalPropertiesrequired
นอกจากนี้ยังอาจตั้งค่าพร็อพเพอร์ตี้ propertyOrdering ที่ไม่ใช่มาตรฐานได้ด้วย
การอ้างอิงแบบวนซ้ำจะคลี่ออกในระดับที่จำกัด และด้วยเหตุนี้จึงอาจใช้ได้เฉพาะภายในพร็อพเพอร์ตี้ที่ไม่บังคับ (พร็อพเพอร์ตี้ที่กำหนดให้เป็น Null ได้ไม่เพียงพอ) หากตั้งค่า $ref ในสคีมาย่อย จะตั้งค่าพร็อพเพอร์ตี้อื่นๆ ไม่ได้ ยกเว้นพร็อพเพอร์ตี้ที่ขึ้นต้นด้วย $
responseJsonSchema
value (Value format)
ไม่บังคับ รายละเอียดภายใน โปรดใช้ responseJsonSchema แทนช่องนี้
responseModalities[]
enum (Modality)
ไม่บังคับ รูปแบบการตอบกลับที่ขอ แสดงชุดรูปแบบที่โมเดลสามารถแสดงผลและควรคาดหวังในคำตอบ ซึ่งตรงกับรูปแบบของคำตอบ
โมเดลอาจมีการผสมผสานรูปแบบที่รองรับหลายแบบ หากรูปแบบที่ขอไม่ตรงกับชุดค่าผสมที่รองรับ ระบบจะแสดงข้อผิดพลาด
รายการที่ว่างเปล่าจะเทียบเท่ากับการขอข้อความเท่านั้น
candidateCount
integer
ไม่บังคับ จำนวนคำตอบที่สร้างขึ้นที่จะแสดงผล หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ค่าเริ่มต้นเป็น 1 โปรดทราบว่าฟีเจอร์นี้ใช้กับโมเดลรุ่นก่อนหน้า (ตระกูล Gemini 1.0) ไม่ได้
maxOutputTokens
integer
ไม่บังคับ จำนวนโทเค็นสูงสุดที่จะรวมไว้ในคำตอบที่เป็นไปได้
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตามรุ่น โปรดดูแอตทริบิวต์ Model.output_token_limit ของ Model ที่แสดงผลจากฟังก์ชัน getModel
temperature
number
ไม่บังคับ ควบคุมความสุ่มของเอาต์พุต
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตามรุ่น โปรดดูแอตทริบิวต์ Model.temperature ของ Model ที่แสดงผลจากฟังก์ชัน getModel
ค่าที่ใช้ได้อยู่ในช่วง [0.0, 2.0]
topP
number
ไม่บังคับ ความน่าจะเป็นสะสมสูงสุดของโทเค็นที่ต้องพิจารณาเมื่อทำการสุ่มตัวอย่าง
โมเดลนี้ใช้การสุ่มตัวอย่างแบบรวม Top-k และ Top-p (นิวเคลียส)
ระบบจะจัดเรียงโทเค็นตามความน่าจะเป็นที่กำหนด เพื่อให้พิจารณาเฉพาะโทเค็นที่มีแนวโน้มมากที่สุด การสุ่มตัวอย่าง Top-k จะจำกัดจำนวนโทเค็นสูงสุดที่จะพิจารณาโดยตรง ในขณะที่การสุ่มตัวอย่าง Nucleus จะจำกัดจำนวนโทเค็นตามความน่าจะเป็นสะสม
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตาม Model และระบุโดยแอตทริบิวต์ Model.top_p ที่แสดงผลจากฟังก์ชัน getModel แอตทริบิวต์ topK ที่ว่างเปล่าบ่งบอกว่าโมเดลไม่ได้ใช้การสุ่มตัวอย่างแบบ Top-k และไม่อนุญาตให้ตั้งค่า topK ในคำขอ
topK
integer
ไม่บังคับ จำนวนโทเค็นสูงสุดที่จะพิจารณาเมื่อทำการสุ่มตัวอย่าง
โมเดล Gemini ใช้การสุ่มตัวอย่าง Top-p (นิวเคลียส) หรือใช้ทั้งการสุ่มตัวอย่าง Top-k และนิวเคลียส การสุ่มตัวอย่าง Top-k จะพิจารณาชุดโทเค็นที่มีtopKความน่าจะเป็นสูงสุด โมเดลที่ทำงานด้วยการสุ่มตัวอย่างนิวเคลียสไม่อนุญาตให้ตั้งค่า topK
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตาม Model และระบุโดยแอตทริบิวต์ Model.top_p ที่แสดงผลจากฟังก์ชัน getModel แอตทริบิวต์ topK ที่ว่างเปล่าบ่งบอกว่าโมเดลไม่ได้ใช้การสุ่มตัวอย่างแบบ Top-k และไม่อนุญาตให้ตั้งค่า topK ในคำขอ
seed
integer
ไม่บังคับ Seed ที่ใช้ในการถอดรหัส หากไม่ได้ตั้งค่า คำขอจะใช้ Seed ที่สร้างขึ้นแบบสุ่ม
presencePenalty
number
ไม่บังคับ ใช้ค่าปรับการปรากฏกับ logprobs ของโทเค็นถัดไปหากโทเค็นนั้นปรากฏในคำตอบแล้ว
การลงโทษนี้จะเปิด/ปิดได้เท่านั้น และไม่ขึ้นอยู่กับจำนวนครั้งที่มีการใช้โทเค็น (หลังจากครั้งแรก) ใช้ frequencyPenalty สำหรับค่าปรับที่จะเพิ่มขึ้นตามการใช้งานแต่ละครั้ง
ค่าปรับที่เป็นบวกจะกีดกันการใช้โทเค็นที่ใช้ไปแล้วในการตอบกลับ ซึ่งจะช่วยเพิ่มคำศัพท์
การลงโทษเชิงลบจะกระตุ้นให้ใช้โทเค็นที่ใช้ไปแล้วในการตอบกลับ ซึ่งจะช่วยลดคำศัพท์
frequencyPenalty
number
ไม่บังคับ ค่าปรับความถี่ที่ใช้กับ logprobs ของโทเค็นถัดไป คูณด้วยจำนวนครั้งที่โทเค็นแต่ละรายการปรากฏในคำตอบจนถึงตอนนี้
การลงโทษเชิงบวกจะกีดกันการใช้โทเค็นที่ใช้ไปแล้วตามสัดส่วนของจำนวนครั้งที่ใช้โทเค็นนั้น ยิ่งใช้โทเค็นมากเท่าใด โมเดลก็จะยิ่งใช้โทเค็นนั้นอีกครั้งได้ยากขึ้นเท่านั้น ซึ่งจะช่วยเพิ่มคำศัพท์ในการตอบกลับ
ข้อควรระวัง: การลงโทษแบบค่าลบจะกระตุ้นให้โมเดลใช้โทเค็นซ้ำตามสัดส่วนของจำนวนครั้งที่มีการใช้โทเค็น ค่าลบขนาดเล็กจะลดคำศัพท์ของคำตอบ ค่าลบที่มากขึ้นจะทำให้โมเดลเริ่มทำซ้ำโทเค็นทั่วไปจนกว่าจะถึงขีดจำกัด maxOutputTokens
responseLogprobs
boolean
ไม่บังคับ หากเป็นจริง ให้ส่งออกผลลัพธ์ logprobs ในการตอบกลับ
logprobs
integer
ไม่บังคับ ใช้ได้เฉพาะในกรณีที่ responseLogprobs=True ซึ่งจะกำหนดจำนวน logprob สูงสุด รวมถึงตัวเลือกที่เลือก เพื่อส่งคืนในแต่ละขั้นตอนการถอดรหัสใน Candidate.logprobs_result ตัวเลขต้องอยู่ในช่วง [0, 20]
enableEnhancedCivicAnswers
boolean
ไม่บังคับ เปิดใช้คำตอบเกี่ยวกับพลเมืองที่ปรับปรุงแล้ว โดยอาจไม่พร้อมใช้งานในบางรุ่น
speechConfig
object (SpeechConfig)
ไม่บังคับ การกำหนดค่าการสร้างคำพูด
thinkingConfig
object (ThinkingConfig)
ไม่บังคับ กำหนดค่าฟีเจอร์การคิด ระบบจะแสดงข้อผิดพลาดหากตั้งค่าฟิลด์นี้สำหรับโมเดลที่ไม่รองรับการคิด
imageConfig
object (ImageConfig)
ไม่บังคับ กำหนดค่าสำหรับการสร้างรูปภาพ ระบบจะแสดงข้อผิดพลาดหากตั้งค่าฟิลด์นี้สำหรับโมเดลที่ไม่รองรับตัวเลือกการกำหนดค่าเหล่านี้
mediaResolution
enum (MediaResolution)
ไม่บังคับ หากระบุไว้ ระบบจะใช้ความละเอียดของสื่อที่ระบุ
| การแสดง JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
รูปแบบ
รูปแบบการตอบกลับที่รองรับ
| Enum | |
|---|---|
MODALITY_UNSPECIFIED |
ค่าเริ่มต้น |
TEXT |
ระบุว่าโมเดลควรแสดงผลข้อความ |
IMAGE |
ระบุว่าโมเดลควรแสดงรูปภาพ |
AUDIO |
ระบุว่าโมเดลควรส่งคืนเสียง |
SpeechConfig
กำหนดค่าสำหรับการสร้างและการถอดเสียงเป็นคำ
voiceConfig
object (VoiceConfig)
การกำหนดค่าในกรณีที่เอาต์พุตเป็นเสียงเดียว
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
ไม่บังคับ การกำหนดค่าสำหรับการตั้งค่าลำโพงหลายตัว ซึ่งจะใช้ร่วมกับฟิลด์ voiceConfig ไม่ได้
languageCode
string
ไม่บังคับ รหัสภาษา BCP-47 ของ IETF ที่ผู้ใช้กำหนดค่าให้แอปใช้ ใช้สำหรับการจดจำและสังเคราะห์คำพูด
ค่าที่ถูกต้องคือ de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU และ th-TH
| การแสดง JSON |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
การกำหนดค่าสำหรับเสียงที่จะใช้
voice_config
Union type
voice_config ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นprebuiltVoiceConfig
object (PrebuiltVoiceConfig)
การกำหนดค่าสำหรับเสียงที่สร้างไว้ล่วงหน้าที่จะใช้
| การแสดง JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
การกำหนดค่าสำหรับลำโพงที่สร้างไว้ล่วงหน้าที่จะใช้
voiceName
string
ชื่อของเสียงที่กำหนดไว้ล่วงหน้าที่จะใช้
| การแสดง JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
การกำหนดค่าสำหรับการตั้งค่าลำโพงหลายตัว
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
ต้องระบุ เสียงลำโพงที่เปิดใช้ทั้งหมด
| การแสดง JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
การกำหนดค่าสำหรับลำโพงตัวเดียวในการตั้งค่าลำโพงหลายตัว
speaker
string
ต้องระบุ ชื่อของลำโพงที่จะใช้ ควรเหมือนกับในพรอมต์
voiceConfig
object (VoiceConfig)
ต้องระบุ การกำหนดค่าสำหรับเสียงที่จะใช้
| การแสดง JSON |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
กำหนดค่าฟีเจอร์การคิด
includeThoughts
boolean
ระบุว่าจะรวมความคิดเห็นไว้ในการตอบกลับหรือไม่ หากเป็นจริง ระบบจะแสดงความคิดเห็นเมื่อพร้อมใช้งานเท่านั้น
thinkingBudget
integer
จำนวนโทเค็นความคิดที่โมเดลควรสร้าง
thinkingLevel
enum (ThinkingLevel)
ไม่บังคับ ควบคุมความลึกสูงสุดของกระบวนการให้เหตุผลภายในของโมเดลก่อนที่จะสร้างคำตอบ หากไม่ได้ระบุ ระบบจะใช้ HIGH เป็นค่าเริ่มต้น แนะนำสำหรับรุ่น Gemini 3 ขึ้นไป การใช้กับรุ่นก่อนหน้าจะทำให้เกิดข้อผิดพลาด
| การแสดง JSON |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
อนุญาตให้ผู้ใช้ระบุจำนวนเงินที่จะใช้โดยใช้ Enum แทนงบประมาณจำนวนเต็ม
| Enum | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
ค่าเริ่มต้น |
MINIMAL |
ไม่ต้องคิดมาก |
LOW |
ระดับการคิดต่ำ |
MEDIUM |
ระดับการคิดปานกลาง |
HIGH |
ระดับการคิดสูง |
ImageConfig
การกำหนดค่าสำหรับฟีเจอร์การสร้างรูปภาพ
aspectRatio
string
ไม่บังคับ สัดส่วนภาพที่จะสร้าง สัดส่วนภาพที่รองรับ: 1:1, 1:4, 4:1, 1:8, 8:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9 หรือ 21:9
หากไม่ได้ระบุ โมเดลจะเลือกสัดส่วนภาพเริ่มต้นตามรูปภาพอ้างอิงที่ระบุ
imageSize
string
ไม่บังคับ ระบุขนาดของรูปภาพที่สร้างขึ้น ค่าที่รองรับคือ 512, 1K, 2K, 4K หากไม่ได้ระบุ โมเดลจะใช้ค่าเริ่มต้น 1K
| การแสดง JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
ความละเอียดของสื่อสำหรับสื่ออินพุต
| Enum | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
ยังไม่ได้ตั้งค่าความละเอียดของสื่อ |
MEDIA_RESOLUTION_LOW |
ตั้งค่าความละเอียดของสื่อเป็นต่ำ (64 โทเค็น) |
MEDIA_RESOLUTION_MEDIUM |
ตั้งค่าความละเอียดของสื่อเป็นปานกลาง (256 โทเค็น) |
MEDIA_RESOLUTION_HIGH |
ตั้งค่าความละเอียดของสื่อเป็นสูง (การจัดเฟรมใหม่แบบซูมที่มีโทเค็น 256 รายการ) |
HarmCategory
หมวดหมู่ของการจัดประเภท
หมวดหมู่เหล่านี้ครอบคลุมอันตรายประเภทต่างๆ ที่นักพัฒนาแอปอาจต้องการปรับ
| Enum | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
ไม่ได้ระบุหมวดหมู่ |
HARM_CATEGORY_DEROGATORY |
PaLM - ความคิดเห็นเชิงลบหรือเป็นอันตรายที่กำหนดเป้าหมายไปยังข้อมูลประจำตัวและ/หรือแอตทริบิวต์ที่ได้รับการคุ้มครอง |
HARM_CATEGORY_TOXICITY |
PaLM - เนื้อหาที่หยาบคาย ไม่เคารพ หรือหยาบคาย |
HARM_CATEGORY_VIOLENCE |
PaLM - อธิบายสถานการณ์ที่แสดงความรุนแรงต่อบุคคลหรือกลุ่มบุคคล หรือคำอธิบายทั่วไปเกี่ยวกับภาพสยดสยอง |
HARM_CATEGORY_SEXUAL |
PaLM - มีการอ้างอิงถึงการกระทำทางเพศหรือเนื้อหาลามกอื่นๆ |
HARM_CATEGORY_MEDICAL |
PaLM - โปรโมตคำแนะนำทางการแพทย์ที่ไม่ได้ตรวจสอบ |
HARM_CATEGORY_DANGEROUS |
PaLM - เนื้อหาที่เป็นอันตรายซึ่งส่งเสริม สนับสนุน หรือก่อให้เกิดการกระทําที่เป็นอันตราย |
HARM_CATEGORY_HARASSMENT |
Gemini - เนื้อหาที่แสดงการคุกคาม |
HARM_CATEGORY_HATE_SPEECH |
Gemini - วาจาสร้างความเกลียดชังและเนื้อหา |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - เนื้อหาเกี่ยวกับเรื่องเพศอย่างโจ่งแจ้ง |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - เนื้อหาไม่ปลอดภัย |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini - เนื้อหาที่อาจใช้เพื่อทำลายความสมบูรณ์ของพลเมือง เลิกใช้งานแล้ว: โปรดใช้ enableEnhancedCivicAnswers แทน |
ModalityTokenCount
แสดงข้อมูลการนับโทเค็นสำหรับรูปแบบเดียว
modality
enum (Modality)
รูปแบบที่เชื่อมโยงกับจำนวนโทเค็นนี้
tokenCount
integer
จำนวนโทเค็น
| การแสดง JSON |
|---|
{
"modality": enum ( |
รูปแบบ
รูปแบบเนื้อหา
| Enum | |
|---|---|
MODALITY_UNSPECIFIED |
รูปแบบที่ไม่ระบุ |
TEXT |
ข้อความธรรมดา |
IMAGE |
รูปภาพ |
VIDEO |
วิดีโอ |
AUDIO |
เสียง |
DOCUMENT |
เอกสาร เช่น PDF |
SafetyRating
คะแนนความปลอดภัยสำหรับเนื้อหา
การจัดประเภทความปลอดภัยประกอบด้วยหมวดหมู่ของอันตรายและระดับความน่าจะเป็นของอันตรายในหมวดหมู่นั้นสำหรับเนื้อหาหนึ่งๆ ระบบจะจัดประเภทเนื้อหาเพื่อความปลอดภัยในหมวดหมู่ความเสียหายต่างๆ และรวมความน่าจะเป็นของการจัดประเภทความเสียหายไว้ที่นี่
category
enum (HarmCategory)
ต้องระบุ หมวดหมู่ของคะแนนนี้
probability
enum (HarmProbability)
ต้องระบุ ความน่าจะเป็นอันตรายสำหรับเนื้อหานี้
blocked
boolean
เนื้อหานี้ถูกบล็อกเนื่องจากมีการจัดประเภทนี้ใช่ไหม
| การแสดง JSON |
|---|
{ "category": enum ( |
HarmProbability
ความน่าจะเป็นที่เนื้อหาจะเป็นอันตราย
ระบบการจัดประเภทจะให้ความน่าจะเป็นที่เนื้อหาจะไม่ปลอดภัย ซึ่งไม่ได้บ่งบอกถึงความรุนแรงของอันตรายสำหรับเนื้อหาชิ้นหนึ่งๆ
| Enum | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED |
ไม่ได้ระบุความน่าจะเป็น |
NEGLIGIBLE |
เนื้อหามีโอกาสน้อยมากที่จะไม่ปลอดภัย |
LOW |
เนื้อหามีโอกาสต่ำที่จะไม่ปลอดภัย |
MEDIUM |
เนื้อหามีโอกาสปานกลางที่จะไม่ปลอดภัย |
HIGH |
เนื้อหามีโอกาสสูงที่จะไม่ปลอดภัย |
SafetySetting
การตั้งค่าความปลอดภัยซึ่งส่งผลต่อลักษณะการทำงานของการบล็อกที่ไม่ปลอดภัย
การส่งการตั้งค่าความปลอดภัยสำหรับหมวดหมู่จะเปลี่ยนความน่าจะเป็นที่อนุญาตซึ่งเนื้อหาจะถูกบล็อก
category
enum (HarmCategory)
ต้องระบุ หมวดหมู่ของการตั้งค่านี้
threshold
enum (HarmBlockThreshold)
ต้องระบุ ควบคุมเกณฑ์ความน่าจะเป็นที่จะบล็อกอันตราย
| การแสดง JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
บล็อกที่และเกินความน่าจะเป็นที่จะเกิดอันตรายที่ระบุ
| Enum | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
ไม่ได้ระบุเกณฑ์ |
BLOCK_LOW_AND_ABOVE |
เนื้อหาที่มีการเปลือยเปล่าเล็กน้อยจะได้รับอนุญาต |
BLOCK_MEDIUM_AND_ABOVE |
เนื้อหาที่มีความเสี่ยง "เล็กน้อย" และ "ต่ำ" จะได้รับอนุญาต |
BLOCK_ONLY_HIGH |
เนื้อหาที่มีระดับความเสี่ยงเป็น "ต่ำมาก" "ต่ำ" และ "ปานกลาง" จะได้รับอนุญาต |
BLOCK_NONE |
ระบบจะอนุญาตเนื้อหาทั้งหมด |
OFF |
ปิดตัวกรองความปลอดภัย |