vertexai-preview package

Vertex AI สำหรับ Firebase Web SDK

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
ฟังก์ชัน(แอป, ...)
getVertexAI(แอป ตัวเลือก)	แสดงผลอินสแตนซ์ VertexAI สำหรับแอปที่ระบุ
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	แสดงผลคลาส GenerativeModel พร้อมวิธีการอนุมานและฟังก์ชันอื่นๆ

คลาส

ชั้น	คำอธิบาย
ChatSession	ชั้นเรียน ChatSession ที่ทำให้สามารถส่งข้อความแชทและจัดเก็บประวัติของข้อความที่ส่งและได้รับจนถึงปัจจุบัน
GenerativeModel	คลาสสำหรับ Generative Model API
ข้อผิดพลาด VertexAI	คลาสข้อผิดพลาดของ SDK สำหรับ Vertex AI สำหรับ Firebase

การแจงนับ

การแจงนับ	คำอธิบาย
Blockสาเหตุ	เหตุผลที่บล็อกข้อความแจ้ง
FinishReason	เหตุผลที่ผู้สมัครเสร็จสิ้น
FunctionCallingMode
FunctiondeclarationSchemaType	มีรายการประเภทข้อมูล OpenAPI ตามที่กำหนดโดย https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockThreshold	เกณฑ์ข้างต้นที่ข้อความแจ้งหรือผู้สมัครจะถูกบล็อก
หมวดหมู่อันตราย	หมวดหมู่ที่เป็นอันตรายซึ่งอาจทำให้ข้อความแจ้งหรือตัวเลือกถูกบล็อก
ความน่าจะเป็นของอันตราย	ความน่าจะเป็นที่ข้อความแจ้งหรือผู้สมัครตรงกับหมวดหมู่อันตราย
ความรุนแรง	ระดับความรุนแรงที่เป็นอันตราย
VertexAIErrorCode	รหัสข้อผิดพลาดที่เป็นมาตรฐานซึ่ง VertexAIError อาจมีได้

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
BaseParams	พารามิเตอร์ฐานสำหรับวิธีการจำนวนหนึ่ง
การอ้างอิง	การอ้างอิงรายการเดียว
ข้อมูลเมตาการอ้างอิง	ข้อมูลเมตาการอ้างอิงที่อาจพบใน GenerateContentCandidate
Content	ประเภทเนื้อหาสำหรับทั้งพรอมต์และตัวเลือกคำตอบ
CountTokensRequest	พารามิเตอร์สำหรับการเรียกใช้ GenerativeModel.countTokens()
CountTokensResponse	การตอบกลับจากการเรียกใช้ GenerativeModel.countTokens()
CustomErrorData	ออบเจ็กต์รายละเอียดที่มีข้อมูลซึ่งเกิดจากการตอบสนอง HTTP ที่ไม่ถูกต้อง
วันที่ 2	โปรโตคอล google.type.Date
สร้างการตอบสนองของเนื้อหาที่ปรับปรุงแล้ว	ออบเจ็กต์การตอบกลับที่รวมด้วยเมธอด Help
ErrorDetails	ออบเจ็กต์รายละเอียดที่อาจรวมอยู่ในการตอบกลับข้อผิดพลาด
ข้อมูลไฟล์	ข้อมูลที่ชี้ไปยังไฟล์ที่อัปโหลดบน Google Cloud Storage
FileDataPart	อินเทอร์เฟซส่วนเนื้อหา หากส่วนนั้นแสดง FileData
FunctionCall	FunctionCall ที่คาดการณ์ ซึ่งแสดงผลจากโมเดลที่มีสตริงที่แสดงถึง Functiondeclaration.name และออบเจ็กต์ JSON ที่มีโครงสร้างซึ่งมีพารามิเตอร์และค่าของพารามิเตอร์
FunctionCallingConfig
FunctionCallPart	อินเทอร์เฟซส่วนเนื้อหา หากส่วนนั้นแสดง FunctionCall
การประกาศฟังก์ชัน	การนำเสนอที่มีโครงสร้างของการประกาศฟังก์ชันตามที่กำหนดโดยข้อกำหนดของ OpenAPI 3.0 ชื่อฟังก์ชันและพารามิเตอร์จะรวมอยู่ในการประกาศนี้ FunctionDeclaration นี้เป็นตัวแทนของบล็อกโค้ดที่ใช้เป็นเครื่องมือโดยโมเดลและไคลเอ็นต์จะเป็นผู้ดำเนินการ
FunctionDeclarationSchema	สคีมาของพารามิเตอร์ที่ส่งไปยัง Functiondeclaration.parameters
FunctiondeclarationSchemaProperty	ใช้สคีมาเพื่อกำหนดรูปแบบของข้อมูลอินพุต/เอาต์พุต แสดงชุดย่อยที่เลือกของออบเจ็กต์สคีมา OpenAPI 3.0 และอาจมีการเพิ่มช่องอื่นๆ ในอนาคตหากจำเป็น
FunctionDeclarationsTool	FunctionDeclarationsTool คือโค้ดที่ช่วยให้ระบบโต้ตอบกับระบบภายนอกเพื่อดำเนินการหรือชุดการดำเนินการที่อยู่นอกเหนือความรู้และขอบเขตของโมเดลได้
การตอบสนองของฟังก์ชัน	ระบบจะใช้ผลลัพธ์ที่ได้จาก FunctionCall ที่มีสตริงที่แสดงถึง Functiondeclaration.name และออบเจ็กต์ JSON ที่มีโครงสร้างที่มีเอาต์พุตจากฟังก์ชันจะใช้เป็นบริบทของโมเดล ซึ่งควรมีผลลัพธ์ของ FunctionCall ที่สร้างขึ้นตามการคาดการณ์โมเดล
FunctionResponsePart	อินเทอร์เฟซส่วนเนื้อหา หากส่วนนั้นแสดง FunctionResponse
GenerateContentCandidate	ระบบแสดงผลผู้สมัครซึ่งเป็นส่วนหนึ่งของ GenerateContentResponse
GenerateContentRequest	คำขอที่ส่งผ่าน GenerativeModel.generateContent()
GenerateContentResponse	คำตอบแต่ละรายการจาก GenerativeModel.generateContent() และ GenerativeModel.generateContentStream() และ generateContentStream() แสดงผลแบบ 1 รายการในแต่ละกลุ่มจนกว่าสตรีมจะเสร็จ
GenerateContentผลลัพธ์	ออบเจ็กต์ผลลัพธ์ที่แสดงผลจากการเรียก GenerativeModel.generateContent()
GenerateContentStreamผลลัพธ์	ออบเจ็กต์ผลลัพธ์ที่แสดงผลจากการเรียกใช้ GenerativeModel.generateContentStream() ทำซ้ำ stream ครั้งเพื่อให้ได้กลุ่มบางส่วนเมื่อมีเข้ามา และ/หรือใช้คำสัญญา response เพื่อรับการตอบกลับแบบรวมเมื่อสตรีมเสร็จสิ้น
GenerationConfig	ตัวเลือกการกําหนดค่าสําหรับคําขอที่เกี่ยวข้องกับเนื้อหา
GenerativeContentBlob	อินเทอร์เฟซสำหรับส่งรูปภาพ
การระบุแหล่งที่มาจากพื้นฐาน
ข้อมูลเมตาสำหรับความสูง	ข้อมูลเมตาที่แสดงผลไปยังไคลเอ็นต์เมื่อเปิดใช้การต่อสายดิน
inlineDataPart	อินเทอร์เฟซส่วนเนื้อหา หากส่วนนั้นแทนรูปภาพ
ModelParams	มีการส่งพารามิเตอร์ไปยัง getGenerativeModel()
พรอมต์ความคิดเห็น	หากข้อความแจ้งถูกบล็อก ระบบจะเติมข้อมูลด้วย blockReason และ safetyRatings ที่เกี่ยวข้อง
RequestOptions	มีการส่งพารามิเตอร์ไปยัง getGenerativeModel()
การระบุแหล่งที่มาบริบทที่เรียกดู
SafetyRating	คะแนนความปลอดภัยที่เชื่อมโยงกับ GenerateContentCandidate
การตั้งค่าความปลอดภัย	การตั้งค่าความปลอดภัยที่ส่งเป็นส่วนหนึ่งของพารามิเตอร์คำขอได้
Segment
เริ่มแชทพารามิเตอร์	พารามิเตอร์สำหรับ GenerativeModel.startChat()
TextPart	อินเทอร์เฟซของส่วนเนื้อหา หากส่วนนั้นแสดงสตริงข้อความ
ToolConfig	การกำหนดค่าเครื่องมือ โดยจะมีการแชร์การกำหนดค่านี้สำหรับเครื่องมือทั้งหมดที่ระบุไว้ในคำขอ
UsageMetadata	ข้อมูลเมตาการใช้งานเกี่ยวกับ 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

