vertexai-preview package

حزمة تطوير البرامج (SDK) على الويب لمنصة Vertex AI For Firebase

الوظائف

الوظيفة	الوصف
الدالّة(app, ...)
getVertexAI(app, options)	عرض مثيل VertexAI للتطبيق المحدّد
الدالّة(vertexAI, ...)
getGenerativeModel(veexAI, modelParams, requestOptions)	تعرض فئة GenerativeModel مع طرق الاستنتاج وغيرها من الوظائف.

صفوف

الفئة	الوصف
جلسة Chat	فئة Chatsession التي تتيح إرسال رسائل المحادثة وتخزِّن سجلّ الرسائل المُرسَلة والمُستلمة حتى الآن
النموذج التوليدي	فئة واجهات برمجة التطبيقات للنموذج التوليدي.
VertexAIError	فئة الخطأ في حزمة تطوير البرامج (SDK) الخاصة بـ Vertex AI for Firebase

عمليات التعداد

التعداد	الوصف
Blockالسبب	سبب حظر الطلب
سبب الإنهاء	سبب انتهاء أحد المرشّحين.
FunctionCallingMode
FunctionDeclarationSchemaType	تحتوي على قائمة بأنواع بيانات OpenAPI على النحو المحدّد في https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockThreshold	الحدّ الذي سيتم حظر طلب أو مرشح عند تجاوزه.
فئة الضرر	فئات الضرر التي قد تؤدي إلى حظر الطلبات أو الاقتراحات
احتمالية الضرر	احتمالية تطابق الطلب أو المرشّح مع فئة ضرر
درجة الضرر	مستويات خطورة الضرر:
VertexAIErrorCode	رموز الخطأ الموحّدة التي يمكن أن يتضمّنها الخطأ VertexAIError.

واجهات

الواجهة	الوصف
المَعلمات الأساسية	المعلمات الأساسية لعدد من الطرق.
الاستدعاء	اقتباس واحد
CitationMetadata	البيانات الوصفية للاقتباس التي يمكن العثور عليها في GenerateContentCandidate.
Content	نوع المحتوى لكل من الطلبات والردود المرشحة
CountTokensRequest	مَعلمات طلب GenerativeModel.countTokens()
CountTokensResponse	ردّ من طلب GenerativeModel.countTokens().
CustomErrorData	كائن التفاصيل الذي يحتوي على بيانات ناشئة من استجابة HTTP غير صالحة.
التاريخ_2	Protobuf google.type.Date
OptimizationGenerateContentResponse	كائن الاستجابة ملفوف بالطرق المساعدة.
ErrorDetails	كائن التفاصيل الذي قد يتم تضمينه في استجابة خطأ.
FileData	البيانات التي تشير إلى ملف تم تحميله على Google Cloud Storage
FileData Part (جزء من بيانات الملف)	واجهة جزء المحتوى إذا كان الجزء يمثّل FileData
FunctionCall	عرض FunctionCall متنبأ به من النموذج يحتوي على سلسلة تمثل FunctionDeclaration.name وكائن JSON منظمًا يحتوي على المعلمات وقيمها.
FunctionCallingConfig
FunctionCallPartner	واجهة جزء من المحتوى إذا كان الجزء يمثّل FunctionCall.
دالة FunctionDeclaation	تمثيل منظَّم لبيان دالة على النحو المحدّد في مواصفات OpenAPI 3.0. يتضمّن هذا البيان اسم الدالة والمَعلمات. يمثّل FunctionDeclaration هذا مجموعة من الرموز التي يمكن أن يستخدمها النموذج وينفّذها العميل كأداة.
FunctionDeclarationSchema	مخطط للمعلَمات التي يتم تمريرها إلى FunctionDeclaration.parameters.
FunctionDeclarationSchemaProperty	يتم استخدام المخطط لتحديد تنسيق بيانات الإدخال/الإخراج. ويمثِّل هذا الإعداد مجموعة فرعية محدَّدة من كائن مخطط OpenAPI 3.0. ويمكن إضافة المزيد من الحقول في المستقبل حسب الحاجة.
FunctionDeclarationsTool	FunctionDeclarationsTool هو جزء من الرمز البرمجي يتيح للنظام التفاعل مع الأنظمة الخارجية لتنفيذ إجراء أو مجموعة إجراءات خارج نطاق المعرفة ونطاق النموذج.
FunctionResponse	يتم استخدام الناتج الناتج من FunctionCall الذي يتضمن سلسلة تمثّل FunctionDeclaration.name وكائن JSON منظمًا يحتوي على أي ناتج من الدالة كسياق للنموذج. ويجب أن يشتمل هذا على نتيجة FunctionCall تم إجراؤها استنادًا إلى توقّع النموذج.
FunctionResponsePartner	واجهة جزء من المحتوى إذا كان الجزء يمثّل FunctionResponse.
GenerateContentCandidate	تم عرض أحد المرشّحين كجزء من GenerateContentResponse.
GenerateContentRequest	تم إرسال الطلب من خلال GenerativeModel.generateContent().
GenerateContentResponse	ردّ فردي من GenerativeModel.generateContent() وGenerativeModel.generateContentStream(). سيعرض "generateContentStream()" رسالة واحدة في كل مقطع إلى أن ينتهِ البث.
GenerateContentResult	تم عرض عنصر النتيجة من استدعاء GenerativeModel.generateContent().
GenerateContentStreamResult	تم عرض عنصر النتيجة من استدعاء GenerativeModel.generateContentStream(). يمكنك تكرار أكثر من stream للحصول على مقاطع الترجمة والشرح عند ظهورها و/أو استخدام وعد response للحصول على الردود المجمّعة عند انتهاء البث المباشر.
GenerationConfig	خيارات الضبط للطلبات ذات الصلة بالمحتوى
GenerativeContentBlob	واجهة لإرسال صورة
تحديد المصدر
GroundingMetadata	يتم عرض البيانات الوصفية للعميل عند تفعيل التأريض.
قسم البيانات المضمّن	واجهة جزء من المحتوى إذا كان الجزء يمثل صورة.
مَعلمات النماذج	تم تمرير المَعلمات إلى getgenerativeModel().
PromptFeedback	إذا تم حظر الطلب، ستتم تعبئة هذا الحقل بـ blockReason وقيمة السمة safetyRatings ذات الصلة.
RequestOptions	تم تمرير المَعلمات إلى getgenerativeModel().
RetrievedContextAttribution
SafetyRating	تقييم أمان مرتبط بـ GenerateContentCandidate
إعدادات الأمان	إعداد الأمان الذي يمكن إرساله كجزء من معلَمات الطلب.
القسم
StartChatParams	مَعلمات GenerativeModel.startChat().
"جزء النص"	واجهة جزء من المحتوى إذا كان الجزء يمثل سلسلة نصية.
ToolConfig	إعدادات الأداة. تتم مشاركة هذه الإعدادات مع جميع الأدوات المقدَّمة في الطلب.
بيانات الاستخدام الوصفية	البيانات الوصفية للاستخدام حول GenerateContentResponse.
VertexAI	مثال على حزمة تطوير برامج Vertex AI for Firebase
VertexAIOptions	الخيارات المتاحة عند إعداد حزمة تطوير البرامج (SDK) الخاصة بـ Vertex AI for Firebase
بيانات الفيديو الوصفية	وصف محتوى الفيديو الذي تم إدخاله
تحديد المصدر على الويب

