Vertex AI สำหรับ Firebase Web SDK
ฟังก์ชัน
ฟังก์ชัน | คำอธิบาย |
---|---|
ฟังก์ชัน(แอป, ...) | |
getVertexAI(แอป, ตัวเลือก) | แสดงผลอินสแตนซ์ VertexAI สำหรับแอปที่ระบุ |
function(vertexAI, ...) | |
getGenerativeModel(vertexAI, modelParams, requestOptions) | แสดงผลคลาส GenerativeModel พร้อมเมธอดสำหรับการอนุมานและฟังก์ชันการทำงานอื่นๆ |
คลาส
ชั้น | คำอธิบาย |
---|---|
ChatSession | ชั้นเรียน ChatSession ที่เปิดใช้การส่งข้อความแชทและจัดเก็บประวัติของข้อความที่ส่งและได้รับจนถึงปัจจุบัน |
โมเดล Generative | คลาสสำหรับ Generative Model API |
การแจกแจง
การระบุ | คำอธิบาย |
---|---|
เหตุผลของการบล็อก | สาเหตุที่ข้อความแจ้งถูกบล็อก |
สาเหตุในสิ้นสุด | เหตุผลที่ผู้สมัครสิ้นสุดลง |
โหมดการโทรของฟังก์ชัน | |
FunctiondeclarationSchemaType | มีรายการประเภทข้อมูล OpenAPI ตามที่กำหนดโดย https://swbble.io/docs/specification/data-models/data-types/ |
วิธีการป้องกันอันตราย | |
HarmBlockThreshold | เกณฑ์ข้างต้นที่ระบบจะบล็อกพรอมต์หรือผู้สมัคร |
หมวดหมู่ที่อันตราย | หมวดหมู่ที่เป็นอันตรายซึ่งอาจทำให้พรอมต์หรือผู้สมัครถูกบล็อก |
ความน่าจะเป็นของอันตราย | ความน่าจะเป็นที่พรอมต์หรือผู้สมัครตรงกับหมวดหมู่อันตราย |
ความรุนแรง | ระดับความรุนแรงที่เป็นอันตราย |
อินเทอร์เฟซ
อินเทอร์เฟซ | คำอธิบาย |
---|---|
BaseParams | พารามิเตอร์ฐานของเมธอดต่างๆ |
การอ้างอิง | การอ้างอิงรายการเดียว |
CitationMetadata | ข้อมูลเมตาการอ้างอิงที่อาจพบใน GenerateContentCandidate |
Content | ประเภทเนื้อหาสำหรับทั้งพรอมต์และคำเสนอคำตอบ |
คำขอนับโทเค็น | พารามิเตอร์สำหรับการเรียกใช้ GenerativeModel.countTokens() |
CountTokensResponse | คำตอบจากการเรียกใช้ GenerativeModel.countTokens() |
วันที่ 2 | โปรโตคอล google.type.Date |
EnhancedGenerateContentResponse | ออบเจ็กต์การตอบกลับที่รวมไว้ในเมธอดตัวช่วย |
ข้อมูลไฟล์ | ข้อมูลที่ชี้ไปยังไฟล์ที่อัปโหลดบน Google Cloud Storage |
FileDataPart | อินเทอร์เฟซส่วนเนื้อหาหากส่วนดังกล่าวแสดงถึง FileData |
FunctionCall | FunctionCall ที่คาดการณ์ไว้จากโมเดลที่มีสตริงที่แสดงถึง Functiondeclaration.name และออบเจ็กต์ JSON ที่มีโครงสร้างซึ่งมีพารามิเตอร์และค่าของพารามิเตอร์ |
FunctionCallingConfig | |
ส่วนการโทรของฟังก์ชัน | อินเทอร์เฟซส่วนเนื้อหาหากส่วนดังกล่าวแสดง FunctionCall |
การประกาศฟังก์ชัน | การนำเสนอแบบมีโครงสร้างของการประกาศฟังก์ชันตามที่กำหนดโดยข้อกำหนด OpenAPI 3.0 ในการประกาศนี้จะเป็นชื่อฟังก์ชันและพารามิเตอร์ FunctionDeclaration นี้เป็นการนำเสนอบล็อกโค้ดที่โมเดลใช้เป็นเครื่องมือและไคลเอ็นต์จะเรียกใช้ได้ |
FunctiondeclarationSchema | สคีมาของพารามิเตอร์ที่ส่งไปยัง Functiondeclaration.parameters |
FunctiondeclarationSchemaProperty | สคีมาใช้เพื่อกำหนดรูปแบบของข้อมูลอินพุต/เอาต์พุต แสดงชุดย่อยของออบเจ็กต์สคีมา OpenAPI 3.0 ที่เลือก และอาจเพิ่มช่องอื่นๆ อีกในอนาคตหากต้องการ |
เครื่องมือการประกาศฟังก์ชัน | FunctionDeclarationsTool เป็นโค้ดที่ช่วยให้ระบบโต้ตอบกับระบบภายนอกให้ดำเนินการหรือชุดการกระทำที่นอกเหนือจากความรู้และขอบเขตของโมเดลได้ |
FunctionResponse | ผลลัพธ์ที่ได้จาก FunctionCall ที่มีสตริงที่แสดงถึง FunctionReceivelaration.name และออบเจ็กต์ JSON แบบมีโครงสร้างที่มีเอาต์พุตจากฟังก์ชันดังกล่าวจะถูกใช้เป็นบริบทสำหรับโมเดล ซึ่งควรมีผลลัพธ์ของ FunctionCall ที่สร้างขึ้นโดยการคาดการณ์โมเดล |
ส่วนฟังก์ชันการตอบกลับ | อินเทอร์เฟซส่วนเนื้อหาถ้าส่วนนั้นแสดง FunctionResponse |
GenerateContentCandidate | ผู้สมัครกลับมาโดยเป็นส่วนหนึ่งของ GenerateContentResponse |
GenerateContentRequest | ส่งคำขอผ่าน GenerativeModel.generateContent() |
GenerateContentResponse | การตอบกลับแต่ละรายการจาก GenerativeModel.generateContent() และ GenerativeModel.generateContentStream() generateContentStream() จะแสดงผล 1 รายการต่อกลุ่มจนกว่าสตรีมจะเสร็จสิ้น |
GenerateContent Results | ออบเจ็กต์ผลลัพธ์ที่ได้จากการเรียกใช้ GenerativeModel.generateContent() |
GenerateContentStream Results | ออบเจ็กต์ผลลัพธ์ที่ได้จากการเรียกใช้ GenerativeModel.generateContentStream() ทำซ้ำเกิน stream เพื่อรับเนื้อหาส่วนที่เข้ามาใหม่ และ/หรือใช้คำสัญญา response เพื่อรับคำตอบแบบรวมเมื่อสตรีมจบแล้ว |
GenerationConfig | ตัวเลือกการกำหนดค่าสำหรับคำขอที่เกี่ยวข้องกับเนื้อหา |
GenerativeContentBlob | อินเทอร์เฟซสำหรับการส่งรูปภาพ |
การระบุแหล่งที่มาของข้อมูล | |
GroundingMetadata | ส่งข้อมูลเมตากลับไปยังไคลเอ็นต์เมื่อเปิดใช้งานการต่อสาย |
อินไลน์ข้อมูลพาร์ท | อินเทอร์เฟซส่วนเนื้อหาหากส่วนดังกล่าวแสดงรูปภาพ |
ModelParams | พารามิเตอร์ที่ส่งไปยัง getGenerativeModel() |
PromptFeedback | หากพรอมต์ถูกบล็อก ระบบจะแสดง blockReason และ safetyRatings ที่เกี่ยวข้อง |
ตัวเลือกคำขอ | พารามิเตอร์ที่ส่งไปยัง getGenerativeModel() |
การระบุแหล่งที่มาที่ดึงข้อมูล | |
ระดับความปลอดภัย | การจัดประเภทความปลอดภัยที่เชื่อมโยงกับ GenerateContentCandidate |
การตั้งค่าความปลอดภัย | การตั้งค่าความปลอดภัยที่ส่งเป็นส่วนหนึ่งของพารามิเตอร์คำขอได้ |
Segment | |
StartChatParams | พารามิเตอร์สำหรับ GenerativeModel.startChat() |
ส่วนข้อความ | อินเทอร์เฟซส่วนเนื้อหาหากส่วนดังกล่าวแสดงสตริงข้อความ |
การกำหนดค่าเครื่องมือ | การกำหนดค่าเครื่องมือ ระบบจะแชร์การกำหนดค่านี้สำหรับเครื่องมือทั้งหมดที่ให้ไว้ในคำขอ |
UseMetadata | ข้อมูลเมตาการใช้งานเกี่ยวกับ GenerateContentResponse |
VertexAI | อินสแตนซ์ของ Vertex AI สำหรับ Firebase SDK |
ตัวเลือก VertexAI | ตัวเลือกเมื่อเริ่มต้น Vertex AI สำหรับ Firebase SDK |
ข้อมูลเมตาวิดีโอ | อธิบายเนื้อหาวิดีโออินพุต |
การระบุแหล่งที่มาของเว็บ |
ตัวแปร
ตัวแปร | คำอธิบาย |
---|---|
บทบาทที่เป็นไปได้ | บทบาทที่เป็นไปได้ |
ประเภทชื่อแทน
ประเภทชื่อแทน | คำอธิบาย |
---|---|
ส่วน | ส่วนของเนื้อหา - ประกอบด้วยประเภทส่วนข้อความ รูปภาพ/วิดีโอ หรือการเรียกใช้/การตอบกลับ |
Role | บทบาทเป็นผู้ผลิตเนื้อหา |
เครื่องมือ | กำหนดเครื่องมือที่โมเดลสามารถเรียกใช้เพื่อเข้าถึงความรู้ภายนอก |
ฟังก์ชัน(แอป, ...)
getVertexAI(แอป ตัวเลือก)
แสดงผลอินสแตนซ์ VertexAI สำหรับแอปที่ระบุ
ลายเซ็น:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
แอป | แอป Firebase | FirebaseApp ที่จะใช้ |
ตัวเลือก | ตัวเลือก VertexAI |
การคืนสินค้า:
ฟังก์ชัน(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)
แสดงผลคลาส GenerativeModel พร้อมเมธอดสำหรับการอนุมานและฟังก์ชันการทำงานอื่นๆ
ลายเซ็น:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
VertexAI | VertexAI | |
ModelParams | ModelParams | |
ตัวเลือกคำขอ | ตัวเลือกคำขอ |
การคืนสินค้า:
บทบาทที่เป็นไปได้
บทบาทที่เป็นไปได้
ลายเซ็น:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
ส่วน
ส่วนของเนื้อหา - ประกอบด้วยประเภทส่วนข้อความ รูปภาพ/วิดีโอ หรือการเรียกใช้/การตอบกลับ
ลายเซ็น:
export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
บทบาท
บทบาทเป็นผู้ผลิตเนื้อหา
ลายเซ็น:
export declare type Role = (typeof POSSIBLE_ROLES)[number];
เครื่องมือ
กำหนดเครื่องมือที่โมเดลสามารถเรียกใช้เพื่อเข้าถึงความรู้ภายนอก
ลายเซ็น:
export declare type Tool = FunctionDeclarationsTool;
เหตุผลในการบล็อก
สาเหตุที่ข้อความแจ้งถูกบล็อก
ลายเซ็น:
export declare enum BlockReason
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
BLOCKED_REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
อื่นๆ | "OTHER" |
|
ความปลอดภัย | "SAFETY" |
เหตุผลของสิ้นสุด
เหตุผลที่ผู้สมัครสิ้นสุดลง
ลายเซ็น:
export declare enum FinishReason
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
ไม่ได้ระบุเหตุผล FINISH_REASON_ | "FINISH_REASON_UNSPECIFIED" |
|
MAX_โทเค็น | "MAX_TOKENS" |
|
อื่นๆ | "OTHER" |
|
การท่องจำ | "RECITATION" |
|
ความปลอดภัย | "SAFETY" |
|
หยุด | "STOP" |
โหมดการโทรของฟังก์ชัน
ลายเซ็น:
export declare enum FunctionCallingMode
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
ทั้งหมด | "ANY" |
|
อัตโนมัติ | "AUTO" |
|
ไม่ระบุโหมด | "MODE_UNSPECIFIED" |
|
ไม่มี | "NONE" |
ประเภทสคีมาการประกาศฟังก์ชัน
มีรายการประเภทข้อมูล OpenAPI ตามที่กำหนดโดย https://swbble.io/docs/specification/data-models/data-types/
ลายเซ็น:
export declare enum FunctionDeclarationSchemaType
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
อาร์เรย์ | "ARRAY" |
ประเภทอาร์เรย์ |
BOOLEAN | "BOOLEAN" |
ประเภทบูลีน |
INTEGER | "INTEGER" |
ประเภทจำนวนเต็ม |
ตัวเลข | "NUMBER" |
ประเภทตัวเลข |
ออบเจ็กต์ | "OBJECT" |
ประเภทออบเจ็กต์ |
STRING | "STRING" |
ประเภทสตริง |
วิธีการบล็อกอันตราย
ลายเซ็น:
export declare enum HarmBlockMethod
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
HARM_BLOCK_Method_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
ความน่าจะเป็น | "PROBABILITY" |
|
ความรุนแรง | "SEVERITY" |
HarmBlockThreshold
เกณฑ์ข้างต้นที่ระบบจะบล็อกพรอมต์หรือผู้สมัคร
ลายเซ็น:
export declare enum HarmBlockThreshold
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
บล็อกที่อยู่ต่ำและด้านบน | "BLOCK_LOW_AND_ABOVE" |
|
บล็อกขนาดกลางและด้านบน | "BLOCK_MEDIUM_AND_ABOVE" |
|
บล็อกไม่มี | "BLOCK_NONE" |
|
บล็อกเท่านั้น | "BLOCK_ONLY_HIGH" |
|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
หมวดหมู่ที่เป็นอันตราย
หมวดหมู่ที่เป็นอันตรายซึ่งอาจทำให้พรอมต์หรือผู้สมัครถูกบล็อก
ลายเซ็น:
export declare enum HarmCategory
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
เนื้อหาที่เป็นอันตราย | "HARM_CATEGORY_DANGEROUS_CONTENT" |
|
HARM_CATEGORY_HARASSMENT | "HARM_CATEGORY_HARASSMENT" |
|
การสะกดประเภท HARM_HATE_SPEE | "HARM_CATEGORY_HATE_SPEECH" |
|
หมวดหมู่เนื้อหาทางเพศที่ชัดเจน | "HARM_CATEGORY_SEXUALLY_EXPLICIT" |
|
ไม่ได้ระบุหมวดหมู่ HARM_CATEGORY | "HARM_CATEGORY_UNSPECIFIED" |
ความน่าจะเป็นที่เป็นอันตราย
ความน่าจะเป็นที่พรอมต์หรือผู้สมัครตรงกับหมวดหมู่อันตราย
ลายเซ็น:
export declare enum HarmProbability
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
HARM_PROBABILITY_ไม่ระบุ | "HARM_PROBABILITY_UNSPECIFIED" |
|
สูง | "HIGH" |
|
ต่ำ | "LOW" |
|
ปานกลาง | "MEDIUM" |
|
ไม่เสมอกัน | "NEGLIGIBLE" |
ความรุนแรง
ระดับความรุนแรงที่เป็นอันตราย
ลายเซ็น:
export declare enum HarmSeverity
สมาชิกแบบแจกแจง
สมาชิก | ค่า | คำอธิบาย |
---|---|---|
ต่ำมาก | "HARM_SEVERITY_HIGH" |
|
ต่ำมาก | "HARM_SEVERITY_LOW" |
|
ระดับความร้อนปานกลาง | "HARM_SEVERITY_MEDIUM" |
|
ระดับความเสี่ยงต่ำ | "HARM_SEVERITY_NEGLIGIBLE" |
|
ไม่ได้ระบุค่าประสิทธิภาพ | "HARM_SEVERITY_UNSPECIFIED" |