Gemini Webhooks API

वेबहुक की मदद से, Gemini API आपके सर्वर पर रीयल-टाइम में सूचनाएं भेज सकता है. ऐसा तब होता है, जब एसिंक्रोनस या लंबे समय तक चलने वाली कार्रवाइयां (एलआरओ) पूरी हो जाती हैं. इससे स्टेटस अपडेट के लिए, एपीआई को पोल करने की ज़रूरत नहीं पड़ती. साथ ही, इंतज़ार का समय और ओवरहेड कम हो जाता है.

मार्कडाउन के तौर पर देखें OpenAPI की खास जानकारी देखें

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

यह नया वेबहुक बनाता है.

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

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

name string  (ज़रूरी नहीं)

ज़रूरी नहीं. उपयोगकर्ता की ओर से दिया गया वेबुक का नाम.

subscribed_events array (enum (string))  (ज़रूरी है)

ज़रूरी है. वे इवेंट जिनके लिए वेबुक को सदस्यता मिली है. उपलब्ध इवेंट: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

इस्तेमाल की जा सकने वाली वैल्यू:

  • batch.succeeded

    बैच प्रोसेसिंग पूरी हो गई है.

  • batch.expired

    बैच को 48 घंटे के अंदर प्रोसेस नहीं किया गया है.

  • batch.failed

    बैच जॉब पूरा नहीं हो सका.

  • interaction.requires_action

    इंटरैक्शन के लिए कार्रवाई की ज़रूरत होती है. जैसे, फ़ंक्शन कॉल करना.

  • interaction.completed

    इंटरैक्शन पूरा हुआ.

  • interaction.failed

    इंटरैक्शन पूरा नहीं किया जा सका.

  • video.generated

    वीडियो जनरेट हो गया है.

uri string  (ज़रूरी है)

ज़रूरी है. वह यूआरआई जिस पर वेबहुक इवेंट भेजे जाएंगे.

जवाब

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

create_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक बनाए जाने का टाइमस्टैंप.

id string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक का आईडी.

name string  (ज़रूरी नहीं)

ज़रूरी नहीं. उपयोगकर्ता की ओर से दिया गया वेबुक का नाम.

new_signing_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक के लिए नया हस्ताक्षर करने वाला सीक्रेट. यह सिर्फ़ इकाई बनाते समय अपने-आप भर जाता है.

signing_secrets array (SigningSecret)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. इस वेबुक से जुड़े साइनिंग सीक्रेट.

यह एक हस्ताक्षर करने की सीक्रेट कुंजी होती है. इसका इस्तेमाल वेबहुक पेलोड की पुष्टि करने के लिए किया जाता है.

फ़ील्ड

expire_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट के खत्म होने की तारीख.

truncated_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट का छोटा किया गया वर्शन.

state enum (string)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबबुक की स्थिति.

इस्तेमाल की जा सकने वाली वैल्यू:

  • enabled

    वेबहुक चालू है.

  • disabled

    उपयोगकर्ता ने वेबुक को बंद कर दिया है.

  • disabled_due_to_failed_deliveries

    डिलिवरी नहीं हो पाने की वजह से, वेबुक बंद कर दिया गया है.

subscribed_events array (enum (string))  (optional)

ज़रूरी है. वे इवेंट जिनके लिए वेबुक को सदस्यता मिली है. उपलब्ध इवेंट: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

इस्तेमाल की जा सकने वाली वैल्यू:

  • batch.succeeded

    बैच प्रोसेसिंग पूरी हो गई है.

  • batch.expired

    बैच को 48 घंटे के अंदर प्रोसेस नहीं किया गया है.

  • batch.failed

    बैच जॉब पूरा नहीं हो सका.

  • interaction.requires_action

    इंटरैक्शन के लिए कार्रवाई की ज़रूरत होती है. जैसे, फ़ंक्शन कॉल करना.

  • interaction.completed

    इंटरैक्शन पूरा हुआ.

  • interaction.failed

    इंटरैक्शन पूरा नहीं किया जा सका.

  • video.generated

    वीडियो जनरेट हो गया है.

update_time string  (optional)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब वेबुक को पिछली बार अपडेट किया गया था.

uri string  (ज़रूरी नहीं)

ज़रूरी है. वह यूआरआई जिस पर वेबहुक इवेंट भेजे जाएंगे.

उदाहरण

प्रतिक्रिया का उदाहरण

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

यह वेबहुक को पिंग इवेंट भेजता है.

पाथ / क्वेरी पैरामीटर

