वर्कफ़्लो
कोर प्लेटफ़ॉर्मworkflow_definitions_readवर्कफ़्लोकिसी सुविधा के वर्कफ़्लो ऑटोमेशन पढ़ता है: वर्कफ़्लो, किसी एक वर्कफ़्लो का पूरा ग्राफ़, ग्राफ़ में उपयोग किए जा सकने वाले नोड प्रकार, और चुने हुए टेम्पलेट। ग्राफ़ बनाने या संपादित करने से पहले node_types पढ़ें ताकि हर प्रकार और पैरामीटर सुविधा पर मान्य हो।
कार्रवाइयाँ:
- list: वर्कफ़्लो की सूची। हर वर्कफ़्लो, इस जानकारी के साथ कि वह लाइव है या नहीं, उसका प्रकाशित संस्करण, रन की संख्या, अंतिम रन और उसके नोड (id, name, type)। ब्रांड और संगठन के वर्कफ़्लो सूचीबद्ध नहीं होते।
- get: वर्कफ़्लो प्राप्त करें। पूरा ड्राफ़्ट ग्राफ़ (nodes, connections, notes, settings) और meta: active, publishedVersionId और, प्रकाशित होने के बाद, publishedWorkflow, यानी वह ग्राफ़ जो अभी लाइव है। केवल इस सुविधा के वर्कफ़्लो। workflowId आवश्यक है।
- node_types: नोड प्रकार। type, label, category, outputs (शाखाएँ) और inputSchema, यानी भरे जाने वाले पैरामीटर, के साथ पैलेट प्रविष्टियाँ। जब सुविधा में नोड के लिए आवश्यक कोई मॉड्यूल न हो, तो available कारण के साथ false होता है। MCP टूल mcp.
. नोड के रूप में दिखते हैं। - templates: टेम्पलेट। सामान्य ऑटोमेशन के लिए शुरुआती बिंदु, risk और riskNote (लापरवाही से प्रकाशित करने पर क्या गलत हो सकता है), नोड प्रकार, आवश्यक मॉड्यूल, इस सुविधा पर उपलब्धता और एक पूर्वावलोकन ग्राफ़ के साथ। किसी टेम्पलेट को workflow_definitions_write instantiate_template से ग्राफ़ में बदलें।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
limit | integer | प्रति पेज आइटम (डिफ़ॉल्ट 25, अधिकतम 100) (list, node_types, templates) |
cursor | string | पिछले पेज से nextCursor (list, node_types, templates) |
facilityId | string | सुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक। |
workflowId | string | workflow_definitions_read list से वर्कफ़्लो id (get) |
query | string | type, label, विवरण या खोज शब्दों में ढूँढे जाने वाले शब्द (node_types) |
category | string | केवल यह श्रेणी: trigger, action, logic या ai (node_types) |
types | array | वर्णन किए जाने वाले सटीक प्रकार, उदाहरण के लिए आपके द्वारा संपादित किए जा रहे वर्कफ़्लो में मौजूद प्रकार। इसमें वे सेवानिवृत्त प्रकार भी शामिल हैं जिन्हें पैलेट अब नहीं दिखाता; query और category को अनदेखा करता है। (node_types) |
workflow_definitions_writeवर्कफ़्लोकिसी सुविधा के वर्कफ़्लो ऑटोमेशन बनाता है, संपादित करता है, प्रकाशित करता है, रोकता है और हटाता है। निर्माण का क्रम: workflow_definitions_read से node_types पढ़ें, ग्राफ़ बनाएँ (या instantiate_template से शुरू करें), उसे ड्राफ़्ट के रूप में बनाएँ, workflow_runs_write test (सिम्युलेटेड) से आज़माएँ, फिर प्रकाशित करें। ड्राफ़्ट में किए गए संपादन प्रकाशित होने तक लाइव संस्करण को कभी नहीं बदलते।
कार्रवाइयाँ:
- create: वर्कफ़्लो बनाएँ। कम से कम एक नोड वाले पूरे ग्राफ़ से एक नया, निष्क्रिय ड्राफ़्ट सहेजता है; name का डिफ़ॉल्ट "Untitled workflow" है। सत्यापन समस्याएँ नोड विवरण के साथ errors में लौटती हैं। nodes आवश्यक है।
- update: ड्राफ़्ट सहेजें। पूरे ड्राफ़्ट को बदलता है: केवल बदलाव नहीं, हर नोड और कनेक्शन भेजें। आपके प्रकाशित करने तक लाइव संस्करण चलता रहता है। सत्यापन समस्याएँ नोड विवरण के साथ errors में लौटती हैं। workflowId, nodes आवश्यक हैं।
- patch_meta: नाम बदलें। केवल नाम या विवरण बदलता है; ग्राफ़ और लाइव संस्करण वैसे ही रहते हैं। दोनों पहले से मेल खाते हों तो changed false होता है। workflowId आवश्यक है।
- duplicate: प्रतिलिपि बनाएँ। किसी वर्कफ़्लो को नए नोड ids के साथ "
(copy)" नाम के नए ड्राफ़्ट में कॉपी करता है, जो कभी प्रकाशित या सक्रिय नहीं होता। मूल अप्रभावित रहता है। workflowId आवश्यक है। - delete: हटाएँ। वर्कफ़्लो को स्थायी रूप से हटाता है: ड्राफ़्ट, प्रकाशित संस्करण, रन इतिहास और ट्रिगर रूटिंग। set_active false उसे रोकता है पर बनाए रखता है; discard_draft केवल ड्राफ़्ट संपादनों को रीसेट करता है। workflowId आवश्यक है। पुष्टि माँगता है।
- discard_draft: ड्राफ़्ट संपादन रद्द करें। ड्राफ़्ट को अंतिम प्रकाशित संस्करण पर रीसेट करता है और उसके बाद किए गए संपादन हटा देता है। लाइव संस्करण कभी प्रभावित नहीं होता; प्रकाशित संस्करण आवश्यक है। workflowId आवश्यक है। पुष्टि माँगता है।
- publish: प्रकाशित करें। ड्राफ़्ट का सत्यापन करता है, उसे लाइव संस्करण के रूप में सहेजता है और वर्कफ़्लो चालू करता है, ताकि उसके ट्रिगर सक्रिय हों और उसकी कार्रवाइयाँ वास्तव में चलें। चल रहे रन पुराने संस्करण पर पूरे होते हैं। यदि प्रतीक्षा में चल रहे Delay चरणों का समय बदलेगा, तो परिणाम में कोड WAIT_RETARGET_CONFIRMATION_REQUIRED और impacts होते हैं: confirmWaitRetargets और उन्हीं impacts के साथ फिर से कॉल करें। workflowId आवश्यक है। पुष्टि माँगता है।
- set_active: चालू या बंद करें। active true किसी प्रकाशित वर्कफ़्लो को फिर से चालू करता है। active false उसे रोकता है: ट्रिगर सक्रिय होना बंद हो जाते हैं और लंबित Delay चरण रद्द हो जाते हैं, इसलिए वे कभी पूरे नहीं होते। कुछ भी हटाया नहीं जाता। यदि वह पहले से उसी स्थिति में न हो, तो पहले पुष्टि माँगता है। workflowId, active आवश्यक हैं। पुष्टि माँग सकता है।
- instantiate_template: टेम्पलेट से ग्राफ़। किसी टेम्पलेट को create के लिए तैयार ग्राफ़ में बदलता है: नए नोड ids के साथ { name, description, nodes, connections }। टेम्पलेट प्राप्तकर्ता, दरवाज़े और समय जानबूझकर खाली छोड़ते हैं; पहले उन्हें भरें। कुछ भी नहीं सहेजता। templateId आवश्यक है।
- generate: ग्राफ़ जनरेट करें। सुविधा के एआई से सामान्य भाषा के prompt के आधार पर ग्राफ़ बनाता है और केवल मान्य नोड प्रकारों का उपयोग करके { name, description, nodes, connections } लौटाता है। किसी वर्कफ़्लो में संशोधन के लिए workflow दें; पूरा संशोधित ग्राफ़ वापस आता है। कुछ भी नहीं सहेजता, लेकिन सुविधा के एआई क्रेडिट खर्च करता है। prompt आवश्यक है। पुष्टि माँगता है।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
name | string | वर्कफ़्लो का नाम (create, update, patch_meta) |
description | string | वर्कफ़्लो क्या करता है (create, update, patch_meta) |
nodes | array | हर नोड: { id, name, type, position, parameters }। प्रकार और पैरामीटर workflow_definitions_read node_types से आते हैं। (create, update) |
connections | object | स्रोत नोड के नाम से कुंजीबद्ध कनेक्शन; एक नोड के लिए खाली हो सकते हैं (create, update) |
notes | array | कैनवस नोट्स (create, update) |
settings | object | वर्कफ़्लो सेटिंग्स (create, update) |
facilityId | string | सुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक। |
workflowId | string | workflow_definitions_read list से वर्कफ़्लो id (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | पिछले परिणाम के impacts में सूचीबद्ध, प्रतीक्षा में चल रहे Delay चरणों का समय फिर से तय करें (publish) |
confirmedWaitRetargets | array | WAIT_RETARGET_CONFIRMATION_REQUIRED परिणाम से मिले impacts, बिना बदले वापस भेजे गए (publish) |
active | boolean | चालू करने के लिए true, रोकने के लिए false (set_active) |
templateId | string | workflow_definitions_read templates से टेम्पलेट id (instantiate_template) |
prompt | string | वर्कफ़्लो को क्या करना चाहिए (generate) |
workflow | object | workflow_definitions_read get से मिला पूरा वर्कफ़्लो, नए सिरे से शुरू करने के बजाय संशोधित करने के लिए (generate) |
confirm | boolean | केवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो |
workflow_runs_readवर्कफ़्लोकिसी वर्कफ़्लो का रन इतिहास, नवीनतम पहले, और किसी एक रन का चरण-दर-चरण विवरण। इसका उपयोग यह जाँचने के लिए करें कि कोई ऑटोमेशन चला या नहीं, workflow_runs_write से शुरू किए गए रन पर नज़र रखने के लिए, या यह जानने के लिए कि कौन-सा नोड विफल हुआ और क्यों।
कार्रवाइयाँ:
- list: रन की सूची। हर रन स्थिति, mode (live या test), साइड इफ़ेक्ट, ट्रिगर, उसे किसने शुरू किया, समय, चरणों की संख्या, जिस नोड पर वह प्रतीक्षा कर रहा है और किसी भी त्रुटि के साथ। workflowId आवश्यक है।
- get: रन प्राप्त करें। रन की स्थिति और क्रम से हर चरण, हर नोड के input, output, note और error के साथ। रन असिंक्रोनस होते हैं: Delays वाला रन तब तक प्रतीक्षा करता है जब तक उसके आगे बढ़ने का समय न आ जाए। workflowId, executionId आवश्यक हैं।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
action* | "list" | "get" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
workflowId | string | workflow_definitions_read list से वर्कफ़्लो id |
limit | integer | प्रति पेज आइटम (डिफ़ॉल्ट 25, अधिकतम 100) (list) |
cursor | string | पिछले पेज से nextCursor (list) |
facilityId | string | सुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक। |
executionId | string | workflow_runs_read list से रन id (get) |
workflow_runs_writeवर्कफ़्लोवर्कफ़्लो रन शुरू करता है, उनका परीक्षण चलाता है, उन्हें रद्द करता है और दोबारा चलाता है। test को प्राथमिकता दें, जो ड्राफ़्ट को सिम्युलेटेड साइड इफ़ेक्ट के साथ चलाता है; run प्रकाशित वर्कफ़्लो को वास्तव में चलाता है। रन असिंक्रोनस होते हैं: workflow_runs_read get से उन पर नज़र रखें।
कार्रवाइयाँ:
- run: अभी चलाएँ। प्रकाशित वर्कफ़्लो को उसके मैन्युअल ट्रिगर (custom.manualTrigger) से, वास्तविक साइड इफ़ेक्ट के साथ चलाता है। शेड्यूल, वेबहुक और इवेंट ट्रिगर अपने आप सक्रिय होते हैं। रन का executionId और पहली स्थिति लौटाता है। workflowId आवश्यक है। पुष्टि माँगता है।
- test: ड्राफ़्ट का परीक्षण करें। सहेजे गए ड्राफ़्ट को बिना प्रकाशित किए चलाता है, जो परीक्षण रन के रूप में दर्ज होता है। साइड इफ़ेक्ट डिफ़ॉल्ट रूप से सिम्युलेटेड होते हैं: कुछ भी भेजा या बदला नहीं जाता, और हर नोड बताता है कि उसने क्या किया होता। sideEffects live पहले पुष्टि माँगता है। workflowId आवश्यक है। पुष्टि माँग सकता है।
- cancel: प्रतीक्षा में चल रहा रन रद्द करें। किसी Delay पर प्रतीक्षा कर रहे रन को रद्द करता है: उसकी लंबित प्रतीक्षाएँ बंद हो जाती हैं और उनके बाद के चरण कभी नहीं चलते। पूरे हो चुके रन और किसी चरण के बीच चल रहे रन रद्द नहीं किए जा सकते। workflowId, executionId आवश्यक हैं। पुष्टि माँगता है।
- retry: रन दोबारा चलाएँ। किसी पूरे हो चुके रन को उसके दर्ज ट्रिगर इनपुट से दोबारा चलाता है, जो retryOf से वापस जुड़ा होता है। published (डिफ़ॉल्ट) उसी संस्करण को वास्तव में फिर से चलाता है जिसका उसने उपयोग किया था, और पहले पुष्टि माँगता है; draft-test वर्तमान ड्राफ़्ट को सिम्युलेटेड रूप में चलाता है, जो किसी विफलता को ठीक करते समय सही विकल्प है। workflowId, executionId आवश्यक हैं। पुष्टि माँग सकता है।
पैरामीटर
| नाम | प्रकार | विवरण |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है। |
workflowId | string | workflow_definitions_read list से वर्कफ़्लो id |
nodeId | string | शुरू करने के लिए ट्रिगर नोड id; मैन्युअल ट्रिगर के लिए छोड़ दें (run, test) |
payload | object | ट्रिगर के बाद के नोड के लिए इनपुट, उदाहरण के लिए { "visitorName": "Ada" } (run, test) |
facilityId | string | सुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक। |
sideEffects | "simulate" | "live" | क्या नोड की कार्रवाइयाँ वास्तव में होती हैं (test) |
executionId | string | workflow_runs_read list से रन id (cancel, retry) |
mode | "published" | "draft-test" | किसके विरुद्ध दोबारा चलाना है (retry) |
confirm | boolean | केवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो |