Firebase वेब SDK टूल के लिए Vertex AI.
फ़ंक्शन
फ़ंक्शन | ब्यौरा |
---|---|
फ़ंक्शन(ऐप्लिकेशन, ...) | |
getVertexAI(ऐप्लिकेशन, विकल्प) | दिए गए ऐप्लिकेशन के लिए VertexAI इंस्टेंस दिखाता है. |
फ़ंक्शन(वर्टेक्सएआई, ...) | |
getGenerativeModel(verexAI, ModelParams, requestOptions) | अनुमान और दूसरे फ़ंक्शन के तरीकों के साथ GenerativeModel क्लास देता है. |
क्लास
क्लास | ब्यौरा |
---|---|
ChatSession | ChatSession क्लास चालू होती है, जो चैट मैसेज भेजने की सुविधा देती है. साथ ही, अब तक भेजे और पाए गए मैसेज का इतिहास भी सेव करती है. |
जनरेटिव मॉडल | जनरेटिव मॉडल एपीआई के लिए क्लास. |
गिनती
गिनती | ब्यौरा |
---|---|
ब्लॉक करने की वजह | प्रॉम्प्ट को ब्लॉक करने की वजह. |
खत्म होने की वजह | उम्मीदवार की चुनाव प्रक्रिया की वजह. |
FunctionCallingMode | |
FunctionExplarationSchemaType | इसमें OpenAPI डेटा टाइप की सूची शामिल होती है, जैसा कि https://swagger.io/docs/specification/data-models/data-types/ ने बताया है |
HarmBlockMethod | |
HarmBlockसीमा | वह थ्रेशोल्ड जिससे ज़्यादा होने पर किसी सूचना या उम्मीदवार को ब्लॉक किया जाएगा. |
हार्म कैटगरी | नुकसान पहुंचाने वाली कैटगरी से जुड़े कॉन्टेंट की मदद से, प्रॉम्प्ट या उम्मीदवारों को ब्लॉक किया जा सकता है. |
नुकसान की संभावना | यह संभावना कि प्रॉम्प्ट या कैंडिडेट, नुकसान की कैटगरी से मेल खाते हों. |
नुकसान की गंभीरता | नुकसान की गंभीरता का लेवल. |
इंटरफ़ेस
इंटरफ़ेस | ब्यौरा |
---|---|
BaseParams | कई तरीकों के लिए बेस पैरामीटर. |
उद्धरण | एक उद्धरण. |
उद्धरण मेटाडेटा | उद्धरण का मेटाडेटा, जो GenerateContentMethod पर मिल सकता है. |
कॉन्टेंट | प्रॉम्प्ट और जवाब, दोनों के लिए कॉन्टेंट का टाइप. |
CountTokensRequest | GenerativeModel.countTokens() को कॉल करने के लिए पैरामीटर |
CountTokensResponse | GenerativeModel.countTokens() को कॉल करने से मिला जवाब. |
तारीख_2 | प्रोटोबफ़ google.type.Date |
GenerateContentResponse | हेल्पर तरीकों के साथ रैप किया गया रिस्पॉन्स ऑब्जेक्ट. |
फ़ाइल डेटा | Google Cloud Storage पर अपलोड की गई फ़ाइल पर ले जाने वाला डेटा. |
FileDataPart | कॉन्टेंट के पार्ट का इंटरफ़ेस, अगर यह हिस्सा FileData को दिखाता है |
फ़ंक्शनकॉल | यह एक अनुमानित FunctionCall है, जो उस मॉडल से दिखाया जाता है जिसमें Function discovery.name को दिखाने वाली स्ट्रिंग होती है. साथ ही, एक स्ट्रक्चर्ड JSON ऑब्जेक्ट होता है, जिसमें पैरामीटर और उनकी वैल्यू शामिल होती हैं. |
FunctionCallingConfig | |
FunctionCallPart | अगर यह हिस्सा किसी FunctionCall को दिखाता है, तो कॉन्टेंट पार्ट का इंटरफ़ेस. |
फ़ंक्शन डेक | OpenAPI 3.0 की खास बातों के मुताबिक, फ़ंक्शन के एलान को सही तरीके से दिखाया गया है. इस एलान में, फ़ंक्शन का नाम और पैरामीटर शामिल हैं. यह FunctionDeclaration , कोड के एक ब्लॉक का प्रतिनिधित्व करता है. मॉडल इसे टूल के तौर पर इस्तेमाल कर सकता है और क्लाइंट एक्ज़ीक्यूट कर सकता है. |
फ़ंक्शनडेक्लरेशन स्कीमा | Function Declaration.parameters को पास किए गए पैरामीटर का स्कीमा. |
FunctionFixlarationSchemaप्रॉपर्टी | स्कीमा का इस्तेमाल, इनपुट/आउटपुट डेटा का फ़ॉर्मैट तय करने के लिए किया जाता है. यह OpenAPI 3.0 स्कीमा ऑब्जेक्ट के चुने हुए सबसेट के बारे में बताता है. आने वाले समय में, ज़रूरत के हिसाब से और फ़ील्ड जोड़े जा सकते हैं. |
Functionघोषणा टूल | FunctionDeclarationsTool , कोड का एक हिस्सा होता है. इसकी मदद से सिस्टम, जानकारी और मॉडल के दायरे से बाहर, कोई कार्रवाई या कार्रवाइयों के सेट को बाहरी सिस्टम से इंटरैक्ट कर सकता है. |
FunctionResponse | FunctionCall से मिलने वाले नतीजे के आउटपुट में, FunctionFactlaration.name को दिखाने वाली स्ट्रिंग होती है. साथ ही, उस फ़ंक्शन से मिलने वाले आउटपुट वाले स्ट्रक्चर्ड JSON ऑब्जेक्ट का इस्तेमाल, मॉडल के कॉन्टेक्स्ट के तौर पर किया जाता है. इसमें मॉडल के अनुमान के आधार पर किए गए FunctionCall का नतीजा शामिल होना चाहिए. |
FunctionResponsePart | अगर यह हिस्सा FunctionResponse को दिखाता है, तो कॉन्टेंट के पार्ट का इंटरफ़ेस. |
जनरेट कंटेंट कैंडिडेट | GenerateContentResponse के हिस्से के तौर पर उम्मीदवार की जानकारी लौटाया गया. |
GenerateContentRequest | GenerativeModel.generateContent() से भेजा गया अनुरोध |
GenerateContentResponse | GenerativeModel.generateContent() और GenerativeModel.generateContentStream() से अलग-अलग रिस्पॉन्स. स्ट्रीम पूरा होने तक, generateContentStream() हर हिस्से में एक रिस्पॉन्स दिखाएगा. |
GenerateContentनतीजे | GenerativeModel.generateContent() कॉल से मिला नतीजा ऑब्जेक्ट. |
GenerateContentStreamresults | GenerativeModel.generateContentStream() कॉल से मिला नतीजा ऑब्जेक्ट. स्ट्रीम के दौरान हिस्सा लेने के लिए stream से ज़्यादा बार दोहराएँ और/या response प्रॉमिस का इस्तेमाल करके स्ट्रीम पूरी होने के बाद एग्रीगेट किया गया जवाब पाएं. |
GenerationConfig | कॉन्टेंट से जुड़े अनुरोधों के लिए कॉन्फ़िगरेशन विकल्प |
जनरेटिव कॉन्टेंटब्लोब | इमेज भेजने के लिए इंटरफ़ेस. |
ग्राउंड एट्रिब्यूशन | |
GroundingMetadata | तथ्यों के साथ जानकारी देने की सुविधा चालू होने पर, मेटाडेटा क्लाइंट को वापस कर दिया जाता है. |
InlineDataPart | अगर किसी हिस्से से किसी इमेज को दिखाया गया है, तो कॉन्टेंट के पार्ट का इंटरफ़ेस. |
मॉडल पैरामीटर | getGenerativeModel() को पैरामीटर पास किए गए. |
प्रॉम्प्ट सुझाव | अगर प्रॉम्प्ट को ब्लॉक किया गया है, तो इसमें blockReason और उससे जुड़े safetyRatings की जानकारी अपने-आप भर जाएगी. |
अनुरोध के विकल्प | getGenerativeModel() को पैरामीटर पास किए गए. |
वापस लाया गयाContextAttribution | |
Safetyरेटिंग | GenerateContent तारीख़ से जुड़ी सुरक्षा रेटिंग |
SafetySettings | सुरक्षा सेटिंग, जो अनुरोध पैरामीटर के हिस्से के तौर पर भेजी जा सकती है. |
Segment | |
StartChatParams | GenerativeModel.startChat() के लिए पैरामीटर. |
टेक्स्ट पार्ट | कॉन्टेंट पार्ट का इंटरफ़ेस, अगर कोई हिस्सा किसी टेक्स्ट स्ट्रिंग को दिखाता है. |
टूल कॉन्फ़िगरेशन | टूल कॉन्फ़िगरेशन. यह कॉन्फ़िगरेशन, अनुरोध में दिए गए सभी टूल के लिए शेयर किया जाता है. |
UseMetadata | GenerateContentResponse के बारे में इस्तेमाल से जुड़ा मेटाडेटा. |
VertexAI | Firebase SDK टूल के लिए Vertex AI का एक इंस्टेंस. |
VertexAIOptions | Firebase के लिए Vertex AI SDK टूल को शुरू करने के दौरान उपलब्ध विकल्प. |
VideoMetadata | इनपुट वीडियो कॉन्टेंट की जानकारी देता है. |
वेबएट्रिब्यूशन |
वैरिएबल
वैरिएबल | ब्यौरा |
---|---|
POSSIBLE_roleS | संभावित भूमिकाएं. |
उपनाम टाइप
उपनाम लिखें | ब्यौरा |
---|---|
हिस्सा | कॉन्टेंट का हिस्सा - इसमें टेक्स्ट, इमेज/वीडियो या फ़ंक्शन कॉल/रिस्पॉन्स के पार्ट टाइप शामिल हैं. |
भूमिका | रोल से कॉन्टेंट को बनाया जाता है. |
टूल | एक ऐसे टूल के बारे में बताता है जिसे मॉडल, बाहरी ज्ञान तक पहुंचने के लिए कॉल कर सकता है. |
फ़ंक्शन(ऐप्लिकेशन, ...)
getVertexAI(ऐप्लिकेशन, विकल्प)
दिए गए ऐप्लिकेशन के लिए VertexAI इंस्टेंस दिखाता है.
हस्ताक्षर:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
ऐप्लिकेशन | Firebaseऐप्लिकेशन | इस्तेमाल करने के लिए FirebaseApp. |
विकल्प | VertexAIOptions |
लौटाए जाने वाले प्रॉडक्ट:
फ़ंक्शन(वर्टेक्सएआई, ...)
getGenerativeModel(VERexAI, ModelParams, requestOptions)
अनुमान और दूसरे फ़ंक्शन के तरीकों के साथ GenerativeModel क्लास देता है.
हस्ताक्षर:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
वर्टेक्सएआई | VertexAI | |
मॉडल पैरामीटर | मॉडल पैरामीटर | |
अनुरोध के विकल्प | अनुरोध के विकल्प |
लौटाए जाने वाले प्रॉडक्ट:
बिक्री की जगह
संभावित भूमिकाएं.
हस्ताक्षर:
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
इन्युमेशन सदस्य
सदस्य | वैल्यू | ब्यौरा |
---|---|---|
ब्लॉक किया गया REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
अन्य | "OTHER" |
|
Safety | "SAFETY" |
खत्म होने की वजह
उम्मीदवार की चुनाव प्रक्रिया की वजह.
हस्ताक्षर:
export declare enum FinishReason
इन्युमेशन सदस्य
सदस्य | वैल्यू | ब्यौरा |
---|---|---|
समाप्त करें | "FINISH_REASON_UNSPECIFIED" |
|
MAX_TOKENS | "MAX_TOKENS" |
|
अन्य | "OTHER" |
|
सुझाव | "RECITATION" |
|
Safety | "SAFETY" |
|
रोकें | "STOP" |
फ़ंक्शन CallingMode
हस्ताक्षर:
export declare enum FunctionCallingMode
इन्युमेशन सदस्य
सदस्य | वैल्यू | ब्यौरा |
---|---|---|
कोई भी | "ANY" |
|
AUTO | "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" |
स्ट्रिंग का टाइप. |
HarmBlockMethod
हस्ताक्षर:
export declare enum HarmBlockMethod
इन्युमेशन सदस्य
सदस्य | वैल्यू | ब्यौरा |
---|---|---|
HARM_BLOCK_METHOD_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
संभावना | "PROBABILITY" |
|
गंभीरता | "SEVERITY" |
HarmBlockथ्रेशोल्ड
वह थ्रेशोल्ड जिससे ज़्यादा होने पर किसी सूचना या उम्मीदवार को ब्लॉक किया जाएगा.
हस्ताक्षर:
export declare enum HarmBlockThreshold
इन्युमेशन सदस्य
सदस्य | वैल्यू | ब्यौरा |
---|---|---|
ब्लॉक_low_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
ब्लॉक_MEDIUM_AND_ABOVE | "BLOCK_MEDIUM_AND_ABOVE" |
|
ब्लॉक_NONE | "BLOCK_NONE" |
|
ब्लॉक_ONLY_हाई | "BLOCK_ONLY_HIGH" |
|
HARM_BLOCK_METRIC_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" |
|
HARM_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_UNSPECIFIED | "HARM_SEVERITY_UNSPECIFIED" |