حزمة تطوير البرامج (SDK) على الويب Vertex AI For Firebase على الويب
الوظائف
الوظيفة | الوصف |
---|---|
الوظيفة(التطبيق، ...) | |
getVertexAI(app, options) | تعرض مثيل VertexAI للتطبيق المحدّد. |
الدالة(VERexAI, ...) | |
getGenerativeModel(VERexAI, modelParams, requestOptions) | تعرض فئة GenerativeModel مع طرق للاستنتاج ووظائف أخرى. |
صفوف
الفئة | الوصف |
---|---|
ChatSession | فئة ChatSession التي تتيح إرسال رسائل المحادثة وتخزِّن سجلّ الرسائل المُرسَلة والمستلَمة حتى الآن. |
GenerativeModel | فئة واجهات برمجة التطبيقات للنموذج التوليدي. |
التعدادات
التعداد | الوصف |
---|---|
سبب الحظر | سبب حظر الطلب |
سبب الانتهاء | سبب انتهاء المرشح |
FunctionCallingMode | |
FunctionDeclarationSchemaType | تحتوي على قائمة بأنواع بيانات OpenAPI على النحو المحدّد في https://swagger.io/docs/specification/data-models/data-types/ |
HarmBlockMethod | |
HarmBlockThreshold | الحدّ الذي يتم تجاوزه حظر طلب أو مرشح. |
HarmCategory | فئات المحتوى الضار التي قد تؤدي إلى حظر الطلبات أو المرشحين. |
احتمالية الضرر | احتمالية تطابق مطالبة أو مرشح مع فئة ضرر. |
درجة الخطورة | مستويات خطورة الضرر |
الواجهات
الواجهة | الوصف |
---|---|
BaseParams | المعلمات الأساسية لعدد من الطرق. |
الاستدعاء | اقتباس واحد |
CitationMetadata | البيانات الوصفية للاقتباس التي يمكن العثور عليها في generateContentCandidate |
Content | نوع المحتوى لكلّ من الطلبات والمرشحين للرد. |
CountTokensRequest | معلمات استدعاء GenerativeModel.countTokens() |
CountTokensResponse | ردّ من استدعاء GenerativeModel.countTokens(). |
التاريخ_2 | Protobuf google.type.Date |
إدارة المحتوى المحسّن | كائن استجابة ملفوف بأساليب مساعِدة. |
بيانات الملف | بيانات تشير إلى ملف تم تحميله على Google Cloud Storage |
FileDataجزء من المعلومات | واجهة جزء المحتوى إذا كان الجزء يمثل FileData |
FunctionCall | دالة FunctionCall المتوقّعة التي يتم عرضها من النموذج الذي يحتوي على سلسلة تمثّل FunctionDeclaration.name وكائن JSON منظم يحتوي على المَعلمات وقيمها. |
FunctionCallingConfig | |
FunctionCallpart | واجهة جزء المحتوى إذا كان الجزء يمثل FunctionCall. |
دالة FunctionDeclaration | التمثيل المنظَّم لإعلان الدالة على النحو المحدّد في مواصفات OpenAPI 3.0 يتضمّن هذا التعريف اسم الدالة والمَعلمات. تمثّل FunctionDeclaration هذه مجموعة من الرموز البرمجية يمكن استخدامها كأداة من خلال النموذج وتنفيذها العميل. |
FunctionDeclarationSchema | مخطط للمَعلمات التي تم تمريرها إلى FunctionDeclaration.parameters. |
FunctionDeclarationSchemaProperty | يُستخدم المخطط لتحديد تنسيق بيانات الإدخال/الإخراج. يمثل مجموعة فرعية مختارة من كائن مخطط OpenAPI 3.0. يمكن إضافة المزيد من الحقول في المستقبل حسب الحاجة. |
FunctionDeclarationsTool | FunctionDeclarationsTool هو جزء من الرمز البرمجي يتيح للنظام التفاعل مع الأنظمة الخارجية لتنفيذ إجراء أو مجموعة من الإجراءات، خارج نطاق توفّر النموذج ونطاقه. |
FunctionResponse | يتم استخدام نتيجة النتيجة من FunctionCall التي تحتوي على سلسلة تمثّل FunctionDeclaration.name وكائن JSON منظم يحتوي على أي ناتج من الدالة كسياق للنموذج. يجب أن يحتوي هذا على نتيجة FunctionCall التي تم إنشاؤها استنادًا إلى توقّع النموذج. |
FunctionResponseApply | واجهة جزء المحتوى إذا كان الجزء يمثل FunctionResponse. |
CREATEContentCandidate | تم عرض مرشح كجزء من generateContentResponse. |
إنشاء ContentRequest | تم إرسال الطلب من خلال GenerativeModel.generateContent(). |
إنشاء ContentResponse | استجابة فردية من GenerativeModel.generateContent() وGenerativeModel.generateContentStream(). ستعرض generateContentStream() رسالة واحدة في كل مقطع إلى أن ينتهي البث. |
إنشاء ContentResult | تم عرض كائن النتيجة من استدعاء GenerativeModel.generateContent(). |
إنشاء ContentStreamResult | تم عرض كائن النتيجة من استدعاء GenerativeModel.generateContentStream(). يمكنك تكرار ما يزيد عن stream للحصول على المقاطع فور وصولها و/أو استخدام وعد response للحصول على الرد المجمّع عند انتهاء البث. |
GenerationConfig | خيارات الضبط للطلبات المتعلقة بالمحتوى |
GenerativeContentBlob | واجهة لإرسال صورة |
تحديد المصدر على الأرض | |
GroundingMetadata | يتم إرجاع البيانات الوصفية إلى العميل عند تفعيل ميزة التأريض. |
InlineDataPart | واجهة جزء المحتوى إذا كان الجزء يمثل صورة. |
ModelParams | تم تمرير المَعلمات إلى getGenerativeModel(). |
PromptFeedback | إذا تم حظر الطلب، ستتم تعبئة هذا الحقل بالعنوان blockReason وsafetyRatings ذي الصلة. |
خيارات الطلب | تم تمرير المَعلمات إلى getGenerativeModel(). |
RetrievedContextAttribution | |
تقييم السلامة | تقييم أمان مرتبط بالنوع generateContentCandidate |
إعدادات الأمان | يشير ذلك إلى إعداد الأمان الذي يمكن إرساله كجزء من مَعلمات الطلب. |
تقسيم | |
إعدادات بدء المحادثة | معلمات GenerativeModel.startChat(). |
Textالجزء | واجهة جزء المحتوى إذا كان الجزء يمثل سلسلة نصية. |
إعداد الأدوات | ضبط الأداة تتم مشاركة هذه الإعدادات مع جميع الأدوات المتوفرة في الطلب. |
البيانات الوصفية للاستخدام | البيانات الوصفية للاستخدام حول generateContentResponse |
VertexAI | مثيل لحزمة تطوير البرامج (SDK) الخاصة بأداة Vertex AI for Firebase |
VertexAIOptions | الخيارات المتاحة عند إعداد حزمة تطوير البرامج (SDK) لميزة Vertex AI for Firebase |
البيانات الوصفية للفيديو | لوصف محتوى الفيديو المدخل |
الإحالة على الويب |
المتغيرات
متغير | الوصف |
---|---|
أدوار_POSSIBLE | الأدوار المحتمَلة |
الأسماء المستعارة للنوع
النوع البديل | الوصف |
---|---|
الجزء | جزء المحتوى: يشمل النص أو الصور/الفيديوهات أو أنواع أجزاء الاستجابة/استدعاء الوظائف. |
Role | والدور هو منتج المحتوى. |
الأداة | تحدد أداة يمكن للنموذج استدعاءها للوصول إلى المعرفة الخارجية. |
الدالة(app, ...)
getVertexAI(app, options)
تعرض مثيل VertexAI للتطبيق المحدّد.
Signature:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
المَعلمات
المَعلمة | Type | الوصف |
---|---|---|
التطبيق | FirebaseApp | FirebaseApp المطلوب استخدامها. |
خيارات | VertexAIOptions |
المرتجعات:
الدالة(VERexAI, ...)
getGenerativeModel(VERexAI, modelParams, requestOptions)
تعرض فئة GenerativeModel مع طرق للاستنتاج ووظائف أخرى.
Signature:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
المَعلمات
المَعلمة | Type | الوصف |
---|---|---|
رأس السنة | VertexAI | |
نماذج بارارام | ModelParams | |
خيارات الطلب | خيارات الطلب |
المرتجعات:
الأدوار المحتملة
الأدوار المحتمَلة
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" |
FunctionCallingMode
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" |
|
الاحتمالية | "PROBABILITY" |
|
مستوى الخطورة | "SEVERITY" |
حد حظر الخطر
الحدّ الذي يتم تجاوزه حظر طلب أو مرشح.
Signature:
export declare enum HarmBlockThreshold
أعضاء التعداد
عضو | القيمة | الوصف |
---|---|---|
BLOCK_LOW_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
BLOCK_MEDIUM_AND_ABOVE | "BLOCK_MEDIUM_AND_ABOVE" |
|
حظر | "BLOCK_NONE" |
|
حظر_فقط_مرتفع | "BLOCK_ONLY_HIGH" |
|
HARM_BLOCK_LIMIT_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_PROBABILITY_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" |