id string  (ज़रूरी है)

ज़रूरी है. जिस वेबुक को पिंग करना है उसका आईडी. फ़ॉर्मैट: `{webhook_id}`

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

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

जवाब

अगर अनुरोध पूरा हो जाता है, तो जवाब में कोई डेटा नहीं होता.

उदाहरण

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

यह कुकी, वेबुक के लिए हस्ताक्षर करने का नया सीक्रेट जनरेट करती है.

पाथ / क्वेरी पैरामीटर

id string  (ज़रूरी है)

ज़रूरी है. उस वेबहुक का आईडी जिसके लिए हस्ताक्षर करने का सीक्रेट जनरेट करना है. फ़ॉर्मैट: `{webhook_id}`

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

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

revocation_behavior enum (string)  (optional)

ज़रूरी नहीं. पिछली साइनिंग की गोपनीय जानकारी को रद्द करने का तरीका.

इस्तेमाल की जा सकने वाली वैल्यू:

  • revoke_previous_secrets_after_h24

    एक नया साइनिंग सीक्रेट जनरेट करें और 24 घंटे बाद, पिछले सभी सीक्रेट रद्द करें. माइग्रेशन के लिए डिफ़ॉल्ट और सबसे सुरक्षित विकल्प.

  • revoke_previous_secrets_immediately

    पिछले सभी सीक्रेट तुरंत रद्द कर दो. इसका इस्तेमाल सावधानी से करें, क्योंकि इससे मौजूदा सूचनाएं रुक सकती हैं.

जवाब

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

secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हाल ही में जनरेट किया गया साइनिंग सीक्रेट.

उदाहरण

प्रतिक्रिया का उदाहरण

