Gemini API รองรับการสร้างเนื้อหาด้วยรูปภาพ เสียง โค้ด เครื่องมือ และอื่นๆ อ่านรายละเอียดเกี่ยวกับฟีเจอร์แต่ละรายการเหล่านี้ต่อและดูโค้ดตัวอย่างที่มุ่งเน้นงาน หรืออ่านคู่มือที่ครอบคลุม
เมธอด: models.generateContent
สร้างคำตอบของโมเดลจากอินพุต GenerateContentRequest
ดูข้อมูลการใช้งานโดยละเอียดได้ในคู่มือการสร้างข้อความ ความสามารถในการป้อนข้อมูลจะแตกต่างกันไปในแต่ละรุ่น ซึ่งรวมถึงรุ่นที่ปรับแต่งแล้ว ดูรายละเอียดได้ในคู่มือโมเดลและคู่มือการปรับแต่ง
ปลายทาง
โพสต์https://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
การตั้งค่าสำหรับ SafetyCategory
แต่ละประเภทไม่ควรมีมากกว่า 1 รายการ 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}
ตัวอย่างคำขอ
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GenerateContentResponse
เมธอด: models.streamGenerateContent
สร้างคำตอบแบบสตรีมจากโมเดลที่ได้รับอินพุต GenerateContentRequest
ปลายทาง
โพสต์https://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
การตั้งค่าสำหรับ SafetyCategory
แต่ละประเภทไม่ควรมีมากกว่า 1 รายการ 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}
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีสตรีมของอินสแตนซ์ GenerateContentResponse
GenerateContentResponse
การตอบกลับจากโมเดลที่รองรับคำตอบที่เป็นไปได้หลายรายการ
ระบบจะรายงานการจัดประเภทความปลอดภัยและการกรองเนื้อหาสำหรับทั้งพรอมต์ใน GenerateContentResponse.prompt_feedback
และสำหรับผู้สมัครแต่ละรายใน finishReason
และใน safetyRatings
API จะดำเนินการดังนี้ - แสดงผลลัพธ์ทั้งหมดที่ขอหรือไม่แสดงผลลัพธ์ใดๆ เลย - แสดงผลลัพธ์เป็น 0 เฉพาะในกรณีที่พรอมต์ไม่ถูกต้อง (ดู promptFeedback
) - รายงานความคิดเห็นเกี่ยวกับผู้สมัครแต่ละรายใน finishReason
และ safetyRatings
candidates[]
object (Candidate
)
คำตอบที่เป็นไปได้จากโมเดล
promptFeedback
object (PromptFeedback
)
แสดงความคิดเห็นของพรอมต์ที่เกี่ยวข้องกับตัวกรองเนื้อหา
usageMetadata
object (UsageMetadata
)
เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับการใช้โทเค็นของคำขอสร้าง
modelVersion
string
เอาต์พุตเท่านั้น เวอร์ชันโมเดลที่ใช้สร้างคำตอบ
การแสดง 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 ( |
ผู้สมัคร
- การแสดง JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- เว็บ
- GroundingSupport
- กลุ่ม
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- ผู้สมัคร
ตัวเลือกคำตอบที่สร้างขึ้นจากโมเดล
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
)
เอาต์พุตเท่านั้น คะแนนความน่าจะเป็นเชิงสถิติสำหรับโทเค็นคำตอบและโทเค็นยอดนิยม
index
integer
เอาต์พุตเท่านั้น ดัชนีของผู้สมัครในรายการผู้สมัครตอบกลับ
การแสดง JSON |
---|
{ "content": { object ( |
FinishReason
ระบุสาเหตุที่โมเดลหยุดสร้างโทเค็น
Enum | |
---|---|
FINISH_REASON_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน |
STOP |
จุดสิ้นสุดตามปกติของโมเดลหรือลำดับการหยุดที่ระบุ |
MAX_TOKENS |
มีโทเค็นถึงจำนวนสูงสุดตามที่ระบุไว้ในคำขอแล้ว |
SAFETY |
เนื้อหาที่เป็นไปได้สำหรับคำตอบถูกแจ้งว่าไม่เหมาะสมเนื่องจากเหตุผลด้านความปลอดภัย |
RECITATION |
เนื้อหาคำตอบของผู้สมัครถูกแจ้งว่าเป็นการท่องจำ |
LANGUAGE |
เนื้อหาคำตอบที่เป็นไปได้ถูกแจ้งว่าไม่เหมาะสมเนื่องจากใช้ภาษาที่ไม่รองรับ |
OTHER |
ไม่ทราบสาเหตุ |
BLOCKLIST |
การสร้างโทเค็นหยุดลงเนื่องจากเนื้อหามีคำต้องห้าม |
PROHIBITED_CONTENT |
การสร้างโทเค็นหยุดลงเนื่องจากอาจมีการเผยแพร่เนื้อหาต้องห้าม |
SPII |
การสร้างโทเค็นหยุดลงเนื่องจากเนื้อหามีแนวโน้มที่จะข้อมูลส่วนบุคคลที่ละเอียดอ่อนและระบุตัวบุคคลนั้นได้ (SPII) |
MALFORMED_FUNCTION_CALL |
การเรียกใช้ฟังก์ชันที่โมเดลสร้างขึ้นไม่ถูกต้อง |
IMAGE_SAFETY |
การสร้างโทเค็นหยุดลงเนื่องจากรูปภาพที่สร้างขึ้นมีการละเมิดความปลอดภัย |
GroundingAttribution
การระบุแหล่งที่มาของแหล่งข้อมูลที่มีส่วนทำให้เกิดคำตอบ
sourceId
object (AttributionSourceId
)
เอาต์พุตเท่านั้น ตัวระบุแหล่งที่มาที่มีส่วนร่วมในการระบุแหล่งที่มานี้
content
object (Content
)
เนื้อหาแหล่งที่มาที่เป็นต้นทางของการระบุแหล่งที่มานี้
การแสดง JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
ตัวระบุแหล่งที่มาที่มีส่วนร่วมในการระบุแหล่งที่มานี้
source
Union type
source
ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นgroundingPassage
object (GroundingPassageId
)
ตัวระบุสำหรับข้อความย่อยในบรรทัด
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
ตัวระบุของ Chunk
ที่ดึงข้อมูลผ่าน Semantic Retriever
การแสดง JSON |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
ตัวระบุของชิ้นส่วนภายใน GroundingPassage
passageId
string
เอาต์พุตเท่านั้น รหัสของข้อความที่ตรงกับGroundingPassage.id
ของ GenerateAnswerRequest
partIndex
integer
เอาต์พุตเท่านั้น ดัชนีของส่วนภายใน GroundingPassage.content
ของ GenerateAnswerRequest
การแสดง JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
ตัวระบุสำหรับ Chunk
ที่ดึงข้อมูลผ่าน Semantic Retriever ที่ระบุไว้ใน 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 สำหรับการค้นหาเว็บที่ตามมา
searchEntryPoint
object (SearchEntryPoint
)
ไม่บังคับ รายการการค้นหาของ Google สําหรับการค้นหาเว็บที่ตามมา
retrievalMetadata
object (RetrievalMetadata
)
ข้อมูลเมตาที่เกี่ยวข้องกับการดึงข้อมูลในขั้นตอนการกราวด์
การแสดง JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
จุดแรกเข้าของ Google Search
renderedContent
string
ไม่บังคับ ข้อมูลโค้ดที่ติดทั่วเว็บไซต์ซึ่งฝังไว้ในหน้าเว็บหรือเว็บวิวของแอปได้
sdkBlob
string (bytes format)
ไม่บังคับ JSON ที่เข้ารหัส Base64 ซึ่งแสดงอาร์เรย์ของคู่ <ข้อความค้นหา, URL ค้นหา>
สตริงที่เข้ารหัส Base64
การแสดง JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Chunk พื้นฐาน
chunk_type
Union type
chunk_type
ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นweb
object (Web
)
ส่วนของข้อมูลพื้นฐานจากเว็บ
การแสดง JSON |
---|
{
// chunk_type
"web": {
object ( |
เว็บ
ข้อมูลบางส่วนจากเว็บ
uri
string
ข้อมูลอ้างอิง URI ของข้อมูล
title
string
ชื่อของข้อมูล
การแสดง JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
การสนับสนุนการต่อสายกราวด์
groundingChunkIndices[]
integer
รายการดัชนี (ใน "grounding_chunk") ที่ระบุการอ้างอิงที่เกี่ยวข้องกับการอ้างสิทธิ์ เช่น [1,3,4] หมายความว่า grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] คือเนื้อหาที่ดึงมาซึ่งมีการระบุแหล่งที่มาว่ามาจากการอ้างสิทธิ์
confidenceScores[]
number
คะแนนความเชื่อมั่นของข้อมูลอ้างอิงการสนับสนุน อยู่ในช่วง 0 ถึง 1 โดย 1 คือมั่นใจมากที่สุด รายการนี้ต้องมีขนาดเท่ากับ groundingChunkIndices
segment
object (Segment
)
ส่วนเนื้อหาที่การสนับสนุนนี้เกี่ยวข้อง
การแสดง JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
กลุ่ม
ส่วนของเนื้อหา
partIndex
integer
เอาต์พุตเท่านั้น ดัชนีของออบเจ็กต์ส่วนภายในออบเจ็กต์เนื้อหาหลัก
startIndex
integer
เอาต์พุตเท่านั้น ดัชนีเริ่มต้นในส่วนที่ระบุ ซึ่งวัดเป็นไบต์ ส่วนต่างจากจุดเริ่มต้นของส่วน โดยนับรวมและเริ่มต้นที่ 0
endIndex
integer
เอาต์พุตเท่านั้น ดัชนีสิ้นสุดในส่วนที่ระบุ ซึ่งวัดเป็นไบต์ ส่วนต่างจากจุดเริ่มต้นของส่วน โดยเริ่มที่ 0
text
string
เอาต์พุตเท่านั้น ข้อความที่สอดคล้องกับส่วนของคำตอบ
การแสดง JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
ข้อมูลเมตาที่เกี่ยวข้องกับการดึงข้อมูลในขั้นตอนการกราวด์
googleSearchDynamicRetrievalScore
number
ไม่บังคับ คะแนนที่บ่งบอกถึงความเป็นไปได้ที่ข้อมูลจากการค้นหาของ Google จะช่วยตอบพรอมต์ คะแนนอยู่ในช่วง [0, 1] โดยที่ 0 หมายถึงมีแนวโน้มน้อยที่สุดและ 1 หมายถึงมีแนวโน้มมากที่สุด ระบบจะป้อนข้อมูลคะแนนนี้เมื่อเปิดใช้การเชื่อมโยงกับ Google Search และการดึงข้อมูลแบบไดนามิกเท่านั้น ระบบจะเปรียบเทียบกับเกณฑ์เพื่อพิจารณาว่าจะเรียกใช้ Google Search หรือไม่
การแสดง JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
ผลลัพธ์ Logprobs
topCandidates[]
object (TopCandidates
)
ความยาว = จํานวนขั้นตอนทั้งหมดในการถอดรหัส
chosenCandidates[]
object (Candidate
)
ความยาว = จํานวนขั้นตอนทั้งหมดในการถอดรหัส ผู้สมัครที่เลือกอาจอยู่ใน topCandidates หรือไม่ก็ได้
การแสดง JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
ผู้สมัครที่มีความน่าจะเป็นของบันทึกสูงสุดในแต่ละขั้นตอนการถอดรหัส
candidates[]
object (Candidate
)
จัดเรียงตามความน่าจะเป็นเชิงลอจิสติกจากมากไปน้อย
การแสดง JSON |
---|
{
"candidates": [
{
object ( |
ผู้สมัคร
ผู้สมัครสำหรับโทเค็นและคะแนน logprobs
token
string
ค่าสตริงโทเค็นของผู้สมัคร
tokenId
integer
ค่ารหัสโทเค็นของผู้สมัคร
logProbability
number
ความน่าจะเป็นของบันทึกของผู้สมัคร
การแสดง JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
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
ตัวเลือกการกําหนดค่าสําหรับการสร้างโมเดลและเอาต์พุต พารามิเตอร์บางรายการอาจกำหนดค่าไม่ได้สำหรับบางรุ่น
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
ไว้ ก็ต้องตั้งค่า responseMimeType
ที่เข้ากันได้ด้วย ประเภท MIME ที่เข้ากันได้: application/json
: สคีมาสำหรับการตอบกลับ JSON ดูรายละเอียดเพิ่มเติมได้ที่คู่มือการสร้างข้อความ JSON
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
รายการ โมเดลที่ทำงานด้วยการสุ่มตัวอย่าง Nucleus ไม่อนุญาตให้ตั้งค่า topK
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตาม Model
และระบุโดยแอตทริบิวต์ Model.top_p
ที่แสดงผลจากฟังก์ชัน getModel
แอตทริบิวต์ topK
ที่ว่างเปล่าบ่งบอกว่าโมเดลไม่ได้ใช้การสุ่มตัวอย่าง Top-K และไม่อนุญาตให้ตั้งค่า topK
ในคำขอ
seed
integer
ไม่บังคับ เมล็ดที่ใช้ในการถอดรหัส หากไม่ได้ตั้งค่า คำขอจะใช้ Seed ที่สร้างขึ้นแบบสุ่ม
presencePenalty
number
ไม่บังคับ บทลงโทษการปรากฏมีผลกับ logprobs ของโทเค็นถัดไปหากระบบเคยเห็นโทเค็นนั้นในการตอบกลับแล้ว
การลงโทษนี้จะเป็นแบบเปิด/ปิดแบบ 2 ค่า และไม่ขึ้นอยู่กับจำนวนครั้งที่ใช้โทเค็น (หลังจากครั้งแรก) ใช้ frequencyPenalty
สำหรับบทลงโทษที่เพิ่มขึ้นทุกครั้งที่มีการใช้
การลงโทษเชิงบวกจะทําให้ระบบไม่ใช้โทเค็นที่เคยใช้ในคําตอบ ซึ่งจะเพิ่มคําศัพท์
การลงโทษเชิงลบจะส่งเสริมให้ใช้โทเค็นที่เคยใช้ในคำตอบแล้ว ซึ่งจะลดคลังคำศัพท์
frequencyPenalty
number
ไม่บังคับ การลดคะแนนความถี่ที่มีผลกับ logprobs ของโทเค็นถัดไป คูณด้วยจํานวนครั้งที่เห็นโทเค็นแต่ละรายการในการตอบกลับจนถึงตอนนี้
การลงโทษเชิงบวกจะทําให้ระบบไม่ใช้โทเค็นที่เคยใช้ไปแล้ว โดยการลงโทษจะสัมพันธ์กับจํานวนครั้งที่ใช้โทเค็นนั้น ยิ่งใช้โทเค็นมากเท่าใด โมเดลก็จะยิ่งใช้โทเค็นนั้นอีกครั้งได้ยากขึ้นเท่านั้น ซึ่งจะเพิ่มคําศัพท์ของคำตอบ
ข้อควรระวัง: การลดคะแนนเชิงลบจะกระตุ้นให้โมเดลนําโทเค็นมาใช้ซ้ำตามสัดส่วนจํานวนครั้งที่มีการใช้โทเค็น ค่าลบเล็กๆ จะลดคําศัพท์ของการตอบกลับ ค่าลบที่มากขึ้นจะทำให้โมเดลเริ่มใช้โทเค็นทั่วไปซ้ำๆ จนกว่าจะถึงขีดจํากัด maxOutputTokens
responseLogprobs
boolean
ไม่บังคับ หากเป็น "จริง" ระบบจะส่งออกผลลัพธ์ logprobs ในการตอบกลับ
logprobs
integer
ไม่บังคับ ใช้ได้เฉพาะในกรณีที่ responseLogprobs=True
ซึ่งจะตั้งค่าจำนวน logprobs สูงสุดที่จะแสดงในแต่ละขั้นตอนการถอดรหัสใน Candidate.logprobs_result
enableEnhancedCivicAnswers
boolean
ไม่บังคับ เปิดใช้คำตอบเกี่ยวกับข้อมูลประชากรที่ปรับปรุงแล้ว โดยอาจไม่พร้อมใช้งานสำหรับบางรุ่น
speechConfig
object (SpeechConfig
)
ไม่บังคับ การกําหนดค่าการสร้างเสียง
mediaResolution
enum (MediaResolution
)
ไม่บังคับ หากระบุไว้ ระบบจะใช้ความละเอียดของสื่อที่ระบุ
การแสดง JSON |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
รูปแบบ
รูปแบบคำตอบที่รองรับ
Enum | |
---|---|
MODALITY_UNSPECIFIED |
ค่าเริ่มต้น |
TEXT |
ระบุว่าโมเดลควรแสดงผลข้อความ |
IMAGE |
ระบุว่าโมเดลควรแสดงผลรูปภาพ |
AUDIO |
ระบุว่าโมเดลควรแสดงผลเป็นเสียง |
SpeechConfig
การกําหนดค่าการสร้างเสียง
voiceConfig
object (VoiceConfig
)
การกําหนดค่าสําหรับลําโพงที่จะใช้
การแสดง JSON |
---|
{
"voiceConfig": {
object ( |
VoiceConfig
การกําหนดค่าเสียงที่จะใช้
voice_config
Union type
voice_config
ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นprebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
การกําหนดค่าเสียงที่สร้างไว้ล่วงหน้าที่จะใช้
การแสดง JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
การกําหนดค่าสําหรับลําโพงที่สร้างไว้ล่วงหน้าที่จะใช้
voiceName
string
ชื่อของเสียงที่กำหนดล่วงหน้าที่จะใช้
การแสดง JSON |
---|
{ "voiceName": 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 - เนื้อหาที่อาจนำไปใช้เพื่อทำลายความสุจริตของพลเมือง |
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 |
เนื้อหาที่มีค่า NEGLIGIBLE จะได้รับการอนุญาต |
BLOCK_MEDIUM_AND_ABOVE |
เนื้อหาที่มีระดับ "ไม่มีนัยสำคัญ" และ "ต่ำ" จะได้รับการอนุญาต |
BLOCK_ONLY_HIGH |
เนื้อหาที่มีระดับ "ไม่มีนัยสำคัญ" "ต่ำ" และ "ปานกลาง" จะได้รับการอนุญาต |
BLOCK_NONE |
อนุญาตเนื้อหาทั้งหมด |
OFF |
ปิดตัวกรองความปลอดภัย |