एम्बेड करना, टेक्स्ट इनपुट का एक संख्यात्मक निरूपण होता है, जिससे इस्तेमाल के कई अनूठे मामले सामने आते हैं. जैसे, क्लस्टरिंग, समानता का मेज़रमेंट, और जानकारी वापस पाना. इस बारे में जानने के लिए, एम्बेड करने से जुड़ी गाइड देखें.
तरीका: models.embedContent
यह फ़ंक्शन, दिए गए Gemini Embedding मॉडल का इस्तेमाल करके, इनपुट Content
से टेक्स्ट एम्बेडिंग वेक्टर जनरेट करता है.
एंडपॉइंट
पोस्ट https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContentपाथ पैरामीटर
model
string
ज़रूरी है. मॉडल के संसाधन का नाम. यह मॉडल के लिए आईडी के तौर पर काम करता है.
यह नाम, models.list
तरीके से मिले मॉडल के नाम से मेल खाना चाहिए.
फ़ॉर्मैट: models/{model}
यह models/{model}
का रूप लेता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में यह डेटा होता है:
content
object (Content
)
ज़रूरी है. एम्बेड किया जाने वाला कॉन्टेंट. सिर्फ़ parts.text
फ़ील्ड की गिनती की जाएगी.
taskType
enum (TaskType
)
ज़रूरी नहीं. ज़रूरी नहीं कि एम्बेड का इस्तेमाल किस तरह के टास्क के लिए किया जाए. इसे सिर्फ़ models/embedding-001
के लिए सेट किया जा सकता है.
title
string
ज़रूरी नहीं. टेक्स्ट के लिए वैकल्पिक टाइटल. यह सिर्फ़ तब लागू होता है, जब TaskType RETRIEVAL_DOCUMENT
पर सेट हो.
ध्यान दें: RETRIEVAL_DOCUMENT
के लिए title
तय करने से, वापस पाने के लिए बेहतर क्वालिटी का एम्बेड होता है.
outputDimensionality
integer
ज़रूरी नहीं. आउटपुट एम्बेड करने के लिए, डाइमेंशन को कम करने का विकल्प. अगर यह सेट है, तो आउटपुट एम्बेड करने में ज़्यादा वैल्यू होने पर, आखिर में मौजूद वैल्यू काट दी जाती हैं. यह सुविधा, सिर्फ़ 2024 से नए मॉडल पर काम करती है. पुराने मॉडल (models/embedding-001
) का इस्तेमाल करने पर, यह वैल्यू सेट नहीं की जा सकती.
अनुरोध का उदाहरण
Python
Node.js
शेल
जवाब का मुख्य भाग
EmbedContentRequest
पर दिया गया जवाब.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
embedding
object (ContentEmbedding
)
सिर्फ़ आउटपुट के लिए. इनपुट कॉन्टेंट से जनरेट किया गया एम्बेड.
JSON के काेड में दिखाना |
---|
{
"embedding": {
object ( |
तरीका: Model.batchEmbedContents
- एंडपॉइंट
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- अनुरोध का उदाहरण
- EmbedContentRequest
यह इनपुट Content
से कई एम्बेडिंग वैक्टर जनरेट करता है. इनमें EmbedContentRequest
ऑब्जेक्ट के तौर पर दिखाई गई स्ट्रिंग का एक बैच होता है.
एंडपॉइंट
पोस्ट https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContentsपाथ पैरामीटर
model
string
ज़रूरी है. मॉडल के संसाधन का नाम. यह मॉडल के लिए आईडी के तौर पर काम करता है.
यह नाम, models.list
तरीके से मिले मॉडल के नाम से मेल खाना चाहिए.
फ़ॉर्मैट: models/{model}
यह models/{model}
का रूप लेता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में यह डेटा होता है:
requests[]
object (EmbedContentRequest
)
ज़रूरी है. बैच के लिए अनुरोध एम्बेड करें. इनमें से हर अनुरोध के मॉडल को, बताए गए BatchEmbedContentsRequest.model
मॉडल से मेल खाना चाहिए.
अनुरोध का उदाहरण
Python
Node.js
शेल
जवाब का मुख्य भाग
BatchEmbedContentsRequest
का जवाब.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
embeddings[]
object (ContentEmbedding
)
सिर्फ़ आउटपुट के लिए. हर अनुरोध को एम्बेड करना, उसी क्रम में करना जैसा बैच अनुरोध में दिया गया है.
JSON के काेड में दिखाना |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
एम्बेड किए जाने वाले मॉडल के लिए, Content
शामिल करने का अनुरोध करें.
model
string
ज़रूरी है. मॉडल के संसाधन का नाम. यह मॉडल के लिए आईडी के तौर पर काम करता है.
यह नाम, models.list
तरीके से मिले मॉडल के नाम से मेल खाना चाहिए.
फ़ॉर्मैट: models/{model}
content
object (Content
)
ज़रूरी है. एम्बेड किया जाने वाला कॉन्टेंट. सिर्फ़ parts.text
फ़ील्ड की गिनती की जाएगी.
taskType
enum (TaskType
)
ज़रूरी नहीं. ज़रूरी नहीं कि एम्बेड का इस्तेमाल किस तरह के टास्क के लिए किया जाए. इसे सिर्फ़ models/embedding-001
के लिए सेट किया जा सकता है.
title
string
ज़रूरी नहीं. टेक्स्ट के लिए वैकल्पिक टाइटल. यह सिर्फ़ तब लागू होता है, जब TaskType RETRIEVAL_DOCUMENT
पर सेट हो.
ध्यान दें: RETRIEVAL_DOCUMENT
के लिए title
तय करने से, वापस पाने के लिए बेहतर क्वालिटी का एम्बेड होता है.
outputDimensionality
integer
ज़रूरी नहीं. आउटपुट एम्बेड करने के लिए, डाइमेंशन को कम करने का विकल्प. अगर सेट किया जाता है, तो आउटपुट एम्बेड में बहुत ज़्यादा वैल्यू को आखिर से काट दिया जाता है. यह सुविधा, सिर्फ़ 2024 से नए मॉडल पर काम करती है. पुराने मॉडल (models/embedding-001
) का इस्तेमाल करने पर, यह वैल्यू सेट नहीं की जा सकती.
ContentEmbedding
एम्बेड करने के लिए इस्तेमाल होने वाले फ़्लोट की सूची.
values[]
number
एम्बेड करने वाली वैल्यू.
JSON के काेड में दिखाना |
---|
{ "values": [ number ] } |
TaskType
टास्क का वह टाइप जिसके लिए एम्बेड करने की सुविधा का इस्तेमाल किया जाएगा.
Enums | |
---|---|
TASK_TYPE_UNSPECIFIED |
वैल्यू को अनसेट करें, जो अन्य ईनम वैल्यू में से किसी एक पर डिफ़ॉल्ट होगा. |
RETRIEVAL_QUERY |
तय करता है कि दिया गया टेक्स्ट, खोज/वापस पाने की सेटिंग में क्वेरी है. |
RETRIEVAL_DOCUMENT |
यह बताता है कि दिया गया टेक्स्ट, खोजे जा रहे कॉर्पस का दस्तावेज़ है. |
SEMANTIC_SIMILARITY |
इससे पता चलता है कि दिए गए टेक्स्ट का इस्तेमाल एसटीएस के लिए किया जाएगा. |
CLASSIFICATION |
इससे पता चलता है कि दिए गए टेक्स्ट की कैटगरी तय की जाएगी. |
CLUSTERING |
इससे पता चलता है कि एम्बेड करने की सुविधा का इस्तेमाल, क्लस्टर बनाने के लिए किया जाएगा. |
QUESTION_ANSWERING |
इससे पता चलता है कि दिए गए टेक्स्ट का इस्तेमाल, सवाल का जवाब देने के लिए किया जाएगा. |
FACT_VERIFICATION |
इससे पता चलता है कि दिए गए टेक्स्ट का इस्तेमाल, तथ्यों की पुष्टि करने के लिए किया जाएगा. |