{
  "secret": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

यह कुकी, सभी वेबहुक की सूची बनाती है.

पाथ / क्वेरी पैरामीटर

page_size integer  (ज़रूरी नहीं)

ज़रूरी नहीं. ज़्यादा से ज़्यादा वेबहुक वापस लाने की संख्या. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 50 वेबुक वापस भेजे जाएंगे. इसकी ज़्यादा से ज़्यादा वैल्यू 1,000 हो सकती है.

page_token string  (optional)

ज़रूरी नहीं. यह एक पेज टोकन है, जो `ListWebhooks` को किए गए पिछले कॉल से मिला है. अगला पेज पाने के लिए, यह जानकारी दें.

जवाब

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

next_page_token string  (ज़रूरी नहीं)

यह एक टोकन है. इसे `page_token` के तौर पर भेजा जा सकता है, ताकि अगला पेज वापस पाया जा सके. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होता.

webhooks array (Webhook)  (ज़रूरी नहीं)

वेबहुक.

उदाहरण

प्रतिक्रिया का उदाहरण

{
  "next_page_token": "string",
  "webhooks": [
    {
      "create_time": "string",
      "id": "string",
      "name": "string",
      "new_signing_secret": "string",
      "signing_secrets": [
        {
          "expire_time": "string",
          "truncated_secret": "string"
        }
      ],
      "state": "enabled",
      "subscribed_events": [
        "batch.succeeded"
      ],
      "update_time": "string",
      "uri": "string"
    }
  ]
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

किसी खास वेबहुक को ऐक्सेस करता है.

पाथ / क्वेरी पैरामीटर

id string  (ज़रूरी है)

ज़रूरी है. जिस वेबहुक को वापस पाना है उसका आईडी.

जवाब

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

create_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक बनाए जाने का टाइमस्टैंप.

id string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक का आईडी.

name string  (ज़रूरी नहीं)

ज़रूरी नहीं. उपयोगकर्ता की ओर से दिया गया वेबुक का नाम.

new_signing_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक के लिए नया हस्ताक्षर करने वाला सीक्रेट. यह सिर्फ़ इकाई बनाते समय अपने-आप भर जाता है.

signing_secrets array (SigningSecret)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. इस वेबुक से जुड़े साइनिंग सीक्रेट.

यह एक हस्ताक्षर करने की सीक्रेट कुंजी होती है. इसका इस्तेमाल वेबहुक पेलोड की पुष्टि करने के लिए किया जाता है.

फ़ील्ड

expire_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट के खत्म होने की तारीख.

truncated_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट का छोटा किया गया वर्शन.

state enum (string)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबबुक की स्थिति.

इस्तेमाल की जा सकने वाली वैल्यू:

  • enabled

    वेबहुक चालू है.

  • disabled

    उपयोगकर्ता ने वेबुक को बंद कर दिया है.

  • disabled_due_to_failed_deliveries

    डिलिवरी नहीं हो पाने की वजह से, वेबुक बंद कर दिया गया है.

subscribed_events array (enum (string))  (optional)

ज़रूरी है. वे इवेंट जिनके लिए वेबुक को सदस्यता मिली है. उपलब्ध इवेंट: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

इस्तेमाल की जा सकने वाली वैल्यू:

  • batch.succeeded

    बैच प्रोसेसिंग पूरी हो गई है.

  • batch.expired

    बैच को 48 घंटे के अंदर प्रोसेस नहीं किया गया है.

  • batch.failed

    बैच जॉब पूरा नहीं हो सका.

  • interaction.requires_action

    इंटरैक्शन के लिए कार्रवाई की ज़रूरत होती है. जैसे, फ़ंक्शन कॉल करना.

  • interaction.completed

    इंटरैक्शन पूरा हुआ.

  • interaction.failed

    इंटरैक्शन पूरा नहीं किया जा सका.

  • video.generated

    वीडियो जनरेट हो गया है.

update_time string  (optional)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब वेबुक को पिछली बार अपडेट किया गया था.

uri string  (ज़रूरी नहीं)

ज़रूरी है. वह यूआरआई जिस पर वेबहुक इवेंट भेजे जाएंगे.

उदाहरण

प्रतिक्रिया का उदाहरण

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

यह कुकी, मौजूदा वेबुक को अपडेट करती है.

पाथ / क्वेरी पैरामीटर

id string  (ज़रूरी है)

ज़रूरी है. अपडेट किए जाने वाले वेबहुक का आईडी.

update_mask string  (optional)

ज़रूरी नहीं. अपडेट किए जाने वाले फ़ील्ड की सूची.

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

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

name string  (ज़रूरी नहीं)

ज़रूरी नहीं. उपयोगकर्ता की ओर से दिया गया वेबुक का नाम.

state enum (string)  (ज़रूरी नहीं)

ज़रूरी नहीं. वेबबुक की स्थिति.

इस्तेमाल की जा सकने वाली वैल्यू:

  • enabled

    वेबहुक चालू है.

  • disabled

    उपयोगकर्ता ने वेबुक को बंद कर दिया है.

  • disabled_due_to_failed_deliveries

    डिलिवरी नहीं हो पाने की वजह से, वेबुक बंद कर दिया गया है.

subscribed_events array (enum (string))  (optional)

ज़रूरी नहीं. वे इवेंट जिनके लिए वेबुक को सदस्यता मिली है. उपलब्ध इवेंट: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

इस्तेमाल की जा सकने वाली वैल्यू:

  • batch.succeeded

    बैच प्रोसेसिंग पूरी हो गई है.

  • batch.expired

    बैच को 48 घंटे के अंदर प्रोसेस नहीं किया गया है.

  • batch.failed

    बैच जॉब पूरा नहीं हो सका.

  • interaction.requires_action

    इंटरैक्शन के लिए कार्रवाई की ज़रूरत होती है. जैसे, फ़ंक्शन कॉल करना.

  • interaction.completed

    इंटरैक्शन पूरा हुआ.

  • interaction.failed

    इंटरैक्शन पूरा नहीं किया जा सका.

  • video.generated

    वीडियो जनरेट हो गया है.

uri string  (ज़रूरी नहीं)

ज़रूरी नहीं. वह यूआरआई जिस पर वेबहुक इवेंट भेजे जाएंगे.

जवाब

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

create_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक बनाए जाने का टाइमस्टैंप.

id string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक का आईडी.

name string  (ज़रूरी नहीं)

ज़रूरी नहीं. उपयोगकर्ता की ओर से दिया गया वेबुक का नाम.

new_signing_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक के लिए नया हस्ताक्षर करने वाला सीक्रेट. यह सिर्फ़ इकाई बनाते समय अपने-आप भर जाता है.

signing_secrets array (SigningSecret)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. इस वेबुक से जुड़े साइनिंग सीक्रेट.

यह एक हस्ताक्षर करने की सीक्रेट कुंजी होती है. इसका इस्तेमाल वेबहुक पेलोड की पुष्टि करने के लिए किया जाता है.

फ़ील्ड

expire_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट के खत्म होने की तारीख.

truncated_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट का छोटा किया गया वर्शन.

state enum (string)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबबुक की स्थिति.

इस्तेमाल की जा सकने वाली वैल्यू:

  • enabled

    वेबहुक चालू है.

  • disabled

    उपयोगकर्ता ने वेबुक को बंद कर दिया है.

  • disabled_due_to_failed_deliveries

    डिलिवरी नहीं हो पाने की वजह से, वेबुक बंद कर दिया गया है.

subscribed_events array (enum (string))  (optional)

ज़रूरी है. वे इवेंट जिनके लिए वेबुक को सदस्यता मिली है. उपलब्ध इवेंट: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

इस्तेमाल की जा सकने वाली वैल्यू:

  • batch.succeeded

    बैच प्रोसेसिंग पूरी हो गई है.

  • batch.expired

    बैच को 48 घंटे के अंदर प्रोसेस नहीं किया गया है.

  • batch.failed

    बैच जॉब पूरा नहीं हो सका.

  • interaction.requires_action

    इंटरैक्शन के लिए कार्रवाई की ज़रूरत होती है. जैसे, फ़ंक्शन कॉल करना.

  • interaction.completed

    इंटरैक्शन पूरा हुआ.

  • interaction.failed

    इंटरैक्शन पूरा नहीं किया जा सका.

  • video.generated

    वीडियो जनरेट हो गया है.

update_time string  (optional)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब वेबुक को पिछली बार अपडेट किया गया था.

uri string  (ज़रूरी नहीं)

ज़रूरी है. वह यूआरआई जिस पर वेबहुक इवेंट भेजे जाएंगे.

उदाहरण

प्रतिक्रिया का उदाहरण

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

इस तरीके का इस्तेमाल करके, वेबहुक मिटाया जा सकता है.

पाथ / क्वेरी पैरामीटर

id string  (ज़रूरी है)

ज़रूरी है. मिटाने के लिए वेबहुक का आईडी. फ़ॉर्मैट: `{webhook_id}`

जवाब

अगर अनुरोध पूरा हो जाता है, तो जवाब में कोई डेटा नहीं होता.

उदाहरण

संसाधन

वेबहुक

वेबहुक संसाधन.

फ़ील्ड

create_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक बनाए जाने का टाइमस्टैंप.

id string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक का आईडी.

name string  (ज़रूरी नहीं)

ज़रूरी नहीं. उपयोगकर्ता की ओर से दिया गया वेबुक का नाम.

new_signing_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबहुक के लिए नया हस्ताक्षर करने वाला सीक्रेट. यह सिर्फ़ इकाई बनाते समय अपने-आप भर जाता है.

signing_secrets array (SigningSecret)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. इस वेबुक से जुड़े साइनिंग सीक्रेट.

यह एक हस्ताक्षर करने की सीक्रेट कुंजी होती है. इसका इस्तेमाल वेबहुक पेलोड की पुष्टि करने के लिए किया जाता है.

फ़ील्ड

expire_time string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट के खत्म होने की तारीख.

truncated_secret string  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. हस्ताक्षर करने के सीक्रेट का छोटा किया गया वर्शन.

state enum (string)  (ज़रूरी नहीं)

सिर्फ़ आउटपुट के लिए. वेबबुक की स्थिति.

इस्तेमाल की जा सकने वाली वैल्यू:

  • enabled

    वेबहुक चालू है.

  • disabled

    उपयोगकर्ता ने वेबुक को बंद कर दिया है.

  • disabled_due_to_failed_deliveries

    डिलिवरी नहीं हो पाने की वजह से, वेबुक बंद कर दिया गया है.

subscribed_events array (enum (string))  (optional)

ज़रूरी है. वे इवेंट जिनके लिए वेबुक को सदस्यता मिली है. उपलब्ध इवेंट: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

इस्तेमाल की जा सकने वाली वैल्यू:

  • batch.succeeded

    बैच प्रोसेसिंग पूरी हो गई है.

  • batch.expired

    बैच को 48 घंटे के अंदर प्रोसेस नहीं किया गया है.

  • batch.failed

    बैच जॉब पूरा नहीं हो सका.

  • interaction.requires_action

    इंटरैक्शन के लिए कार्रवाई की ज़रूरत होती है. जैसे, फ़ंक्शन कॉल करना.

  • interaction.completed

    इंटरैक्शन पूरा हुआ.

  • interaction.failed

    इंटरैक्शन पूरा नहीं किया जा सका.

  • video.generated

    वीडियो जनरेट हो गया है.

update_time string  (optional)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब वेबुक को पिछली बार अपडेट किया गया था.

uri string  (ज़रूरी नहीं)

ज़रूरी है. वह यूआरआई जिस पर वेबहुक इवेंट भेजे जाएंगे.