Skip to content

Commit ba95b63

Browse files
monikakusterivicac
monikakuster
authored and
ivicac
committed
2906 - docs - generated
1 parent bc7922f commit ba95b63

File tree

10 files changed

+130
-0
lines changed

10 files changed

+130
-0
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING <details> <summary> Options </summary> claude-2.0, claude-2.1, claude-3-5-haiku-latest, claude-3-5-sonnet-latest, claude-3-7-sonnet-latest, claude-3-haiku-20240307, claude-3-opus-latest, claude-3-sonnet-20240229, claude-opus-4-0, claude-sonnet-4-0 </details> | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | true |
5155
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
@@ -61,6 +65,15 @@ Name: ask
6165
"name" : "ask",
6266
"parameters" : {
6367
"model" : "",
68+
"format" : "",
69+
"userPrompt" : "",
70+
"systemPrompt" : "",
71+
"attachments" : [ {
72+
"extension" : "",
73+
"mimeType" : "",
74+
"name" : "",
75+
"url" : ""
76+
} ],
6477
"messages" : [ {
6578
"role" : "",
6679
"content" : "",

‎docs/content/docs/reference/components/azure-open-ai.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ Name: ask
4747
| Name | Label | Type | Description | Required |
4848
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4949
| model | Model | STRING | Deployment name, written in string. | true |
50+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
51+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
52+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
53+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
5054
| 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 |
5155
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5256
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -66,6 +70,15 @@ Name: ask
6670
"name" : "ask",
6771
"parameters" : {
6872
"model" : "",
73+
"format" : "",
74+
"userPrompt" : "",
75+
"systemPrompt" : "",
76+
"attachments" : [ {
77+
"extension" : "",
78+
"mimeType" : "",
79+
"name" : "",
80+
"url" : ""
81+
} ],
6982
"messages" : [ {
7083
"role" : "",
7184
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -65,6 +69,15 @@ Name: ask
6569
"name" : "ask",
6670
"parameters" : {
6771
"model" : "",
72+
"format" : "",
73+
"userPrompt" : "",
74+
"systemPrompt" : "",
75+
"attachments" : [ {
76+
"extension" : "",
77+
"mimeType" : "",
78+
"name" : "",
79+
"url" : ""
80+
} ],
6881
"messages" : [ {
6982
"role" : "",
7083
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -65,6 +69,15 @@ Name: ask
6569
"name" : "ask",
6670
"parameters" : {
6771
"model" : "",
72+
"format" : "",
73+
"userPrompt" : "",
74+
"systemPrompt" : "",
75+
"attachments" : [ {
76+
"extension" : "",
77+
"mimeType" : "",
78+
"name" : "",
79+
"url" : ""
80+
} ],
6881
"messages" : [ {
6982
"role" : "",
7083
"content" : "",

‎docs/content/docs/reference/components/hugging-face.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| url | URL | STRING | Url of the inference endpoint | false |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155

@@ -56,6 +60,15 @@ Name: ask
5660
"name" : "ask",
5761
"parameters" : {
5862
"url" : "",
63+
"format" : "",
64+
"userPrompt" : "",
65+
"systemPrompt" : "",
66+
"attachments" : [ {
67+
"extension" : "",
68+
"mimeType" : "",
69+
"name" : "",
70+
"url" : ""
71+
} ],
5972
"messages" : [ {
6073
"role" : "",
6174
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING <details> <summary> Options </summary> codestral-latest, devstral-small-latest, magistral-medium-latest, magistral-small-latest, ministral-3b-latest, ministral-8b-latest, mistral-large-latest, mistral-medium-latest, mistral-small-latest, open-codestral-mamba, open-mistral-nemo, pixtral-12b-2409, pixtral-large-latest </details> | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -62,6 +66,15 @@ Name: ask
6266
"name" : "ask",
6367
"parameters" : {
6468
"model" : "",
69+
"format" : "",
70+
"userPrompt" : "",
71+
"systemPrompt" : "",
72+
"attachments" : [ {
73+
"extension" : "",
74+
"mimeType" : "",
75+
"name" : "",
76+
"url" : ""
77+
} ],
6578
"messages" : [ {
6679
"role" : "",
6780
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -65,6 +69,15 @@ Name: ask
6569
"name" : "ask",
6670
"parameters" : {
6771
"model" : "",
72+
"format" : "",
73+
"userPrompt" : "",
74+
"systemPrompt" : "",
75+
"attachments" : [ {
76+
"extension" : "",
77+
"mimeType" : "",
78+
"name" : "",
79+
"url" : ""
80+
} ],
6881
"messages" : [ {
6982
"role" : "",
7083
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING <details> <summary> Options </summary> codellama, dolphin-phi, gemma, llama2, llama2-uncensored, llama3, llama3.1, llama3.2, llama3.2-vision, llama3.2-vision:90b, llama3.2:1b, llama3.2:3b, llava, mistral, mistral-nemo, moondream, mxbai-embed-large, neural-chat, nomic-embed-text, orca-mini, phi, phi3, qwen2.5, qwq, starling-lm </details> | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| keepAlive | Keep alive for | STRING | Controls how long the model will stay loaded into memory following the request | false |
@@ -87,6 +91,15 @@ Name: ask
8791
"name" : "ask",
8892
"parameters" : {
8993
"model" : "",
94+
"format" : "",
95+
"userPrompt" : "",
96+
"systemPrompt" : "",
97+
"attachments" : [ {
98+
"extension" : "",
99+
"mimeType" : "",
100+
"name" : "",
101+
"url" : ""
102+
} ],
90103
"messages" : [ {
91104
"role" : "",
92105
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING <details> <summary> Options </summary> chatgpt-4o-latest, gpt-3.5-turbo, gpt-3.5-turbo-instruct, gpt-4, gpt-4-turbo, gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, gpt-4o, gpt-4o-audio-preview, gpt-4o-mini, gpt-4o-mini-audio-preview, gpt-4o-mini-realtime-preview, gpt-4o-mini-search-preview, gpt-4o-realtime-preview, gpt-4o-search-preview, o1, o1-mini, o1-pro, o3, o3-mini, o4-mini </details> | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -65,6 +69,15 @@ Name: ask
6569
"name" : "ask",
6670
"parameters" : {
6771
"model" : "",
72+
"format" : "",
73+
"userPrompt" : "",
74+
"systemPrompt" : "",
75+
"attachments" : [ {
76+
"extension" : "",
77+
"mimeType" : "",
78+
"name" : "",
79+
"url" : ""
80+
} ],
6881
"messages" : [ {
6982
"role" : "",
7083
"content" : "",

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Name: ask
4646
| Name | Label | Type | Description | Required |
4747
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
4848
| model | Model | STRING | ID of the model to use. | true |
49+
| format | Format | STRING <details> <summary> Options </summary> SIMPLE, ADVANCED </details> | Format of providing the prompt to the model. | true |
50+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
51+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
52+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
4953
| 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 |
5054
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | false |
5155
| maxTokens | Max Tokens | INTEGER | The maximum number of tokens to generate in the chat completion. | false |
@@ -65,6 +69,15 @@ Name: ask
6569
"name" : "ask",
6670
"parameters" : {
6771
"model" : "",
72+
"format" : "",
73+
"userPrompt" : "",
74+
"systemPrompt" : "",
75+
"attachments" : [ {
76+
"extension" : "",
77+
"mimeType" : "",
78+
"name" : "",
79+
"url" : ""
80+
} ],
6881
"messages" : [ {
6982
"role" : "",
7083
"content" : "",

0 commit comments

Comments
 (0)