ฟังก์ชัน(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

แสดงผลคลาส GenerativeModel พร้อมวิธีการอนุมานและฟังก์ชันอื่นๆ

ลายเซ็น:

export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
VertexAI	VertexAI
แบบจำลองพารัม	ModelParams
ตัวเลือกคำขอ	RequestOptions

การคืนสินค้า:

GenerativeModel

บทบาทที่เป็นไปได้

บทบาทที่เป็นไปได้

ลายเซ็น:

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"

FinishREASON

เหตุผลที่ผู้สมัครเสร็จสิ้น

ลายเซ็น:

export declare enum FinishReason 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
จบเหตุผล_ไม่ตรง	"FINISH_REASON_UNSPECIFIED"
MAX_โทเค็น	"MAX_TOKENS"
อื่นๆ	"OTHER"
สันทนาการ	"RECITATION"
ความปลอดภัย	"SAFETY"
หยุด	"STOP"

โหมดการเรียกใช้ฟังก์ชัน

ลายเซ็น:

export declare enum FunctionCallingMode 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
ทั้งหมด	"ANY"
อัตโนมัติ	"AUTO"
ไม่ทราบโหมด	"MODE_UNSPECIFIED"
ไม่มี	"NONE"

FunctiondeclarationSchemaType

มีรายการประเภทข้อมูล OpenAPI ตามที่กำหนดโดย https://swagger.io/docs/specification/data-models/data-types/

ลายเซ็น:

export declare enum FunctionDeclarationSchemaType 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
ARRAY	"ARRAY"	ประเภทอาร์เรย์
BOOLEAN	"BOOLEAN"	ประเภทบูลีน
INTEGER	"INTEGER"	ประเภทจำนวนเต็ม
ตัวเลข	"NUMBER"	ประเภทหมายเลข
วัตถุ	"OBJECT"	ประเภทออบเจ็กต์
STRING	"STRING"	ประเภทสตริง

วิธีบล็อกอันตราย

ลายเซ็น:

export declare enum HarmBlockMethod 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
HARM_BLOCK_METHOD_UNSPECIFIED	"HARM_BLOCK_METHOD_UNSPECIFIED"
ความน่าจะเป็น	"PROBABILITY"
ความรุนแรง	"SEVERITY"

เกณฑ์การบล็อกอันตราย

เกณฑ์ข้างต้นที่ข้อความแจ้งหรือผู้สมัครจะถูกบล็อก

ลายเซ็น:

export declare enum HarmBlockThreshold 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
BLOCK_LOW_AND_ABOVE	"BLOCK_LOW_AND_ABOVE"
BLOCK_MEDIUM_และ_ABOVE	"BLOCK_MEDIUM_AND_ABOVE"
ไม่มีบล็อก	"BLOCK_NONE"
สูง BLOCK_ONLY_HIGH	"BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED	"HARM_BLOCK_THRESHOLD_UNSPECIFIED"

หมวดหมู่อันตราย

หมวดหมู่ที่เป็นอันตรายซึ่งอาจทำให้ข้อความแจ้งหรือตัวเลือกถูกบล็อก

ลายเซ็น:

export declare enum HarmCategory 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
HARM_CATEGORY_อันตราย	"HARM_CATEGORY_DANGEROUS_CONTENT"
HARM_CATEGORY_HARASSMENT	"HARM_CATEGORY_HARASSMENT"
HARM_CATEGORY_HATE_SPEECH	"HARM_CATEGORY_HATE_SPEECH"
HARM_CATEGORY_SEXUALLY_EXPLICIT	"HARM_CATEGORY_SEXUALLY_EXPLICIT"
HARM_CATEGORY_UNSPECIFIED	"HARM_CATEGORY_UNSPECIFIED"

ความน่าจะเป็นอันตราย

ความน่าจะเป็นที่ข้อความแจ้งหรือผู้สมัครตรงกับหมวดหมู่อันตราย

ลายเซ็น:

export declare enum HarmProbability 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
HARM_PROBABILITY_ไม่ระบุ	"HARM_PROBABILITY_UNSPECIFIED"
สูง	"HIGH"
ต่ำ	"LOW"
ปานกลาง	"MEDIUM"
ไม่กะทัดรัด	"NEGLIGIBLE"

อันตราย

ระดับความรุนแรงที่เป็นอันตราย

ลายเซ็น:

export declare enum HarmSeverity 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
HARM_SEVERITY_สูง	"HARM_SEVERITY_HIGH"
HARM_SEVERITY_LOW	"HARM_SEVERITY_LOW"
HARM_SEVERITY_ปานกลาง	"HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE	"HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_ไม่ระบุ	"HARM_SEVERITY_UNSPECIFIED"

VertexAIErrorCode

รหัสข้อผิดพลาดที่เป็นมาตรฐานซึ่ง VertexAIError อาจมีได้

ลายเซ็น:

export declare const enum VertexAIErrorCode 

สมาชิกการแจงนับ

สมาชิก	ค่า	คำอธิบาย
ข้อผิดพลาด	"error"	เกิดข้อผิดพลาดทั่วไป
ข้อผิดพลาด FETCH	"fetch-error"	เกิดข้อผิดพลาดขณะดึงข้อมูล
เนื้อหาไม่ถูกต้อง	"invalid-content"	ข้อผิดพลาดที่เชื่อมโยงกับออบเจ็กต์เนื้อหา
ไม่มี API_KEY	"no-api-key"	เกิดข้อผิดพลาดเนื่องจากไม่มีคีย์ Firebase API
ไม่มีแบบจำลอง	"no-model"	เกิดข้อผิดพลาดเนื่องจากไม่ได้ระบุชื่อโมเดลระหว่างการเริ่มต้น
ไม่มีรหัสโครงการ	"no-project-id"	เกิดข้อผิดพลาดเนื่องจากไม่มีรหัสโปรเจ็กต์
PARSE_ล้มเหลว	"parse-failed"	เกิดข้อผิดพลาดขณะแยกวิเคราะห์
คำขอ_ข้อผิดพลาด	"request-error"	เกิดข้อผิดพลาดในคำขอ
ข้อผิดพลาด RESPONSE	"response-error"	เกิดข้อผิดพลาดในการตอบกลับ