Method: models.embedContent

Content इनपुट दिए गए मॉडल से एम्बेडिंग जनरेट करता है.

एचटीटीपी अनुरोध

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:embedContent

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
model

string

ज़रूरी है. मॉडल के संसाधन का नाम. यह मॉडल के लिए एक आईडी के रूप में काम करता है.

यह नाम, models.list तरीके से मिले मॉडल के नाम से मेल खाना चाहिए.

फ़ॉर्मैट: models/{model}

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
फ़ील्ड
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) में इस वैल्यू के बारे में नहीं बताया जा सकता.

जवाब का मुख्य भाग

EmbedContentRequest को दिया गया जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "embedding": {
    object (ContentEmbedding)
  }
}
फ़ील्ड
embedding

object (ContentEmbedding)

सिर्फ़ आउटपुट के लिए. इनपुट कॉन्टेंट से एम्बेड किया गया डेटा.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.