المتغيرات

متغير	الوصف
POSSIBLE_ROWSS	الأدوار المحتملة

كتابة العناوين البديلة للبريد الإلكتروني

اكتب العنوان البديل للبريد الإلكتروني	الوصف
الجزء	جزء من المحتوى: يتضمّن أنواعًا معيّنة من النصوص، أو الصور/الفيديوهات، أو طلبات الدوال أو الردود.
Role	والدور هو منتِج المحتوى.
الأداة	تحدد أداة يمكن أن يستدعيها النموذج للوصول إلى المعرفة الخارجية.

function(app, ...)

getVertexAI(app, options)

عرض مثيل VertexAI للتطبيق المحدّد

Signature:

export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;

المَعلمات

المَعلمة	Type	الوصف
التطبيق	تطبيق Firebase	FirebaseApp المطلوب استخدامه.
خيارات	VertexAIOptions

المرتجعات:

VertexAI

function(ectexAI, ...)

getGenerativeModel(veexAI, modelParams, requestOptions)

تعرض فئة GenerativeModel مع طرق الاستنتاج وغيرها من الوظائف.

Signature:

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

المَعلمات

المَعلمة	Type	الوصف
رأس الصفحة	VertexAI
نماذج باراما	مَعلمات النماذج
خيارات الطلب	RequestOptions

المرتجعات:

النموذج التوليدي

الاحتمالات

الأدوار المحتملة

Signature:

POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]

الجزء

جزء من المحتوى: يتضمّن أنواعًا معيّنة من النصوص، أو الصور/الفيديوهات، أو طلبات الدوال أو الردود.

Signature:

export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;

الدور

والدور هو منتِج المحتوى.

Signature:

export declare type Role = (typeof POSSIBLE_ROLES)[number];

أداة

تحدد أداة يمكن أن يستدعيها النموذج للوصول إلى المعرفة الخارجية.

Signature:

export declare type Tool = FunctionDeclarationsTool;

سبب الحظر

سبب حظر الطلب

Signature:

export declare enum BlockReason 

تعداد الأعضاء

عضو	القيمة	الوصف
BLOCKED_REASON_UNSPECIFIED	"BLOCKED_REASON_UNSPECIFIED"
نوع إعلان آخر	"OTHER"
السلامة	"SAFETY"

سبب الإنهاء

