Merge pull request #683 from RizaFarheen/main

Terminate Workflow
orkes-io · Jun 4, 2024 · a7453d2 · a7453d2
2 parents 590cb2d + 87bc9cf
commit a7453d2
Show file tree

Hide file tree

Showing 37 changed files with 119 additions and 101 deletions.
diff --git a/docs/reference-docs/ai-tasks/llm-chat-complete.md b/docs/reference-docs/ai-tasks/llm-chat-complete.md
@@ -35,7 +35,7 @@ A system task to complete the chat query. It can be used to instruct the model's
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | llmProvider | Choose the required LLM provider. You can only choose providers to which you have access for at least one model from that provider.<br/><br/>**Note:**If you haven’t configured your AI / LLM provider on your Orkes console, navigate to the **Integrations** tab and configure your required provider. Refer to this doc on [how to integrate the LLM providers with Orkes console and provide access to required groups](https://orkes.io/content/category/integrations/ai-llm). | 
 | model | Choose from the available language model for the chosen LLM provider. You can only choose models for which you have access.<br/><br/>For example, If your LLM provider is Azure Open AI & you’ve configured *text-davinci-003* as the language model, you can choose it under this field. |
@@ -78,7 +78,7 @@ The task output displays the completed chat by the LLM.
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-generate-embeddings.md b/docs/reference-docs/ai-tasks/llm-generate-embeddings.md
@@ -29,7 +29,7 @@ A system task to generate embeddings from the input data provided. Embeddings ar
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | llmProvider | Choose the required LLM provider. You can only choose providers to which you have access for at least one model from that provider.<br/><br/>**Note**:If you haven’t configured your AI / LLM provider on your Orkes console, navigate to the **Integrations** tab and configure your required provider. Refer to this doc on [how to integrate the LLM providers with Orkes console and provide access to required groups](/content/category/integrations/ai-llm).| 
 | model | Choose from the available language model for the chosen LLM provider. You can only choose models for which you have access.<br/><br/>For example, If your LLM provider is Azure Open AI & you’ve configured *text-davinci-003* as the language model, you can choose it under this field. |
@@ -67,7 +67,7 @@ The task output is a JSON array containing the vectors of the indexed data.
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-get-document.md b/docs/reference-docs/ai-tasks/llm-get-document.md
@@ -24,7 +24,7 @@ A system task to retrieve the content of the document provided and use it for fu
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | url | Provide the URL of the document to be retrieved.<br/><br/>Check out our documentation on [how to pass parameters to tasks](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor). |
 | mediaType | Select the media type of the file to be retrieved. Currently, supported media types include:<ul><li>application/pdf</li><li>text/html</li><li>text/plain</li><li>json</li></ul> | 
@@ -56,7 +56,7 @@ A system task to retrieve the content of the document provided and use it for fu
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-get-embeddings.md b/docs/reference-docs/ai-tasks/llm-get-embeddings.md
@@ -26,7 +26,7 @@ A system task to get the numerical vector representations of words, phrases, sen
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- | 
 | vectorDB | Choose the required vector database.<br/><br/>**Note**:If you haven’t configured the vector database on your Orkes console, navigate to the Integrations tab and configure your required provider. Refer to this doc on [how to integrate Vector Databases with Orkes console](/content/category/integrations/vector-databases). |
 | namespace | Choose from the available namespace configured within the chosen vector database.<br/><br/>Namespaces are separate isolated environments within the database to manage and organize vector data effectively.<br/><br/>**Note**:Namespace field is applicable only for Pinecone integration and is not applicable to Weaviate integration.|
@@ -68,7 +68,7 @@ A system task to get the numerical vector representations of words, phrases, sen
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-index-document.md b/docs/reference-docs/ai-tasks/llm-index-document.md
@@ -31,7 +31,7 @@ A system task to index the provided document into a vector database that can be
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | vectorDB | Choose the required vector database.<br/><br/>**Note**:If you haven’t configured the vector database on your Orkes console, navigate to the Integrations tab and configure your required provider. Refer to this doc on [how to integrate Vector Databases with Orkes console](/content/category/integrations/vector-databases). |
 | namespace | Choose from the available namespace configured within the chosen vector database.<br/><br/>Namespaces are separate isolated environments within the database to manage and organize vector data effectively.<br/><br/>**Note**:Namespace field is applicable only for Pinecone integration and is not applicable to Weaviate integration.|
@@ -71,7 +71,7 @@ A system task to index the provided document into a vector database that can be
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-index-text.md b/docs/reference-docs/ai-tasks/llm-index-text.md
@@ -29,7 +29,7 @@ A system task to index the provided text into a vector space that can be efficie
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | vectorDB | Choose the required vector database.<br/><br/>**Note**:If you haven’t configured the vector database on your Orkes console, navigate to the Integrations tab and configure your required provider. Refer to this doc on [how to integrate Vector Databases with Orkes console](/content/category/integrations/vector-databases). |
 | namespace | Choose from the available namespace configured within the chosen vector database.<br/><br/>Namespaces are separate isolated environments within the database to manage and organize vector data effectively.<br/><br/>**Note**:Namespace field is applicable only for Pinecone integration and is not applicable to Weaviate integration.|
@@ -67,7 +67,7 @@ A system task to index the provided text into a vector space that can be efficie
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-search-index.md b/docs/reference-docs/ai-tasks/llm-search-index.md
@@ -30,7 +30,7 @@ For example, in a recommendation system, a user might issue a query to find prod
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | vectorDB | Choose the required vector database.<br/><br/>**Note**:If you haven’t configured the vector database on your Orkes console, navigate to the Integrations tab and configure your required provider. Refer to this doc on [how to integrate Vector Databases with Orkes console](/content/category/integrations/vector-databases). |
 | namespace | Choose from the available namespace configured within the chosen vector database.<br/><br/>Namespaces are separate isolated environments within the database to manage and organize vector data effectively.<br/><br/>**Note**:Namespace field is applicable only for Pinecone integration and is not applicable to Weaviate integration.|
@@ -74,7 +74,7 @@ For example, in a recommendation system, a user might issue a query to find prod
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-store-embeddings.md b/docs/reference-docs/ai-tasks/llm-store-embeddings.md
@@ -28,7 +28,7 @@ A system task responsible for storing the generated embeddings produced by the [
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | ---------- | ----------- |
 | vectorDB | Choose the vector database to which the data is to be stored. <br/><br/>**Note**: If you haven’t configured the vector database on your Orkes console, navigate to the **_Integrations_** tab and configure your required provider. Refer to this doc on [how to integrate Vector Databases with Orkes console](https://orkes.io/content/category/integrations/vector-databases). |
 | index | Choose the index in your vector database where the text or data is to be stored.<br/><br/>**Note**: For Weaviate integration, this field refers to the class name, while in Pinecone integration, it denotes the index name itself. | 
@@ -65,7 +65,7 @@ A system task responsible for storing the generated embeddings produced by the [
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
 {

diff --git a/docs/reference-docs/ai-tasks/llm-text-complete.md b/docs/reference-docs/ai-tasks/llm-text-complete.md
@@ -37,7 +37,7 @@ A system task to predict or generate the next phrase or words in a given text ba
 
 ## Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | llmProvider | Choose the required LLM provider. You can only choose providers to which you have access for at least one model from that provider.<br/><br/>**Note**:If you haven’t configured your AI / LLM provider on your Orkes console, navigate to the **Integrations** tab and configure your required provider. Refer to this doc on [how to integrate the LLM providers with Orkes console and provide access to required groups](/content/category/integrations/ai-llm).| 
 | model | Choose from the available language model for the chosen LLM provider. You can only choose models for which you have access.<br/><br/>For example, If your LLM provider is Azure Open AI & you’ve configured *text-davinci-003* as the language model, you can choose it under this field. |
@@ -80,7 +80,7 @@ The task output displays the completed text by the LLM.
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
    {

diff --git a/docs/reference-docs/ai-tasks/prompt-template.md b/docs/reference-docs/ai-tasks/prompt-template.md
@@ -10,7 +10,7 @@ The AI prompts can be created in the Orkes Conductor cluster and can be used in
 
 ## Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | Prompt Name | A name for the prompt. |
 | Description | A description for the prompt. |

diff --git a/docs/reference-docs/operators/do-while.md b/docs/reference-docs/operators/do-while.md
@@ -29,15 +29,15 @@ The Do While task sequentially executes a list of tasks as long as a condition i
 
 ### Input Parameters
 
-| Attributes    | Description                                                                                                                                                                                                                    |
+| Attribute    | Description                                                                                                                                                                                                                    |
 | ------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | loopCondition | Indicates the condition to be evaluated after every iteration. Supported types are **value-param**, and **ECMASCRIPT**.  If an exception occurs during evaluation, the task is set to FAILED_WITH_TERMINAL_ERROR. |
 | loopOver      | Includes the list of tasks to be executed as long as the condition is evaluated to `true`.                                                                                                                                       |
 | keepLastN (No of iterations to keep) | Specify the number of required iterations. On enabling this option, this value is set to 2 by default. You can also choose the option “No limits” based on your preference. |
 
 ### Output Parameters
 
-| Attributes | Description                                                                                                                                                                                             |
+| Attribute | Description                                                                                                                                                                                             |
 | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | iteration  | Indicates the iteration number, which is the current one while executing, and the final one once the loop is finished.                                                                                  |
 | i          | Iteration number as a string mapped to the task references names and their output.                                                                                                                      |
@@ -77,7 +77,7 @@ The Do While task sequentially executes a list of tasks as long as a condition i
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
     {

diff --git a/docs/reference-docs/operators/get-workflow.md b/docs/reference-docs/operators/get-workflow.md
@@ -25,7 +25,7 @@ Get workflow is an operator task that retrieves the workflow execution details u
 
 ### Input Parameters
 
-| Parameter | Description |
+| Attribute | Description |
 | --------- | ----------- |
 | id | Provide the workflow ID of the workflow. You can also pass this [parameter as a variable](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor). |
 | includeTasks | Set this to true or false, depending on whether to retrieve the task details or not. |

diff --git a/docs/reference-docs/operators/join.md b/docs/reference-docs/operators/join.md
@@ -121,7 +121,7 @@ The output is a map, where the keys are the names of task references being joine
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
    {

diff --git a/docs/reference-docs/operators/set-variable.md b/docs/reference-docs/operators/set-variable.md
@@ -55,7 +55,7 @@ Set Variable allows us to set the workflow variables by creating or updating the
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
     {

diff --git a/docs/reference-docs/operators/start-workflow.md b/docs/reference-docs/operators/start-workflow.md
@@ -74,7 +74,7 @@ A start workflow task is considered successful when the requested workflow begin
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
    {

diff --git a/docs/reference-docs/operators/sub-workflow.md b/docs/reference-docs/operators/sub-workflow.md
@@ -73,7 +73,7 @@ The output of the sub-workflow is also supplied to the output of the workflow.
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
     {

diff --git a/docs/reference-docs/operators/switch.md b/docs/reference-docs/operators/switch.md
@@ -80,7 +80,7 @@ The switch task is used for creating branching logic. It is a representation of
 
 
 </TabItem>
- <TabItem value="JSON" label="JSON Example">
+ <TabItem value="JSON" label="JSON">
 
 ```json
     {