Firebase वेब SDK टूल में Vertex AI.
फ़ंक्शन
फ़ंक्शन | ब्यौरा |
---|---|
फ़ंक्शन(ऐप्लिकेशन, ...) | |
getVertexAI(ऐप्लिकेशन, विकल्प) | दिए गए ऐप्लिकेशन के लिए VertexAI इंस्टेंस दिखाता है. |
फ़ंक्शन(VerexAI, ...) | |
getGenerativeModel(VerexAI, ModelParams, requestOptions) | अनुमान लगाने और अन्य फ़ंक्शन के इस्तेमाल के लिए, GenerativeModel क्लास दिखाता है. |
क्लास
क्लास | ब्यौरा |
---|---|
चैट सेशन | Chatसेशन क्लास की मदद से, चैट मैसेज भेजे जा सकते हैं. साथ ही, भेजे और पाए गए मैसेज का इतिहास सेव किया जा सकता है. |
जनरेटिव मॉडल | जनरेटिव मॉडल एपीआई की क्लास. |
VertexAIError | Firebase SDK टूल में, Vertex AI के लिए गड़बड़ी की क्लास. |
इन्यूमरेशन
इन्यूमरेशन | ब्यौरा |
---|---|
ब्लॉक करने की वजह | प्रॉम्प्ट को ब्लॉक किए जाने की वजह. |
खत्म होने की वजह | उम्मीदवार के चुनाव लड़ने की वजह. |
FunctionCallingMode | |
FunctionDeflarationschemaType | इसमें OpenAPI डेटा टाइप की सूची शामिल है. इसके बारे में https://swagger.io/docs/specification/data-models/data-types/ ने बताया है |
हार्मब्लॉक मेथड | |
हार्मब्लॉक थ्रेशोल्ड | वह थ्रेशोल्ड जिससे ज़्यादा सवाल या उम्मीदवार को ब्लॉक किया जाएगा. |
नुकसान की कैटगरी | नुकसान पहुंचाने वाली ऐसी कैटगरी जिनकी वजह से प्रॉम्प्ट या उम्मीदवारों को ब्लॉक किया जा सकता है. |
नुकसान की संभावना | इस बात की संभावना कि कोई प्रॉम्प्ट या उम्मीदवार, नुकसान पहुंचाने वाली कैटगरी से मेल खाता है. |
नुकसान की गंभीरता | गंभीरता के लेवल को नुकसान पहुंचाना. |
VertexAIErrorCode | स्टैंडर्ड तौर पर दिए गए गड़बड़ी के कोड, जो VertexAIError में हो सकते हैं. |
इंटरफ़ेस
इंटरफ़ेस | ब्यौरा |
---|---|
BaseParams | कई तरीकों के लिए बेस पैरामीटर. |
उद्धरण | एक उद्धरण. |
उद्धरण मेटाडेटा | उद्धरण का मेटाडेटा, जो GenerateContentContent पर मिल सकता है. |
कॉन्टेंट | प्रॉम्प्ट और जवाब देने वाले उम्मीदवारों के लिए कॉन्टेंट का टाइप. |
CountTokensRequest | GenerativeModel.countTokens() को कॉल करने के पैरामीटर |
CountTokensResponse | GenerativeModel.countTokens() को कॉल करने से मिला जवाब. |
कस्टमगड़बड़ी डेटा | जानकारी वाला ऑब्जेक्ट जिसमें खराब एचटीटीपी रिस्पॉन्स से डेटा शामिल है. |
तारीख_2 | प्रोटोबफ़ google.type.Date |
AdvancedGenerateContentResponse | रिस्पॉन्स ऑब्जेक्ट को हेल्पर तरीकों से रैप किया गया. |
गड़बड़ी की जानकारी | ब्यौरा ऑब्जेक्ट, जिसे किसी गड़बड़ी के जवाब में शामिल किया जा सकता है. |
फ़ाइल डेटा | Google Cloud Storage पर अपलोड की गई किसी फ़ाइल के बारे में बताने वाला डेटा. |
फ़ाइल डेटा पार्ट | अगर किसी हिस्से में FileData का इस्तेमाल किया गया है, तो कॉन्टेंट के हिस्से का इंटरफ़ेस |
FunctionCall | इस मॉडल से मिला अनुमानित FunctionCall, जिसमें Functiondeclaration.name दिखाने वाली एक स्ट्रिंग और एक स्ट्रक्चर्ड JSON ऑब्जेक्ट होता है. इस ऑब्जेक्ट में पैरामीटर और उनकी वैल्यू शामिल होती हैं. |
FunctionCallingConfig | |
FunctionCallPart | कॉन्टेंट के हिस्से का इंटरफ़ेस, अगर कोई हिस्सा FunctionCall दिखाता है. |
फ़ंक्शनडिक्लेरेशन | OpenAPI 3.0 की खास बातों के मुताबिक, फ़ंक्शन की जानकारी का स्ट्रक्चर्ड ब्यौरा. इस एलान में फ़ंक्शन के नाम और पैरामीटर की जानकारी भी दी गई है. यह FunctionDeclaration , कोड के ब्लॉक को दिखाता है. इसका इस्तेमाल मॉडल, टूल के तौर पर करता है और क्लाइंट इसे एक्ज़ीक्यूट करता है. |
Functiondeclaration स्कीमा | उन पैरामीटर के लिए स्कीमा जिन्हें Functiondeclaration.parameters को पास किया जाता है. |
Functiondeclarationschemaप्रॉपर्टी | स्कीमा का इस्तेमाल, इनपुट/आउटपुट डेटा का फ़ॉर्मैट तय करने के लिए किया जाता है. यह OpenAPI 3.0 स्कीमा ऑब्जेक्ट का चुनिंदा सबसेट दिखाता है. आने वाले समय में ज़रूरत के हिसाब से और फ़ील्ड जोड़े जा सकते हैं. |
फ़ंक्शनडिक्लेरेशन टूल | FunctionDeclarationsTool , कोड का एक हिस्सा होता है. इसकी मदद से सिस्टम, बाहरी सिस्टम से इंटरैक्ट कर पाता है, ताकि मॉडल की जानकारी और दायरे से बाहर कोई कार्रवाई या कार्रवाइयों का सेट पूरा कर सके. |
FunctionResponse | FunctionCall से मिलने वाले नतीजे का आउटपुट, जिसमें FunctionDeflaration.name को दिखाने वाली एक स्ट्रिंग होती है. साथ ही, फ़ंक्शन से मिले किसी भी आउटपुट वाले स्ट्रक्चर्ड JSON ऑब्जेक्ट का इस्तेमाल, मॉडल के कॉन्टेक्स्ट के तौर पर किया जाता है. इसमें मॉडल के अनुमान के आधार पर बनाए गए FunctionCall का नतीजा शामिल होना चाहिए. |
FunctionResponsePart | अगर किसी हिस्से में FunctionResponse है, तो कॉन्टेंट के हिस्से का इंटरफ़ेस. |
GenerateContentContent | generateContentResponse के तहत, किसी उम्मीदवार का जवाब मिला. |
GenerateContentRequest | GenerativeModel.generateContent() के ज़रिए अनुरोध भेजा गया |
GenerateContentResponse | GenerativeModel.generateContent() और GenerativeModel.generateContentStream() से मिलने वाले अलग-अलग जवाब. जब तक स्ट्रीम पूरी नहीं हो जाती, तब तक generateContentStream() हर हिस्से में एक जवाब दिखाएगा. |
GenerateContentresults | GenerativeModel.generateContent() कॉल से मिला नतीजा ऑब्जेक्ट. |
GenerateContentStreamresults | GenerativeModel.generateContentStream() कॉल से मिला नतीजा ऑब्जेक्ट. लाइव स्ट्रीम के दौरान जवाब पाने के लिए, stream से ज़्यादा बार हिस्सा लेने के लिए बार-बार बताएं और/या लाइव स्ट्रीम खत्म होने के बाद एग्रीगेट किया गया जवाब पाने के लिए, response प्रॉमिस का इस्तेमाल करें. |
जेनरेशन कॉन्फ़िगरेशन | कॉन्टेंट से जुड़े अनुरोधों के लिए कॉन्फ़िगरेशन के विकल्प |
जनरेटिव कॉन्टेंटब्लॉब | इमेज भेजने के लिए इंटरफ़ेस. |
ग्राउंडिंग एट्रिब्यूशन | |
ग्राउंडिंग मेटाडेटा | ग्राउंडिंग के चालू होने पर क्लाइंट को मेटाडेटा वापस किया गया. |
InlineDataPart | अगर कॉन्टेंट के किसी हिस्से में कोई इमेज है, तो उसका इंटरफ़ेस. |
मॉडल पैरामीटर | getGenerativeModel() को पास किए गए पैरामीटर. |
प्रॉम्प्ट के बारे में सुझाव दें | अगर प्रॉम्प्ट को ब्लॉक किया गया था, तो इसे blockReason और काम के safetyRatings से भर दिया जाएगा. |
अनुरोध के विकल्प | getGenerativeModel() को पास किए गए पैरामीटर. |
RetrievedContextAttribution | |
SafetyRating | GenerateContentContent से जुड़ी सुरक्षा रेटिंग |
सुरक्षा सेटिंग | सुरक्षा सेटिंग, जिसे अनुरोध के पैरामीटर के तौर पर भेजा जा सकता है. |
Segment | |
StartChatParams | GenerativeModel.startChat() के पैरामीटर. |
TextPart | अगर कॉन्टेंट के किसी हिस्से में टेक्स्ट स्ट्रिंग है, तो उसका इंटरफ़ेस. |
टूल कॉन्फ़िगरेशन | टूल कॉन्फ़िगरेशन. यह कॉन्फ़िगरेशन, अनुरोध में दिए गए सभी टूल के लिए शेयर किया जाता है. |
इस्तेमाल का मेटाडेटा | GenerateContentResponse के बारे में इस्तेमाल से जुड़ा मेटाडेटा. |
VertexAI | Firebase SDK टूल में Vertex AI का उदाहरण. |
VertexAIOptions | Firebase SDK टूल में Vertex AI को शुरू करने के लिए उपलब्ध विकल्प. |
वीडियो का मेटाडेटा | इनपुट वीडियो कॉन्टेंट की जानकारी देता है. |
वेबएट्रिब्यूशन |
वैरिएबल
वैरिएबल | ब्यौरा |
---|---|
POSSIBLE_roleS | संभावित भूमिकाएं. |
उपनामों का प्रकार
उपनाम टाइप करें | ब्यौरा |
---|---|
हिस्सा | कॉन्टेंट वाला हिस्सा - इसमें टेक्स्ट, इमेज/वीडियो या फ़ंक्शन कॉल/रिस्पॉन्स पार्ट टाइप शामिल होते हैं. |
भूमिका | भूमिका से कॉन्टेंट का प्रोड्यूसर होता है. |
टूल | एक ऐसे टूल के बारे में बताता है जिसे मॉडल बाहरी जानकारी को ऐक्सेस करने के लिए कॉल कर सकता है. |
फ़ंक्शन(ऐप्लिकेशन, ...)
getVertexAI(ऐप्लिकेशन, विकल्प)
दिए गए ऐप्लिकेशन के लिए VertexAI इंस्टेंस दिखाता है.
हस्ताक्षर:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
ऐप्लिकेशन | FirebaseApp | इस्तेमाल करने के लिए FirebaseApp. |
विकल्प | VertexAIOptions |
लौटाए जाने वाले प्रॉडक्ट:
फ़ंक्शन(वर्टेक्सएआई, ...)
getGenerativeModel(VerexAI, ModelParams, requestOptions)
अनुमान लगाने और अन्य फ़ंक्शन के इस्तेमाल के लिए, GenerativeModel क्लास दिखाता है.
हस्ताक्षर:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
वर्टेक्सAI | VertexAI | |
मॉडल पैरामीटर | मॉडल पैरामीटर | |
अनुरोध के विकल्प | अनुरोध के विकल्प |
लौटाए जाने वाले प्रॉडक्ट:
POSSIBLE_भूमिकाएं
संभावित भूमिकाएं.
हस्ताक्षर:
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 | "SAFETY" |
खत्म होने की वजह
उम्मीदवार के चुनाव लड़ने की वजह.
हस्ताक्षर:
export declare enum FinishReason
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
FINISH_REASON_UNSPECIFIED | "FINISH_REASON_UNSPECIFIED" |
|
MAX_TOKENS | "MAX_TOKENS" |
|
अन्य | "OTHER" |
|
बुकिंग | "RECITATION" |
|
Safety | "SAFETY" |
|
रोकें | "STOP" |
फ़ंक्शन कॉलिंग मोड
हस्ताक्षर:
export declare enum FunctionCallingMode
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
कोई भी | "ANY" |
|
ऑटो | "AUTO" |
|
मोड_जानकारी नहीं है | "MODE_UNSPECIFIED" |
|
कोई नहीं | "NONE" |
फ़ंक्शन डिक्लेरेशन स्कीमाटाइप
इसमें OpenAPI डेटा टाइप की सूची शामिल है. इसके बारे में https://swagger.io/docs/specification/data-models/data-types/ ने बताया है
हस्ताक्षर:
export declare enum FunctionDeclarationSchemaType
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
ऐरे | "ARRAY" |
सरणी प्रकार. |
बूलियन | "BOOLEAN" |
बूलियन टाइप. |
पूर्णांक | "INTEGER" |
पूर्णांक का टाइप. |
NUMBER | "NUMBER" |
नंबर टाइप. |
ऑब्जेक्ट | "OBJECT" |
ऑब्जेक्ट का टाइप. |
स्ट्रिंग | "STRING" |
स्ट्रिंग टाइप. |
हार्मब्लॉक मेथड
हस्ताक्षर:
export declare enum HarmBlockMethod
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
HARM_ब्लॉक_METHOD_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
संभावना | "PROBABILITY" |
|
गंभीरता | "SEVERITY" |
हार्मब्लॉकथ्रेशहोल्ड
वह थ्रेशोल्ड जिससे ज़्यादा सवाल या उम्मीदवार को ब्लॉक किया जाएगा.
हस्ताक्षर:
export declare enum HarmBlockThreshold
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
ब्लॉक_LOW_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
block_MEDIUM_AND_ABOVE | "BLOCK_MEDIUM_AND_ABOVE" |
|
ब्लॉक_नो | "BLOCK_NONE" |
|
सिर्फ़ ब्लॉक | "BLOCK_ONLY_HIGH" |
|
HARM_ब्लॉक_X सीमा_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
नुकसान की कैटगरी
नुकसान पहुंचाने वाली ऐसी कैटगरी जिनकी वजह से प्रॉम्प्ट या उम्मीदवारों को ब्लॉक किया जा सकता है.
हस्ताक्षर:
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" |
|
हार्म_CATEGORY_SEXUALLY_EXPLICIT | "HARM_CATEGORY_SEXUALLY_EXPLICIT" |
|
HARM_CATEGORY_UNSPECIFIED | "HARM_CATEGORY_UNSPECIFIED" |
नुकसान की संभावना
इस बात की संभावना कि कोई प्रॉम्प्ट या उम्मीदवार, नुकसान पहुंचाने वाली कैटगरी से मेल खाता है.
हस्ताक्षर:
export declare enum HarmProbability
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
HARM_PROBABILITY_UNSPECIFIED | "HARM_PROBABILITY_UNSPECIFIED" |
|
ज़्यादा | "HIGH" |
|
कम | "LOW" |
|
मीडियम | "MEDIUM" |
|
न दिखने वाला | "NEGLIGIBLE" |
नुकसान की गंभीरता
गंभीरता के लेवल को नुकसान पहुंचाना.
हस्ताक्षर:
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 में हो सकते हैं.
हस्ताक्षर:
export declare const enum VertexAIErrorCode
इन्यूमरेशन सदस्य
सदस्य | मान | ब्यौरा |
---|---|---|
गड़बड़ी | "error" |
कोई सामान्य गड़बड़ी हुई. |
FETCH_ERROR | "fetch-error" |
फ़ेच करते समय कोई गड़बड़ी हुई. |
अमान्य सामग्री | "invalid-content" |
कॉन्टेंट ऑब्जेक्ट से जुड़ी कोई गड़बड़ी. |
NO_API_KEY | "no-api-key" |
Firebase API कुंजी मौजूद न होने की वजह से कोई गड़बड़ी हुई है. |
नंबर | "no-model" |
शुरू करने के दौरान, मॉडल का नाम नहीं दिए जाने की वजह से कोई गड़बड़ी हुई. |
NO_PROJECT_ID | "no-project-id" |
प्रोजेक्ट आईडी मौजूद न होने की वजह से कोई गड़बड़ी हुई. |
PARSE_FAILED | "parse-failed" |
पार्स करते समय कोई गड़बड़ी हुई. |
अनुरोध से जुड़ी गड़बड़ी | "request-error" |
अनुरोध में कोई गड़बड़ी हुई. |
जवाब देने में गड़बड़ी | "response-error" |
जवाब में कोई गड़बड़ी हुई. |