سبب انتهاء أحد المرشّحين.

Signature:

export declare enum FinishReason 

تعداد الأعضاء

عضو	القيمة	الوصف
FINISH_REASON_UNSPECIFIED	"FINISH_REASON_UNSPECIFIED"
الحد الأقصى لعدد الرموز	"MAX_TOKENS"
نوع إعلان آخر	"OTHER"
التواصل	"RECITATION"
السلامة	"SAFETY"
STOP	"STOP"

وضع FunctionCalling

Signature:

export declare enum FunctionCallingMode 

تعداد الأعضاء

عضو	القيمة	الوصف
أي سعر	"ANY"
تلقائي	"AUTO"
الوضع_غير محدّد	"MODE_UNSPECIFIED"
لا شيء	"NONE"

FunctionDeclarationSchemaType

تحتوي على قائمة بأنواع بيانات OpenAPI على النحو المحدّد في https://swagger.io/docs/specification/data-models/data-types/

Signature:

export declare enum FunctionDeclarationSchemaType 

تعداد الأعضاء

عضو	القيمة	الوصف
صفيف	"ARRAY"	نوع المصفوفة
منطقية	"BOOLEAN"	النوع المنطقي.
عدد صحيح	"INTEGER"	نوع عدد صحيح
الرقم	"NUMBER"	نوع الرقم.
الهدف	"OBJECT"	نوع الكائن:
سلسلة	"STRING"	نوع السلسلة.

طريقة HarmBlockMethod

Signature:

export declare enum HarmBlockMethod 

تعداد الأعضاء

عضو	القيمة	الوصف
HARM_BLOCK_Method_UNSPECIFIED	"HARM_BLOCK_METHOD_UNSPECIFIED"
الاحتمالية	"PROBABILITY"
درجة الخطورة	"SEVERITY"

عتبة الضرر

الحدّ الذي سيتم حظر طلب أو مرشح عند تجاوزه.

Signature:

export declare enum HarmBlockThreshold 

تعداد الأعضاء

عضو	القيمة	الوصف
حظر	"BLOCK_LOW_AND_ABOVE"
حظر	"BLOCK_MEDIUM_AND_ABOVE"
حظر	"BLOCK_NONE"
حظر فقط	"BLOCK_ONLY_HIGH"
HARM_BLOCK_TERMS_UNSPECIFIED	"HARM_BLOCK_THRESHOLD_UNSPECIFIED"

فئة الضرر

فئات الضرر التي قد تؤدي إلى حظر الطلبات أو الاقتراحات

Signature:

export declare enum HarmCategory 

تعداد الأعضاء

عضو	القيمة	الوصف
HARM_CATEGORY_DANGEROUS_CONTENT	"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"

الاحتمالية الضارة

احتمالية تطابق الطلب أو المرشّح مع فئة ضرر

Signature:

export declare enum HarmProbability 

تعداد الأعضاء

عضو	القيمة	الوصف
HARM_PROBCompliance_UNSPECIFIED	"HARM_PROBABILITY_UNSPECIFIED"
درجة التزام عالية	"HIGH"
درجة التزام منخفضة	"LOW"
تفاعُل متوسط	"MEDIUM"
إهمال	"NEGLIGIBLE"

درجة الخطورة

مستويات خطورة الضرر:

Signature:

export declare enum HarmSeverity 

تعداد الأعضاء

عضو	القيمة	الوصف
HARM_SEVERITY_HIGH	"HARM_SEVERITY_HIGH"
HARM_SEVERITY_LOW	"HARM_SEVERITY_LOW"
HARM_SEVERITY_MEDIUM	"HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE	"HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED	"HARM_SEVERITY_UNSPECIFIED"

رمز VertexAIErrorCode

رموز الخطأ الموحّدة التي يمكن أن يتضمّنها الخطأ VertexAIError.

Signature:

export declare const enum VertexAIErrorCode 

تعداد الأعضاء

عضو	القيمة	الوصف
خطأ	"error"	حدث خطأ عام.
FETCH_ERROR	"fetch-error"	حدث خطأ أثناء عملية جلب.
محتوى غير صالح	"invalid-content"	حدث خطأ مرتبط بكائن "المحتوى".
NO_API_KEY	"no-api-key"	حدث خطأ بسبب عدم توفُّر مفتاح واجهة برمجة تطبيقات Firebase.
لا يوجد نموذج	"no-model"	حدث خطأ بسبب عدم تحديد اسم نموذج أثناء الإعداد.
رقم تعريف المشروع (NO_PROJECT_ID)	"no-project-id"	حدث خطأ بسبب عدم توفّر رقم تعريف المشروع.
فشل_PARSE	"parse-failed"	حدث خطأ أثناء التحليل.
الخطأ REQUEST_ERROR	"request-error"	حدث خطأ في أحد الطلبات.
خطأ_RESPONSE	"response-error"	حدث خطأ في الردّ.