Skip to content

Commit a51f259

Browse files
monikakusterivicac
monikakuster
authored and
ivicac
committed
4886 docs - generated
1 parent 3ebd506 commit a51f259

17 files changed

Lines changed: 578 additions & 33 deletions

‎docs/content/docs/reference/components/acumbamail_v1.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Name: deleteSubscriber
9595
| Name | Label | Type | Description | Required |
9696
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
9797
| list_id | List Id | INTEGER | List identifier. | true |
98-
| email | Email | STRING <details> <summary> Depends On </summary> list_id </details> | Subscriber email address. | true |
98+
| email | Email | STRING | Subscriber email address. | true |
9999

100100
#### Example JSON Structure
101101
```json

‎docs/content/docs/reference/components/ai-text_v1.mdx‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,179 @@ Type: STRING
7474

7575

7676

77+
### Extract Data
78+
Name: extractData
79+
80+
`Uses AI to pull specific structured information from unstructured text content.`
81+
82+
#### Properties
83+
84+
| Name | Label | Type | Description | Required |
85+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
86+
| provider | Provider | STRING | | true |
87+
| model | Model | STRING <details> <summary> Depends On </summary> provider </details> | The model name to use. | true |
88+
| model | Model | STRING | ID of the model to use. | true |
89+
| model | URL | STRING | Url of the inference endpoint. | true |
90+
| text | Text | STRING | The text content to extract data from. | true |
91+
| responseSchema | Response Schema | STRING | Define desired structure for the structured data response. | true |
92+
| additionalContext | Additional Context | STRING | Extra information to guide the extraction process. | false |
93+
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
94+
| temperature | Temperature | NUMBER | Controls randomness: Higher values will make the output more random, while lower values like will make it more focused and deterministic. | false |
95+
96+
#### Example JSON Structure
97+
```json
98+
{
99+
"label" : "Extract Data",
100+
"name" : "extractData",
101+
"parameters" : {
102+
"provider" : "",
103+
"model" : "",
104+
"text" : "",
105+
"responseSchema" : "",
106+
"additionalContext" : "",
107+
"maxTokens" : 1,
108+
"temperature" : 0.0
109+
},
110+
"type" : "aiText/v1/extractData"
111+
}
112+
```
113+
114+
#### Output
115+
116+
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
117+
118+
119+
120+
121+
122+
123+
### Mask
124+
Name: mask
125+
126+
`Uses AI to detect and redact sensitive content from text.`
127+
128+
#### Properties
129+
130+
| Name | Label | Type | Description | Required |
131+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
132+
| provider | Provider | STRING | | true |
133+
| model | Model | STRING <details> <summary> Depends On </summary> provider </details> | The model name to use. | true |
134+
| model | Model | STRING | ID of the model to use. | true |
135+
| model | URL | STRING | Url of the inference endpoint. | true |
136+
| text | Text | STRING | The text to process. | true |
137+
| sensitiveKeywords | Sensitive Keywords | ARRAY <details> <summary> Items </summary> [STRING] </details> | Words or phrases to detect and redact. | false |
138+
| piiDetection | PII Detection | ARRAY <details> <summary> Items </summary> [STRING] </details> | Detect personally identifiable information (email, phone, SSN, credit card, IP address). | false |
139+
| customRegexPatterns | Custom Patterns | ARRAY <details> <summary> Items </summary> [STRING] </details> | Custom patterns to detect and redact. | false |
140+
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
141+
| temperature | Temperature | NUMBER | Controls randomness: Higher values will make the output more random, while lower values like will make it more focused and deterministic. | false |
142+
143+
#### Example JSON Structure
144+
```json
145+
{
146+
"label" : "Mask",
147+
"name" : "mask",
148+
"parameters" : {
149+
"provider" : "",
150+
"model" : "",
151+
"text" : "",
152+
"sensitiveKeywords" : [ "" ],
153+
"piiDetection" : [ "" ],
154+
"customRegexPatterns" : [ "" ],
155+
"maxTokens" : 1,
156+
"temperature" : 0.0
157+
},
158+
"type" : "aiText/v1/mask"
159+
}
160+
```
161+
162+
#### Output
163+
164+
165+
___Sample Output:___
166+
167+
```{text=Hello, my name is [REDACTED_1] and my email is [EMAIL_1]., maskMap={[EMAIL_1]=john@example.com, [REDACTED_1]=John Doe}}```
168+
169+
170+
171+
Type: OBJECT
172+
173+
174+
#### Properties
175+
176+
| Name | Type | Description |
177+
|:------------:|:------------:|:-------------------:|
178+
| text | STRING | The text with sensitive content redacted. |
179+
| maskMap | OBJECT <details> <summary> Properties </summary> &#123;&#125; </details> | Mapping of mask tokens to their original values. |
180+
181+
182+
183+
184+
#### Output Example
185+
```json
186+
{
187+
"text" : "",
188+
"maskMap" : { }
189+
}
190+
```
191+
192+
193+
194+
195+
### Unmask
196+
Name: unmask
197+
198+
`Uses AI and a map of masking entities to unmask the text.`
199+
200+
#### Properties
201+
202+
| Name | Label | Type | Description | Required |
203+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
204+
| provider | Provider | STRING | | true |
205+
| model | Model | STRING <details> <summary> Depends On </summary> provider </details> | The model name to use. | true |
206+
| model | Model | STRING | ID of the model to use. | true |
207+
| model | URL | STRING | Url of the inference endpoint. | true |
208+
| text | Text | STRING | The text to process. | true |
209+
| maskMap | Masked map | OBJECT <details> <summary> Properties </summary> &#123;&#125; </details> | Map of masked entities to replace with values. | false |
210+
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
211+
| temperature | Temperature | NUMBER | Controls randomness: Higher values will make the output more random, while lower values like will make it more focused and deterministic. | false |
212+
213+
#### Example JSON Structure
214+
```json
215+
{
216+
"label" : "Unmask",
217+
"name" : "unmask",
218+
"parameters" : {
219+
"provider" : "",
220+
"model" : "",
221+
"text" : "",
222+
"maskMap" : { },
223+
"maxTokens" : 1,
224+
"temperature" : 0.0
225+
},
226+
"type" : "aiText/v1/unmask"
227+
}
228+
```
229+
230+
#### Output
231+
232+
233+
___Sample Output:___
234+
235+
```Hello, my name is [REDACTED] and my email is [EMAIL].```
236+
237+
238+
239+
Type: STRING
240+
241+
242+
243+
244+
245+
246+
247+
248+
249+
77250
### Sentiment Analysis
78251
Name: sentimentAnalysis
79252

‎docs/content/docs/reference/components/ai_agent-utils_v1.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "AI Agent Utils"
3+
description: "AI Agent Utils brings Claude Code-inspired tools and agent skills."
4+
---
5+
6+
7+
Categories: Artificial Intelligence
8+
9+
10+
Type: aiAgentUtils/v1
11+
12+
<hr />
13+
14+
15+
16+
17+
18+

‎docs/content/docs/reference/components/anthropic_v1.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Name: ask
5555
| messages | Messages | ARRAY <details> <summary> Items </summary> [&#123;STRING\(role), STRING\(content), [FILE_ENTRY]\(attachments)&#125;] </details> | A list of messages comprising the conversation so far. | true |
5656
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | true |
5757
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | true |
58-
| temperature | Temperature | NUMBER | Controls randomness: Higher values will make the output more random, while lower values like will make it more focused and deterministic. | false |
59-
| topP | Top P | NUMBER | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. | false |
58+
| temperature | Temperature | NUMBER | Controls randomness: higher values make the output more random, lower values make it more focused and deterministic. Set either Temperature or Top P, not both. | false |
59+
| topP | Top P | NUMBER | Nucleus sampling: the model considers tokens whose cumulative probability mass adds up to top_p. Set either Temperature or Top P, not both. | false |
6060
| topK | Top K | INTEGER | Specify the number of token choices the generative uses to generate the next token. | false |
6161
| stop | Stop | ARRAY <details> <summary> Items </summary> [STRING] </details> | Up to 4 sequences where the API will stop generating further tokens. | false |
6262

@@ -126,8 +126,8 @@ Name: streamAsk
126126
| messages | Messages | ARRAY <details> <summary> Items </summary> [&#123;STRING\(role), STRING\(content), [FILE_ENTRY]\(attachments)&#125;] </details> | A list of messages comprising the conversation so far. | true |
127127
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | true |
128128
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | true |
129-
| temperature | Temperature | NUMBER | Controls randomness: Higher values will make the output more random, while lower values like will make it more focused and deterministic. | false |
130-
| topP | Top P | NUMBER | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. | false |
129+
| temperature | Temperature | NUMBER | Controls randomness: higher values make the output more random, lower values make it more focused and deterministic. Set either Temperature or Top P, not both. | false |
130+
| topP | Top P | NUMBER | Nucleus sampling: the model considers tokens whose cumulative probability mass adds up to top_p. Set either Temperature or Top P, not both. | false |
131131
| topK | Top K | INTEGER | Specify the number of token choices the generative uses to generate the next token. | false |
132132
| stop | Stop | ARRAY <details> <summary> Items </summary> [STRING] </details> | Up to 4 sequences where the API will stop generating further tokens. | false |
133133

‎docs/content/docs/reference/components/approval.mdx‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "Approval"
3+
description: "Approval component for manual intervention in workflows."
4+
---
5+
6+
7+
Categories: Helpers
8+
9+
10+
Type: approval/v1
11+
12+
<hr />
13+
14+
15+
16+
17+
## Actions
18+
19+
20+
### Request Approval
21+
Name: requestApproval
22+
23+
`Sends an approval request and waits for a human to approve or reject.`
24+
25+
#### Properties
26+
27+
| Name | Label | Type | Description | Required |
28+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
29+
| formTitle | Form Title | STRING | The title for the approval form. Displayed as the main heading. | false |
30+
| formDescription | Form Description | STRING | A description shown under the form title. Use \n or &lt;br&gt; for line breaks. | false |
31+
| inputs | Form Inputs | ARRAY <details> <summary> Items </summary> [&#123;INTEGER\(fieldType), STRING\(fieldLabel), STRING\(fieldName), STRING\(fieldDescription), STRING\(placeholder), STRING\(defaultValue), STRING\(defaultValue), [&#123;STRING\(label), STRING\(value)&#125;]\(fieldOptions), BOOLEAN\(multipleChoice), INTEGER\(minSelection), INTEGER\(maxSelection), BOOLEAN\(required)&#125;] </details> | Define the form input fields for the approval request. | false |
32+
33+
#### Example JSON Structure
34+
```json
35+
{
36+
"label" : "Request Approval",
37+
"name" : "requestApproval",
38+
"parameters" : {
39+
"formTitle" : "",
40+
"formDescription" : "",
41+
"inputs" : [ {
42+
"fieldType" : 1,
43+
"fieldLabel" : "",
44+
"fieldName" : "",
45+
"fieldDescription" : "",
46+
"placeholder" : "",
47+
"defaultValue" : "",
48+
"fieldOptions" : [ {
49+
"label" : "",
50+
"value" : ""
51+
} ],
52+
"multipleChoice" : false,
53+
"minSelection" : 1,
54+
"maxSelection" : 1,
55+
"required" : false
56+
} ]
57+
},
58+
"type" : "approval/v1/requestApproval"
59+
}
60+
```
61+
62+
#### Output
63+
64+
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
65+
66+
67+
68+
69+
70+
71+
72+

0 commit comments

Comments
 (0)