เมธอด: collections.generateContent
สร้างการตอบสนองจากโมเดลที่มีอินพุต GenerateContentRequest
ความสามารถในการป้อนข้อมูลจะแตกต่างกันไปในแต่ละโมเดล รวมถึงโมเดลที่ปรับแต่งด้วย ดูรายละเอียดได้ในคู่มือรุ่นและคู่มือการปรับแต่ง
ปลายทาง
โพสต์
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateContent
พารามิเตอร์เส้นทาง
model
string
ต้องระบุ ชื่อของ Model
ที่จะใช้ในการสร้างการดำเนินการให้เสร็จสมบูรณ์
รูปแบบ: name=models/{model}
โดยใช้รูปแบบ models/{model}
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
contents[]
object (Content
)
ต้องระบุ เนื้อหาของการสนทนาปัจจุบันกับโมเดล
สำหรับการค้นหาแบบเลี้ยวเดียว อินสแตนซ์นี้เป็นอินสแตนซ์เดียว สำหรับการค้นหาแบบหลายเลี้ยว ช่องนี้เป็นฟิลด์ที่ซ้ำได้ซึ่งมีประวัติการสนทนาและคำขอล่าสุด
tools[]
object (Tool
)
ไม่บังคับ รายการของ Tools
ที่โมเดลอาจใช้เพื่อสร้างคำตอบถัดไป
Tool
คือโค้ดที่ช่วยให้ระบบโต้ตอบกับระบบภายนอกเพื่อดำเนินการหรือชุดการดำเนินการที่อยู่นอกเหนือความรู้และขอบเขตของโมเดลได้ ปัจจุบันเครื่องมือที่รองรับมีเพียงFunction
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
systemInstruction
object (Content
)
ไม่บังคับ คำสั่งของระบบชุดนักพัฒนาแอป ขณะนี้มีเพียงข้อความเท่านั้น
generationConfig
object (GenerationConfig
)
ไม่บังคับ ตัวเลือกการกำหนดค่าสำหรับการสร้างและเอาต์พุตโมเดล
cachedContent
string
ไม่บังคับ ชื่อของเนื้อหาที่แคชซึ่งใช้เป็นบริบทในการแสดงการคาดการณ์ หมายเหตุ: ใช้การแคชอย่างชัดแจ้งเท่านั้น ซึ่งผู้ใช้สามารถควบคุมการแคชได้ (เช่น เนื้อหาที่จะแคช) และประหยัดต้นทุนอย่างแน่นอน รูปแบบ: cachedContents/{cachedContent}
ตัวอย่างคำขอ
ข้อความ
Python
Node.js
Kotlin
Swift
Dart
Java
รูปภาพ
Python
Node.js
Kotlin
Swift
Dart
Java
เสียง
Python
Node.js
วิดีโอ
Python
Node.js
แชท
Python
Node.js
เปลือกหอย
Kotlin
Swift
Dart
Java
แคช
Python
Node.js
โมเดลที่ปรับแล้ว
Python
โหมด JSON
Python
Node.js
Kotlin
Swift
Dart
Java
การเรียกใช้โค้ด
Python
Kotlin
Java
การเรียกใช้ฟังก์ชัน
Python
Node.js
Kotlin
Swift
Dart
Java
การกำหนดค่าการสร้าง
Python
Node.js
เปลือกหอย
Kotlin
Swift
Dart
Java
การตั้งค่าความปลอดภัย
Python
Node.js
เปลือกหอย
Kotlin
Swift
Dart
Java
คำแนะนำของระบบ
Python
Node.js
Kotlin
Swift
Dart
Java
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GenerateContentResponse
เมธอด: model.streamGenerateContent
สร้างการตอบสนองที่สตรีมจากโมเดลที่มีอินพุต GenerateContentRequest
ปลายทาง
โพสต์
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContent
พารามิเตอร์เส้นทาง
model
string
ต้องระบุ ชื่อของ Model
ที่จะใช้ในการสร้างการดำเนินการให้เสร็จสมบูรณ์
รูปแบบ: name=models/{model}
โดยใช้รูปแบบ models/{model}
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
contents[]
object (Content
)
ต้องระบุ เนื้อหาของการสนทนาปัจจุบันกับโมเดล
สำหรับการค้นหาแบบเลี้ยวเดียว อินสแตนซ์นี้เป็นอินสแตนซ์เดียว สำหรับการค้นหาแบบหลายเลี้ยว ช่องนี้เป็นฟิลด์ที่ซ้ำได้ซึ่งมีประวัติการสนทนาและคำขอล่าสุด
tools[]
object (Tool
)
ไม่บังคับ รายการของ Tools
ที่โมเดลอาจใช้เพื่อสร้างคำตอบถัดไป
Tool
คือโค้ดที่ช่วยให้ระบบโต้ตอบกับระบบภายนอกเพื่อดำเนินการหรือชุดการดำเนินการที่อยู่นอกเหนือความรู้และขอบเขตของโมเดลได้ ปัจจุบันเครื่องมือที่รองรับมีเพียงFunction
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
systemInstruction
object (Content
)
ไม่บังคับ คำสั่งของระบบชุดนักพัฒนาแอป ขณะนี้มีเพียงข้อความเท่านั้น
generationConfig
object (GenerationConfig
)
ไม่บังคับ ตัวเลือกการกำหนดค่าสำหรับการสร้างและเอาต์พุตโมเดล
cachedContent
string
ไม่บังคับ ชื่อของเนื้อหาที่แคชซึ่งใช้เป็นบริบทในการแสดงการคาดการณ์ หมายเหตุ: ใช้การแคชอย่างชัดแจ้งเท่านั้น ซึ่งผู้ใช้สามารถควบคุมการแคชได้ (เช่น เนื้อหาที่จะแคช) และประหยัดต้นทุนอย่างแน่นอน รูปแบบ: cachedContents/{cachedContent}
ตัวอย่างคำขอ
ข้อความ
Python
Node.js
Kotlin
Swift
Dart
Java
รูปภาพ
Python
Node.js
Kotlin
Swift
Dart
Java
วิดีโอ
Python
Node.js
Kotlin
Java
แชท
Python
Node.js
เปลือกหอย
Kotlin
Swift
Dart
Java
เนื้อหาการตอบกลับ
หากสำเร็จ เนื้อหาการตอบกลับจะมีสตรีมของอินสแตนซ์ GenerateContentResponse
รายการ
GenerateContentResponse
คำตอบจากโมเดลที่รองรับผู้สมัครหลายราย
หมายเหตุเกี่ยวกับการให้คะแนนความปลอดภัยและการกรองเนื้อหา มีการรายงานสําหรับทั้งข้อความแจ้งในGenerateContentResponse.prompt_feedback
และสําหรับผู้สมัครแต่ละคนในfinishReason
และsafetyRatings
สัญญา API ระบุไว้ว่า: - จะส่งคืนผู้สมัครที่ขอทั้งหมดหรือไม่มีผู้สมัครเลย - จะไม่มีการส่งกลับผู้สมัครเฉพาะในกรณีที่มีข้อผิดพลาดกับข้อความแจ้ง (ดู promptFeedback
) ระบบจะรายงานความคิดเห็นเกี่ยวกับผู้สมัครแต่ละคนในวันที่ finishReason
และ safetyRatings
การแสดง JSON |
---|
{ "candidates": [ { object ( |
candidates[]
object (Candidate
)
คำตอบสำหรับผู้สมัครจากโมเดล
promptFeedback
object (PromptFeedback
)
แสดงผลความคิดเห็นของข้อความแจ้งที่เกี่ยวข้องกับตัวกรองเนื้อหา
usageMetadata
object (UsageMetadata
)
เอาต์พุตเท่านั้น ข้อมูลเมตาในคำขอการสร้าง การใช้โทเค็น
PromptFeedback
ชุดข้อมูลเมตาของความคิดเห็นเกี่ยวกับข้อความแจ้งที่ระบุไว้ใน GenerateContentRequest.content
การแสดง JSON |
---|
{ "blockReason": enum ( |
blockReason
enum (BlockReason
)
ไม่บังคับ หากตั้งค่าไว้ ระบบจะบล็อกข้อความแจ้งและไม่แสดงผลคำแนะนำ ปรับเปลี่ยนพรอมต์
safetyRatings[]
object (SafetyRating
)
คะแนนเพื่อความปลอดภัยของข้อความแจ้ง แต่ละหมวดหมู่มีการจัดประเภทได้ไม่เกิน 1 ประเภท
BlockReason
ระบุเหตุผลที่บล็อกพรอมต์
Enum | |
---|---|
BLOCK_REASON_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
SAFETY |
ข้อความแจ้งถูกบล็อกเนื่องจากเหตุผลด้านความปลอดภัย คุณสามารถตรวจสอบ safetyRatings เพื่อดูว่าหมวดหมู่ความปลอดภัยใดบล็อกหมวดหมู่นั้น |
OTHER |
ข้อความแจ้งถูกบล็อกโดยไม่ทราบสาเหตุ |
UsageMetadata
ข้อมูลเมตาเกี่ยวกับการใช้โทเค็นของคำขอการสร้าง
การแสดง JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
promptTokenCount
integer
จำนวนโทเค็นในข้อความแจ้ง เมื่อตั้งค่าที่แคชไว้เนื้อหา นี่จะยังเป็นขนาดพรอมต์ที่มีประสิทธิภาพโดยรวม เช่น ซึ่งรวมถึงจำนวนโทเค็นในเนื้อหาที่แคชไว้
cachedContentTokenCount
integer
จำนวนโทเค็นในส่วนที่แคชไว้ของข้อความแจ้ง กล่าวคือ ในเนื้อหาที่แคชไว้
candidatesTokenCount
integer
จํานวนโทเค็นทั้งหมดจากตัวเลือกที่สร้างขึ้น
totalTokenCount
integer
จำนวนโทเค็นทั้งหมดสำหรับคำขอสร้าง (ข้อความแจ้ง + ผู้สมัคร)
ผู้สมัคร
- การแสดง JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
ตัวเลือกการตอบกลับที่สร้างขึ้นจากโมเดล
การแสดง JSON |
---|
{ "content": { object ( |
content
object (Content
)
เอาต์พุตเท่านั้น เนื้อหาที่สร้างขึ้นซึ่งแสดงผลจากโมเดล
finishReason
enum (FinishReason
)
ไม่บังคับ เอาต์พุตเท่านั้น เหตุผลที่โมเดลหยุดสร้างโทเค็น
หากเว้นว่างไว้ โมเดลจะยังไม่หยุดสร้างโทเค็น
safetyRatings[]
object (SafetyRating
)
รายการการให้คะแนนความปลอดภัยของตัวเลือกคำตอบ
แต่ละหมวดหมู่มีการจัดประเภทได้ไม่เกิน 1 ประเภท
citationMetadata
object (CitationMetadata
)
เอาต์พุตเท่านั้น ข้อมูลการอ้างอิงของผู้สมัครที่โมเดลสร้างขึ้น
ช่องนี้อาจมีข้อมูลการบรรยายสำหรับข้อความที่อยู่ใน content
ข้อความเหล่านี้คือข้อความที่ "มีคนสะเทือนใจ" จากเนื้อหาที่มีลิขสิทธิ์ในข้อมูลการฝึกของ LLM พื้นฐาน
tokenCount
integer
เอาต์พุตเท่านั้น จำนวนโทเค็นสำหรับผู้สมัครนี้
groundingAttributions[]
object (GroundingAttribution
)
เอาต์พุตเท่านั้น ข้อมูลการระบุแหล่งที่มาสําหรับแหล่งที่มาที่ส่งผลต่อคำตอบที่ให้เหตุผล
ช่องนี้ระบุค่าไว้สำหรับการโทร GenerateAnswer
ครั้ง
index
integer
เอาต์พุตเท่านั้น ดัชนีของผู้สมัครในรายชื่อผู้สมัคร
FinishReason
กำหนดเหตุผลที่โมเดลหยุดสร้างโทเค็น
Enum | |
---|---|
FINISH_REASON_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
STOP |
จุดหยุดปกติของโมเดลหรือลำดับหยุดที่ระบุ |
MAX_TOKENS |
คำขอมีจำนวนโทเค็นถึงขีดจำกัดสูงสุดแล้ว |
SAFETY |
ระบบแจ้งว่าเนื้อหาของผู้สมัครไม่เหมาะสมเนื่องจากเหตุผลด้านความปลอดภัย |
RECITATION |
เนื้อหาของผู้สมัครถูกแจ้งว่าไม่เหมาะสมเนื่องจากเหตุผลในการบรรยาย |
LANGUAGE |
ระบบแจ้งว่าเนื้อหาผู้สมัครไม่เหมาะสมเนื่องจากใช้ภาษาที่ไม่รองรับ |
OTHER |
ไม่ทราบสาเหตุ |
GroundingAttribution
การระบุแหล่งที่มาของแหล่งที่มาที่ส่งผลต่อคำตอบ
การแสดง JSON |
---|
{ "sourceId": { object ( |
sourceId
object (AttributionSourceId
)
เอาต์พุตเท่านั้น ตัวระบุของแหล่งที่มาที่มีส่วนร่วมกับการระบุแหล่งที่มานี้
content
object (Content
)
การระบุแหล่งที่มาของเนื้อหาแหล่งที่มาของการระบุแหล่งที่มานี้
AttributionSourceId
ตัวระบุของแหล่งที่มาที่มีส่วนร่วมกับการระบุแหล่งที่มานี้
การแสดง JSON |
---|
{ // Union field |
ช่องการรวม source
source
ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
groundingPassage
object (GroundingPassageId
)
ตัวระบุข้อความในบรรทัด
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
ตัวระบุของ Chunk
ที่ดึงข้อมูลผ่าน Semantic Retriever
GroundingPassageId
ตัวระบุของส่วนหนึ่งภายใน GroundingPassage
การแสดง JSON |
---|
{ "passageId": string, "partIndex": integer } |
passageId
string
เอาต์พุตเท่านั้น รหัสข้อความที่ตรงกับ GroundingPassage.id
ของ GenerateAnswerRequest
partIndex
integer
เอาต์พุตเท่านั้น ดัชนีของส่วนย่อยภายใน GroundingPassage.content
ของ GenerateAnswerRequest
SemanticRetrieverChunk
ตัวระบุของ Chunk
ที่ดึงผ่าน Semantic Retriever ที่ระบุไว้ใน GenerateAnswerRequest
โดยใช้ SemanticRetrieverConfig
การแสดง JSON |
---|
{ "source": string, "chunk": string } |
source
string
เอาต์พุตเท่านั้น ชื่อแหล่งที่มาตรงกับ SemanticRetrieverConfig.source
ของคำขอ ตัวอย่าง: corpora/123
หรือ corpora/123/documents/abc
chunk
string
เอาต์พุตเท่านั้น ชื่อของ Chunk
ที่มีข้อความที่มีการระบุแหล่งที่มา ตัวอย่าง: corpora/123/documents/abc/chunks/xyz
CitationMetadata
คอลเล็กชันการระบุแหล่งที่มาของเนื้อหาชิ้นหนึ่ง
การแสดง JSON |
---|
{
"citationSources": [
{
object ( |
citationSources[]
object (CitationSource
)
การอ้างอิงแหล่งที่มาสำหรับคำตอบที่เฉพาะเจาะจง
CitationSource
การอ้างอิงแหล่งที่มาสำหรับส่วนหนึ่งของคำตอบที่เฉพาะเจาะจง
การแสดง JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
startIndex
integer
ไม่บังคับ จุดเริ่มต้นของกลุ่มคำตอบที่มีการระบุแหล่งที่มาเป็นแหล่งที่มานี้
ดัชนีระบุจุดเริ่มต้นของกลุ่มซึ่งวัดในหน่วยไบต์
endIndex
integer
ไม่บังคับ สิ้นสุดกลุ่มที่มีการระบุแหล่งที่มา ไม่รวม
uri
string
ไม่บังคับ URI ที่มีการระบุแหล่งที่มาเป็นแหล่งที่มาของข้อความบางส่วน
license
string
ไม่บังคับ ใบอนุญาตสำหรับโปรเจ็กต์ GitHub ที่มีการระบุแหล่งที่มาเป็นแหล่งที่มาของกลุ่ม
ต้องระบุข้อมูลใบอนุญาตสำหรับการอ้างอิงโค้ด
GenerationConfig
ตัวเลือกการกำหนดค่าสำหรับการสร้างและเอาต์พุตโมเดล พารามิเตอร์บางรายการอาจกำหนดค่าไม่ได้สำหรับทุกโมเดล
การแสดง JSON |
---|
{
"stopSequences": [
string
],
"responseMimeType": string,
"responseSchema": {
object ( |
stopSequences[]
string
ไม่บังคับ ชุดของลำดับอักขระ (สูงสุด 5 ตัว) ที่จะหยุดการสร้างเอาต์พุต หากระบุไว้ API จะหยุดเมื่อปรากฏครั้งแรกของลำดับการหยุด ลำดับการหยุดจะไม่รวมอยู่ในคำตอบ
responseMimeType
string
ไม่บังคับ mimetype การตอบสนองเอาต์พุตของข้อความตัวเลือกที่สร้างขึ้น mimetype ที่รองรับ: text/plain
: (ค่าเริ่มต้น) เอาต์พุตข้อความ application/json
: การตอบสนองของ JSON ในตัวเลือก
responseSchema
object (Schema
)
ไม่บังคับ สคีมาการตอบสนองเอาต์พุตของข้อความตัวเลือกที่สร้างขึ้นเมื่อประเภท MIME การตอบกลับมีสคีมาได้ สคีมาอาจเป็นออบเจ็กต์ ค่าดั้งเดิม หรืออาร์เรย์ และเป็นส่วนหนึ่งของสคีมา OpenAPI
เมื่อตั้งค่าแล้ว จะต้องตั้งค่า responseMimeType ที่ใช้ร่วมกันได้ด้วย mimetype ที่ใช้ร่วมกันได้: application/json
: สคีมาสำหรับการตอบสนอง JSON
candidateCount
integer
ไม่บังคับ จำนวนคำตอบที่สร้างขึ้นที่จะแสดงผล
ปัจจุบันค่านี้สามารถตั้งเป็น 1 เท่านั้น หากไม่ได้ตั้งค่า ระบบจะใช้ค่าเริ่มต้นเป็น 1
maxOutputTokens
integer
ไม่บังคับ จำนวนโทเค็นสูงสุดที่จะรวมไว้ในผู้สมัคร
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตามโมเดล โปรดดูแอตทริบิวต์ Model.output_token_limit
ของ Model
ที่แสดงผลจากฟังก์ชัน getModel
temperature
number
ไม่บังคับ ควบคุมการสุ่มของเอาต์พุต
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตามโมเดล โปรดดูแอตทริบิวต์ Model.temperature
ของ Model
ที่แสดงผลจากฟังก์ชัน getModel
ค่าที่ใช้ได้อยู่ในช่วง [0.0, 2.0]
topP
number
ไม่บังคับ ความน่าจะเป็นสะสมสูงสุดของโทเค็นที่ต้องพิจารณาเมื่อสุ่มตัวอย่าง
โมเดลนี้ใช้การสุ่มตัวอย่างแบบ Top-k และนิวเคลียสแบบรวม
ระบบจะจัดเรียงโทเค็นตามความน่าจะเป็นที่กําหนดไว้เพื่อให้พิจารณาเฉพาะโทเค็นที่มีแนวโน้มมากที่สุดเท่านั้น การสุ่มตัวอย่างแบบ Top-k จะจำกัดจํานวนโทเค็นสูงสุดที่จะต้องพิจารณาโดยตรง ขณะที่การสุ่มตัวอย่างนิวเคลียสจะจํากัดจํานวนโทเค็นตามความน่าจะเป็นสะสม
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตามโมเดล โปรดดูแอตทริบิวต์ Model.top_p
ของ Model
ที่แสดงผลจากฟังก์ชัน getModel
topK
integer
ไม่บังคับ จำนวนโทเค็นสูงสุดที่จะพิจารณาเมื่อสุ่มตัวอย่าง
โมเดลใช้การสุ่มตัวอย่างแบบนิวเคลียสหรือการสุ่มตัวอย่างแบบ Top-k และนิวเคลียสแบบรวม การสุ่มตัวอย่างแบบ Top-k จะพิจารณาชุดโทเค็นที่เป็นไปได้มากที่สุด topK
รายการ โมเดลที่ทำงานโดยใช้การสุ่มตัวอย่างนิวเคลียสไม่อนุญาตให้ใช้การตั้งค่า TopK
หมายเหตุ: ค่าเริ่มต้นจะแตกต่างกันไปตามโมเดล โปรดดูแอตทริบิวต์ Model.top_k
ของ Model
ที่แสดงผลจากฟังก์ชัน getModel
ฟิลด์ topK
ที่ไม่มีข้อมูลใน Model
บ่งบอกว่าโมเดลไม่ได้ใช้การสุ่มตัวอย่างสูงสุดและไม่อนุญาตให้ตั้งค่า topK
ในคำขอ
HarmCategory
หมวดหมู่ของการจัดประเภท
หมวดหมู่เหล่านี้ครอบคลุมอันตรายหลากหลายประเภทที่นักพัฒนาแอปอาจต้องการปรับ
Enum | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
ไม่ได้ระบุหมวดหมู่ |
HARM_CATEGORY_DEROGATORY |
ความคิดเห็นเชิงลบหรือเป็นอันตรายที่มีเป้าหมายเป็นอัตลักษณ์และ/หรือคุณลักษณะที่ได้รับการคุ้มครอง |
HARM_CATEGORY_TOXICITY |
เนื้อหาที่หยาบคาย ไม่เคารพ หรือหยาบคาย |
HARM_CATEGORY_VIOLENCE |
อธิบายสถานการณ์ที่แสดงภาพความรุนแรงต่อบุคคลหรือกลุ่มบุคคล หรือคำอธิบายทั่วไปเกี่ยวกับคราบเลือด |
HARM_CATEGORY_SEXUAL |
มีการอ้างอิงถึงกิจกรรมทางเพศหรือเนื้อหาลามกอื่นๆ |
HARM_CATEGORY_MEDICAL |
โปรโมตคำแนะนำทางการแพทย์ที่ไม่ได้ตรวจสอบ |
HARM_CATEGORY_DANGEROUS |
เนื้อหาอันตรายที่ส่งเสริม สนับสนุน หรือก่อให้เกิดการกระทําที่เป็นอันตราย |
HARM_CATEGORY_HARASSMENT |
เนื้อหาที่เป็นการก่อกวน |
HARM_CATEGORY_HATE_SPEECH |
วาจาสร้างความเกลียดชังและเนื้อหา |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
เนื้อหาเกี่ยวกับเรื่องเพศอย่างโจ่งแจ้ง |
HARM_CATEGORY_DANGEROUS_CONTENT |
เนื้อหาที่เป็นอันตราย |
SafetyRating
คะแนนความปลอดภัยของเนื้อหา
คะแนนความปลอดภัยประกอบด้วยหมวดหมู่อันตรายและระดับความน่าจะเป็นของอันตรายในหมวดหมู่นั้นสำหรับเนื้อหานั้นๆ เนื้อหาได้รับการจัดประเภทเพื่อความปลอดภัยในหลากหลายหมวดหมู่อันตราย และรวมความน่าจะเป็นของการจัดประเภทอันตรายไว้ที่นี่
การแสดง JSON |
---|
{ "category": enum ( |
category
enum (HarmCategory
)
ต้องระบุ หมวดหมู่ของคะแนนนี้
probability
enum (HarmProbability
)
ต้องระบุ ความน่าจะเป็นที่ก่อให้เกิดอันตรายสำหรับเนื้อหานี้
blocked
boolean
เนื้อหานี้ถูกบล็อกเนื่องจากการจัดประเภทนี้ใช่ไหม
HarmProbability
ความเป็นไปได้ที่เนื้อหาหนึ่งๆ จะเป็นอันตราย
ระบบการแยกประเภทจะให้ความน่าจะเป็นที่เนื้อหาจะไม่ปลอดภัย ซึ่งไม่ได้บ่งชี้ถึงความรุนแรงของอันตรายต่อเนื้อหาส่วนหนึ่งๆ
Enum | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
ไม่ได้ระบุความน่าจะเป็น |
NEGLIGIBLE |
เนื้อหามีโอกาสไม่ปลอดภัยน้อยมาก |
LOW |
เนื้อหามีโอกาสต่ำที่จะไม่ปลอดภัย |
MEDIUM |
เนื้อหามีโอกาสไม่ปลอดภัยปานกลาง |
HIGH |
เนื้อหามีโอกาสสูงที่จะไม่ปลอดภัย |
SafetySetting
การตั้งค่าความปลอดภัย ซึ่งส่งผลต่อลักษณะการทำงานของการบล็อกเพื่อความปลอดภัย
การผ่านการตั้งค่าความปลอดภัยสำหรับหมวดหมู่หนึ่งๆ จะเปลี่ยนแปลงความน่าจะเป็นที่อนุญาตที่เนื้อหาถูกบล็อก
การแสดง JSON |
---|
{ "category": enum ( |
category
enum (HarmCategory
)
ต้องระบุ หมวดหมู่ของการตั้งค่านี้
threshold
enum (HarmBlockThreshold
)
ต้องระบุ ควบคุมเกณฑ์ความน่าจะเป็นที่บล็อกอันตราย
HarmBlockThreshold
บล็อกเมื่อถึงและเกินความน่าจะเป็นอันตรายที่ระบุ
Enum | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
ไม่ได้ระบุเกณฑ์ |
BLOCK_LOW_AND_ABOVE |
เนื้อหาจะได้รับอนุญาตสำหรับเนื้อหาที่มี "เชิงลบ" |
BLOCK_MEDIUM_AND_ABOVE |
โดยจะอนุญาตให้แสดงเนื้อหาที่มี "ไม่มี" และ "ต่ำ" |
BLOCK_ONLY_HIGH |
เนื้อหาจะได้รับอนุญาตในเนื้อหาที่มีนัยสำคัญ "ต่ำ" และ "ปานกลาง" |
BLOCK_NONE |
อนุญาตเนื้อหาทั้งหมด |