Gemini मॉडल, डिफ़ॉल्ट रूप से जवाबों को बिना किसी स्ट्रक्चर वाले टेक्स्ट के तौर पर दिखाते हैं. हालांकि, इस्तेमाल के कुछ मामलों में स्ट्रक्चर्ड टेक्स्ट (जैसे, JSON या enum) की ज़रूरत होती है. उदाहरण के लिए, हो सकता है कि आपको जवाब का इस्तेमाल अन्य डाउनस्ट्रीम टास्क के लिए करना हो. इसके लिए, एक तय डेटा स्कीमा की ज़रूरत होती है.
यह पक्का करने के लिए कि मॉडल से जनरेट किया गया आउटपुट हमेशा किसी खास स्कीमा के मुताबिक हो, स्कीमा तय की जा सकती है. यह स्कीमा, मॉडल के जवाबों के लिए ब्लूप्रिंट की तरह काम करती है. इसके बाद, मॉडल के आउटपुट से सीधे तौर पर डेटा निकाला जा सकता है. इसके लिए, पोस्ट-प्रोसेसिंग की ज़रूरत कम पड़ती है.
यहां इस्तेमाल के कुछ उदाहरण दिए गए हैं:
पक्का करें कि मॉडल का जवाब, मान्य JSON फ़ॉर्मैट में हो और आपके दिए गए स्कीमा के मुताबिक हो.
उदाहरण के लिए, मॉडल ऐसी रेसिपी के लिए स्ट्रक्चर्ड एंट्री जनरेट कर सकता है जिनमें हमेशा रेसिपी का नाम, सामग्री की सूची, और तरीका शामिल होता है. इसके बाद, इस जानकारी को आसानी से पार्स किया जा सकता है और अपने ऐप्लिकेशन के यूज़र इंटरफ़ेस (यूआई) में दिखाया जा सकता है.यह तय करना कि क्लासिफ़िकेशन के टास्क के दौरान मॉडल कैसे जवाब दे सकता है.
उदाहरण के लिए, मॉडल से टेक्स्ट को लेबल के किसी खास सेट के साथ एनोटेट कराया जा सकता है. जैसे,positiveऔरnegativeजैसे एनम का कोई खास सेट. ऐसा मॉडल के जनरेट किए गए लेबल के बजाय किया जा सकता है. मॉडल के जनरेट किए गए लेबल में अलग-अलग तरह के लेबल शामिल हो सकते हैं. जैसे,good,positive,negativeयाbad.
इस पेज पर, Android ऐप्लिकेशन के लिए हाइब्रिड अनुभवों में स्ट्रक्चर्ड आउटपुट (जैसे कि JSON और enum) जनरेट करने का तरीका बताया गया है.
JSON आउटपुट पर जाएं enum आउटपुट पर जाएं
स्ट्रक्चर्ड आउटपुट के लिए कॉन्फ़िगरेशन
स्ट्रक्चर्ड आउटपुट (जैसे कि JSON और enum) जनरेट करने की सुविधा, डिवाइस पर और क्लाउड पर होस्ट किए गए इन्फ़रेंस, दोनों के लिए उपलब्ध है.
स्ट्रक्चर्ड आउटपुट जनरेट करने के लिए, अपने स्कीमा को सीधे generateObject() पर पास करें.
स्कीमा की ज़रूरी शर्तें, कॉन्फ़िगर किए गए अनुमान मोड पर निर्भर करती हैं:
उपयोगकर्ता के डिवाइस पर और हाइब्रिड अनुमान (
ONLY_ON_DEVICE,PREFER_ON_DEVICE, औरPREFER_IN_CLOUD) के लिए:- इसके लिए, KSP प्रोसेसर के साथ Kotlin
data classपर@Generableएनोटेशन का इस्तेमाल करना ज़रूरी है. मैन्युअल स्कीमा और डायरेक्टenum classएनोटेशन काम नहीं करते. - जब अनुमान लगाने की प्रोसेस उपयोगकर्ता के डिवाइस पर चलती है, तो एसडीके, स्कीमा को उपयोगकर्ता के डिवाइस पर मौजूद मॉडल के लिए अपने-आप शर्तों में बदल देता है. इसके लिए, वह ML Kit Prompt API का इस्तेमाल करता है.
- अगर हाइब्रिड अनुरोध, क्लाउड इन्फ़रेंस पर वापस आ जाता है, तो SDK टूल अपने-आप
responseMimeTypeकोapplication/jsonपर सेट कर देता है. साथ ही, स्कीमा को क्लाउड पर होस्ट किए गए Gemini मॉडल को पास कर देता है.
- इसके लिए, KSP प्रोसेसर के साथ Kotlin
सिर्फ़ क्लाउड पर अनुमान लगाने के लिए (
ONLY_IN_CLOUD):- यह
@Generableएनोटेशन (सुझाया गया) और मैन्युअल स्कीमा, दोनों के साथ काम करता है. मैन्युअल स्कीमा,JsonSchemaहेल्पर तरीकों का इस्तेमाल करके बनाया जाता है. - SDK टूल,
responseMimeTypeकोapplication/jsonपर अपने-आप सेट करता है. साथ ही, स्कीमा को क्लाउड पर होस्ट किए गए Gemini मॉडल को पास करता है.
- यह
शुरू करने से पहले
|
इस पेज पर, सेवा देने वाली कंपनी के हिसाब से कॉन्टेंट और कोड देखने के लिए, Gemini API पर क्लिक करें. |
स्ट्रक्चर्ड आउटपुट जनरेट करने से पहले, पक्का करें कि आपने यह सेटअप पूरा कर लिया हो:
हाइब्रिड अनुभव बनाने के लिए, शुरुआती गाइड पढ़ें. इसमें Firebase प्रोजेक्ट सेट अप करने, उपयोगकर्ता के डिवाइस पर मौजूद मॉडल डाउनलोड करने, और App Check को कॉन्फ़िगर करने के बारे में बताया गया है.
Kotlin Symbol Processing (KSP) प्लगिन को कॉन्फ़िगर करें और अपने ऐप्लिकेशन में Firebase AI KSP डिपेंडेंसी जोड़ें.
अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (जैसे कि
<project>/<app-module>/build.gradle.kts) में, KSP प्लगिन, Kotlin Serialization प्लगिन, और ज़रूरी डिपेंडेंसी जोड़ें:plugins { // ... other plugins id("com.google.gms.google-services") id("com.google.devtools.ksp") version "LATEST_VERSION" id("org.jetbrains.kotlin.plugin.serialization") version "LATEST_VERSION" } dependencies { // ... other androidx dependencies // Add the dependencies for the Firebase AI Logic and App Check libraries. implementation("com.google.firebase:firebase-ai:17.17.0") implementation("com.google.firebase:firebase-ai-ondevice:16.0.0-beta05") implementation("com.google.firebase:firebase-appcheck-debug:19.4.1") // Add the Firebase AI KSP processor for schema generation. ksp("com.google.firebase:firebase-ai-ksp-processor:16.0.2") // (Optional) Add kotlinx.serialization JSON library for object decoding. implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:LATEST_VERSION") }
JSON आउटपुट पर जाएं enum आउटपुट पर जाएं
JSON फ़ॉर्मैट में आउटपुट
यहां दिए गए उदाहरणों में, JSON फ़ॉर्मैट में आउटपुट दिखाने वाले सामान्य उदाहरण को हाइब्रिड इन्फ़रेंस (उदाहरण के लिए, PREFER_ON_DEVICE) के हिसाब से बदला गया है.
इन उदाहरणों में, मॉडल ने एक काल्पनिक कहानी के लिए, किरदार की प्रोफ़ाइल की सूची जनरेट की है. इसमें नाम, उम्र, प्रजाति, और वैकल्पिक ऐक्सेसरी जैसे स्ट्रक्चर्ड एट्रिब्यूट शामिल हैं.
इनमें से किसी भी तरीके का इस्तेमाल करके, जवाब के स्कीमा तय किए जा सकते हैं:
केएसपी एनोटेशन (
@Generableऔर@Guide)- यह सभी अनुमान वाले मोड के साथ काम करता है. साथ ही, उपयोगकर्ता के डिवाइस पर और हाइब्रिड तरीके से अनुमान लगाने के लिए ज़रूरी है. खास तौर पर,
ONLY_ON_DEVICE,PREFER_ON_DEVICE, औरPREFER_IN_CLOUDके लिए. - कंपाइल टाइम पर स्कीमा अपने-आप जनरेट करने के लिए, Kotlin डेटा क्लास तय करें. साथ ही,
getObject()का इस्तेमाल करके, रिस्पॉन्स को सीधे तौर पर टाइप किए गए ऑब्जेक्ट में बदलें.
- यह सभी अनुमान वाले मोड के साथ काम करता है. साथ ही, उपयोगकर्ता के डिवाइस पर और हाइब्रिड तरीके से अनुमान लगाने के लिए ज़रूरी है. खास तौर पर,
मैन्युअल
JsonSchemaहेल्पर के तरीके- यह सुविधा, क्लाउड-आधारित अनुमान (खास तौर पर,
ONLY_IN_CLOUD) के लिए सिर्फ़ उपलब्ध है. - KSP प्रोसेसर का इस्तेमाल किए बिना, कोड में मैन्युअल तरीके से
JsonSchemaबनाएं. साथ ही,response.response.textसे रॉ JSON स्ट्रिंग पढ़ें.
- यह सुविधा, क्लाउड-आधारित अनुमान (खास तौर पर,
पहला उदाहरण: केएसपी के साथ @Generable और @Guide एनोटेशन का इस्तेमाल करना
@Serializable और @Generable एनोटेशन के साथ Kotlin data class को परिभाषित करें.
प्रॉपर्टी पर @Guide एनोटेशन का इस्तेमाल करके, मॉडल को ब्यौरे, वैल्यू की सीमाएं या आइटम की पाबंदियां दें.
यह तरीका, अनुमान लगाने के सभी मोड के लिए काम करता है. साथ ही, उपयोगकर्ता के डिवाइस पर और हाइब्रिड अनुभवों (खास तौर पर, ONLY_ON_DEVICE, PREFER_ON_DEVICE, और PREFER_IN_CLOUD) के लिए यह ज़रूरी है.
|
इस सैंपल को आज़माने से पहले, इस गाइड के शुरू करने से पहले सेक्शन में दिया गया तरीका अपनाकर, अपना प्रोजेक्ट और ऐप्लिकेशन सेट अप करें. उस सेक्शन में, आपको अपनी चुनी गई Gemini API सेवा देने वाली कंपनी के लिए एक बटन पर क्लिक करना होगा, ताकि आपको इस पेज पर सेवा देने वाली कंपनी के हिसाब से कॉन्टेंट दिखे. |
import com.google.firebase.Firebase
import com.google.firebase.ai.type.GenerativeBackend
import com.google.firebase.ai.InferenceMode
import com.google.firebase.ai.OnDeviceConfig
import com.google.firebase.ai.annotations.Generable
import com.google.firebase.ai.annotations.Guide
import com.google.firebase.ai.ai
import kotlinx.serialization.Serializable
// Define data classes representing the schema, annotated with @Serializable and @Generable.
// You can provide descriptions on @Generable and @Guide to guide the model's output.
@Serializable
@Generable(description = "A character profile for a fantasy story")
data class Character(
val name: String,
val age: Int,
val species: String,
// Use @Guide to add property descriptions, value bounds (minimum/maximum), or formats.
// Properties with default values or nullable types are treated as optional in the schema.
@Guide(description = "An accessory the character wears or carries")
val accessory: String? = null
) {
// An empty companion object is required for KSP to generate the firebaseAISchema() extension.
companion object
}
@Serializable
@Generable(description = "A list of character profiles")
data class CharacterList(
// Use minItems or maxItems to specify collection size bounds for the model.
@Guide(description = "List of characters", minItems = 1)
val characters: List<Character>
) {
// An empty companion object is required for KSP to generate the firebaseAISchema() extension.
companion object
}
// Initialize the Gemini Developer API backend service.
// Create a GenerativeModel instance configured for hybrid inference (like PREFER_ON_DEVICE).
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
.generativeModel(
modelName = "CLOUD_MODEL_NAME",
onDeviceConfig = OnDeviceConfig(mode = InferenceMode.INFERENCE_MODE)
)
// Obtain the schema generated by KSP via the firebaseAISchema() extension.
val schema = CharacterList.firebaseAISchema()
val prompt = "Create profiles for some characters for a fantasy story."
// Generate the structured object (the SDK applies the schema to on-device or cloud models).
val response = model.generateObject(schema, prompt)
// Access the strongly-typed deserialized object directly via getObject().
val characterList: CharacterList? = response.getObject()
characterList?.characters?.forEach { character ->
println("Name: ${character.name}, Species: ${character.species}, Age: ${character.age}")
println("Accessory: ${character.accessory ?: "None"}")
}
दूसरा उदाहरण: मैन्युअल JsonSchema हेल्पर के तरीकों का इस्तेमाल करना
अगर आपका ऐप्लिकेशन सिर्फ़ क्लाउड-आधारित इन्फ़्रेंस (खास तौर पर, ONLY_IN_CLOUD) का इस्तेमाल कर रहा है, तो Firebase AI Logic SDK टूल की ओर से उपलब्ध कराए गए हेल्पर तरीकों का इस्तेमाल करके, मैन्युअल तरीके से JsonSchema बनाया जा सकता है.
|
इस सैंपल को आज़माने से पहले, इस गाइड के शुरू करने से पहले सेक्शन में दिए गए निर्देशों को पूरा करें. इससे आपको अपना प्रोजेक्ट और ऐप्लिकेशन सेट अप करने में मदद मिलेगी. उस सेक्शन में, आपको Gemini API सेवा देने वाली कंपनी के लिए एक बटन पर भी क्लिक करना होगा, ताकि आपको इस पेज पर सेवा देने वाली कंपनी के हिसाब से कॉन्टेंट दिखे. |
import com.google.firebase.Firebase
import com.google.firebase.ai.type.GenerativeBackend
import com.google.firebase.ai.InferenceMode
import com.google.firebase.ai.OnDeviceConfig
import com.google.firebase.ai.ai
import com.google.firebase.ai.type.JsonSchema
// Define the schema manually using JsonSchema helper methods.
// Properties are required by default unless specified in optionalProperties.
val jsonSchema = JsonSchema.obj(
properties = mapOf(
"characters" to JsonSchema.array(
items = JsonSchema.obj(
properties = mapOf(
"name" to JsonSchema.string(),
"accessory" to JsonSchema.string(),
"age" to JsonSchema.integer(),
"species" to JsonSchema.string()
),
optionalProperties = listOf("accessory")
)
)
)
)
// Initialize the Gemini Developer API backend service.
// Manual schemas are only supported for cloud-based inference (specifically, ONLY_IN_CLOUD).
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
.generativeModel(
modelName = "CLOUD_MODEL_NAME",
onDeviceConfig = OnDeviceConfig(mode = InferenceMode.ONLY_IN_CLOUD)
)
// Call generateObject() with the manual schema and prompt.
val response = model.generateObject(
jsonSchema,
"Create profiles for some characters for a fantasy story."
)
// Access the generated JSON string conforming to the schema from response.response.text.
println(response.response.text)
Enum आउटपुट
यहां दिए गए उदाहरणों में, सामान्य enum आउटपुट के उदाहरण को हाइब्रिड इन्फ़्रेंस (जैसे, PREFER_ON_DEVICE) के हिसाब से बदला गया है.
इन उदाहरणों में, मॉडल ने फ़िल्म की जानकारी को इस तरह से कैटगरी में बांटा है कि उसने पहले से तय की गई सूची में से सिर्फ़ एक शैली चुनी है. जैसे, drama, comedy या documentary.
इनमें से किसी भी तरीके का इस्तेमाल करके, जवाब के स्कीमा तय किए जा सकते हैं:
-
- यह सभी अनुमान वाले मोड के साथ काम करता है. साथ ही, उपयोगकर्ता के डिवाइस पर और हाइब्रिड तरीके से अनुमान लगाने के लिए ज़रूरी है. खास तौर पर,
ONLY_ON_DEVICE,PREFER_ON_DEVICE, औरPREFER_IN_CLOUDके लिए. - स्केमा को अपने-आप जनरेट करने के लिए, Kotlin
data classमें रैप किए गए enum को तय करें. साथ ही,getObject()का इस्तेमाल करके, जवाबों को सीधे तौर पर टाइप किए गए ऑब्जेक्ट में डीसीरियलाइज़ करें.
- यह सभी अनुमान वाले मोड के साथ काम करता है. साथ ही, उपयोगकर्ता के डिवाइस पर और हाइब्रिड तरीके से अनुमान लगाने के लिए ज़रूरी है. खास तौर पर,
मैन्युअल
JsonSchemaहेल्पर के तरीके- यह सुविधा, क्लाउड-आधारित अनुमान (खास तौर पर,
ONLY_IN_CLOUD) के लिए सिर्फ़ उपलब्ध है. - KSP प्रोसेसर का इस्तेमाल किए बिना,
JsonSchema.enumeration()का इस्तेमाल करके मैन्युअल तरीके से कोई enumJsonSchemaबनाएं. साथ ही,response.response.textसे चुनी गई स्ट्रिंग को पढ़ें.
- यह सुविधा, क्लाउड-आधारित अनुमान (खास तौर पर,
उदाहरण 1: केएसपी के साथ @Generable एनोटेशन का इस्तेमाल करना
अनुमति वाली वैल्यू दिखाने वाले enum class को तय करें. इसके बाद, इसे @Serializable और @Generable एनोटेशन वाले Kotlin data class के अंदर प्रॉपर्टी के तौर पर रैप करें.
यह तरीका, अनुमान लगाने के सभी मोड के लिए काम करता है. साथ ही, उपयोगकर्ता के डिवाइस पर और हाइब्रिड अनुभवों (खास तौर पर, ONLY_ON_DEVICE, PREFER_ON_DEVICE, और PREFER_IN_CLOUD) के लिए यह ज़रूरी है.
|
इस सैंपल को आज़माने से पहले, इस गाइड के शुरू करने से पहले सेक्शन में दिए गए निर्देशों को पूरा करें. इससे आपको अपना प्रोजेक्ट और ऐप्लिकेशन सेट अप करने में मदद मिलेगी. उस सेक्शन में, आपको Gemini API सेवा देने वाली कंपनी के लिए एक बटन पर भी क्लिक करना होगा, ताकि आपको इस पेज पर सेवा देने वाली कंपनी के हिसाब से कॉन्टेंट दिखे. |
import com.google.firebase.Firebase
import com.google.firebase.ai.type.GenerativeBackend
import com.google.firebase.ai.InferenceMode
import com.google.firebase.ai.OnDeviceConfig
import com.google.firebase.ai.annotations.Generable
import com.google.firebase.ai.annotations.Guide
import com.google.firebase.ai.ai
import kotlinx.serialization.Serializable
// Define an enum class representing the allowed options.
@Serializable
enum class FilmGenre {
DRAMA,
COMEDY,
DOCUMENTARY
}
// Wrap the enum in a data class annotated with @Serializable and @Generable.
// On-device inference requires an @Generable data class.
// Direct enum annotations are not supported on-device.
@Serializable
@Generable(description = "The classification result for the film")
data class FilmClassification(
@Guide(description = "The genre of the film")
val genre: FilmGenre
) {
// An empty companion object is required for KSP to generate the firebaseAISchema() extension.
companion object
}
// Initialize the Gemini Developer API backend service.
// Create a GenerativeModel instance configured for hybrid inference (like PREFER_ON_DEVICE).
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
.generativeModel(
modelName = "CLOUD_MODEL_NAME",
onDeviceConfig = OnDeviceConfig(mode = InferenceMode.INFERENCE_MODE)
)
// Obtain the schema generated by KSP via the firebaseAISchema() extension.
val schema = FilmClassification.firebaseAISchema()
val prompt = """
The film aims to educate and inform viewers about real-life subjects, events, or people.
It offers a factual record of a particular topic by combining interviews, historical footage,
and narration. The primary purpose of a film is to present information and provide insights
into various aspects of reality.
"""
// Generate the structured object (the SDK applies the schema to on-device or cloud models).
val response = model.generateObject(schema, prompt)
// Access the strongly-typed deserialized object and enum value directly via getObject().
val classification: FilmClassification? = response.getObject()
val genre: FilmGenre? = classification?.genre
println("Selected genre: $genre")
दूसरा उदाहरण: मैन्युअल JsonSchema हेल्पर के तरीकों का इस्तेमाल करना
अगर आपका ऐप्लिकेशन सिर्फ़ क्लाउड-आधारित अनुमान (खास तौर पर, ONLY_IN_CLOUD) का इस्तेमाल कर रहा है, तो Firebase AI Logic SDK टूल से मिले हेल्पर तरीकों का इस्तेमाल करके, मैन्युअल तरीके से एक enum JsonSchema बनाया जा सकता है.
|
इस सैंपल को आज़माने से पहले, इस गाइड के शुरू करने से पहले सेक्शन में दिए गए निर्देशों को पूरा करें. इससे आपको अपना प्रोजेक्ट और ऐप्लिकेशन सेट अप करने में मदद मिलेगी. उस सेक्शन में, आपको Gemini API सेवा देने वाली कंपनी के लिए एक बटन पर भी क्लिक करना होगा, ताकि आपको इस पेज पर सेवा देने वाली कंपनी के हिसाब से कॉन्टेंट दिखे. |
import com.google.firebase.Firebase
import com.google.firebase.ai.type.GenerativeBackend
import com.google.firebase.ai.InferenceMode
import com.google.firebase.ai.OnDeviceConfig
import com.google.firebase.ai.ai
import com.google.firebase.ai.type.JsonSchema
// Define an enum schema with allowed string values and a description.
val enumSchema = JsonSchema.enumeration(
values = listOf("drama", "comedy", "documentary"),
description = "The genre of the film"
)
// Initialize the Gemini Developer API backend service.
// Manual schemas are only supported for cloud-based inference (specifically, ONLY_IN_CLOUD).
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
.generativeModel(
modelName = "CLOUD_MODEL_NAME",
onDeviceConfig = OnDeviceConfig(mode = InferenceMode.ONLY_IN_CLOUD)
)
val prompt = """
The film aims to educate and inform viewers about real-life subjects, events, or people.
It offers a factual record of a particular topic by combining interviews, historical footage,
and narration. The primary purpose of a film is to present information and provide insights
into various aspects of reality.
"""
// Call generateObject() with the enum schema and prompt.
val response = model.generateObject(enumSchema, prompt)
// Access the selected enum value string from response.response.text.
println(response.response.text)
Firebase AI Logic के साथ अपने अनुभव के बारे में सुझाव/राय दें या शिकायत करें