Skip to content

Commit

Permalink
Merge pull request #804 from RizaFarheen/nov-27
Browse files Browse the repository at this point in the history
Doc Updates based on UI changes
  • Loading branch information
RizaFarheen authored Nov 27, 2024
2 parents 2993fad + 91a67f3 commit bfd68da
Show file tree
Hide file tree
Showing 10 changed files with 11 additions and 58 deletions.
2 changes: 1 addition & 1 deletion docs/integrations/ai-llm/cohere.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The base URL for Cohere is https://api.cohere.ai/v1, which serves as the API End
Let’s integrate Cohere with Orkes Conductor.

1. Navigate to **Integrations** from the left menu on your Orkes Conductor cluster.
2. Click **+New integration button** from the top-right corner.
2. Click **+New integration** button from the top-right corner.
3. Under the **AI/LLM** section, choose **Cohere**.
4. Click **+Add** and provide the following parameters:

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/ai-llm/hugging-face.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Now, you have the API key. Let’s integrate this with Orkes Conductor.

1. Navigate to **Integrations** from the left menu on your Orkes Conductor cluster.
2. Click **+New integration** button from the top-right corner.
3. Under the **AI / LLM** section, choose **Hugging Face**.
3. Under the **AI/LLM** section, choose **Hugging Face**.
4. Click **+Add** and provide the following parameters:

<p align="center"><img src="/content/img/create-new-hugging-face-integration.png" alt="Create new Hugging Face Integration" width="60%" height="auto"></img></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/ai-llm/open-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Now, you have the API key. Let’s integrate this with Orkes Conductor.

1. Navigate to **Integrations** from the left menu on your Orkes Conductor cluster.
2. Click **+New integration** button from the top-right corner.
3. Under the **AI / LLM** section, choose **OpenAI**.
3. Under the **AI/LLM** section, choose **OpenAI**.
4. Click **+Add** and provide the following parameters:

<p align="center"><img src="/content/img/create-new-open-ai-integration.png" alt="Create new OpenAI Integration" width="70%" height="auto"></img></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/ai-llm/vertex-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Let’s integrate Google Vertex AI with Orkes Conductor.

1. Navigate to **Integrations** from the left menu on your Orkes Conductor cluster.
2. Click **+New integration** button from the top-right corner.
3. Under the **AI / LLM** section, choose **Google Vertex AI**.
3. Under the **AI/LLM** section, choose **Google Vertex AI**.
4. Click **+Add** and provide the following parameters:

<p align="center"><img src="/content/img/create-new-vertex-ai-integration.png" alt="Create new Vertex AI Integration" width="60%" height="auto"></img></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference-docs/ai-tasks/llm-search-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Configure these parameters for the LLM Search Index task.
| Parameter | Description | Required/Optional |
| --------- | ----------- | ----------------- |
| inputParameters.**vectorDB** | The vector database to retrieve the data.<br/><br/>**Note**: If you haven’t configured the vector database on your Orkes Conductor cluster, navigate to the **Integrations** tab and configure your required provider. Refer to the documentation on [how to integrate Vector Databases with Orkes console](https://orkes.io/content/category/integrations/vector-databases). | Required. |
| inputParameters.**index** | The index in your vector database where the text or data will be stored.<br/><br/>The terminology of the index field varies depending on the integration:<ul><li>For Weaviate, the index field indicates the class name.</li><li>For other integrations, it denotes the index name.</li></ul> | Required. |
| inputParameters.**namespace** | Namespaces are separate isolated environments within the database to manage and organize vector data effectively. Choose from the available namespace configured within the chosen vector database.<br/><br/>The usage and terminology of the namespace field vary depending on the integration:<ul><li>For Pinecone, the namespace field is applicable.</li><li>For Weaviate, the namespace field is not applicable.</li><li>For MongoDB, the namespace field is referred to as “Collection” in MongoDB.</li><li>For Postgres, the namespace field is referred to as “Table” in Postgres.</li></ul> | Required. |
| inputParameters.**index** | The index in your vector database where the text or data will be stored.<br/><br/>The terminology of the index field varies depending on the integration:<ul><li>For Weaviate, the index field indicates the class name.</li><li>For other integrations, it denotes the index name.</li></ul> | Required. |
| inputParameters.**embeddingModelProvider** | The LLM provider for the embeddings.<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 the documentation on [how to integrate the LLM providers with Orkes Conductor](https://orkes.io/content/category/integrations/ai-llm). | Required. |
| inputParameters.**embeddingModel** | The embedding model provided by the selected LLM provider. | Required. |
| inputParameters.**query** | The search query. A query typically refers to a question, statement, or request made in natural language that is used to search, retrieve, or manipulate data stored in a database. | Required. |
Expand Down
47 changes: 0 additions & 47 deletions docs/reference-docs/ai-tasks/prompt-template.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/reference-docs/operators/switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Configure these parameters for the Switch task.

| Parameter | Description | Required/ Optional |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| evaluatorType | The type of evaluator used. Supported types: <ul><li>`value-param`—Evaluates a specific input parameter in the Switch task.</li><li>`graaljs`—Evaluates JavaScript expressions and computes the value. Allows you to use ES6-compatible JavaScript.</li><li>`javascript`—Evaluates JavaScript expressions and computes the value. Deprecated; use graaljs instead.</li></ul> | Required. |
| expression | The expression that is evaluated by the Switch task. The expression format depends on the evaluator type:<ul><li>For the `value-param` evaluator, the expression is the input parameter key.</li><li>For the `javascript` and `graaljs` evaluators, the expression is the JavaScript expression. </li></ul> | Required. |
| evaluatorType | The type of evaluator used. Supported types: <ul><li>`value-param`—Evaluates a specific input parameter in the Switch task.</li><li>`graaljs`—Evaluates JavaScript expressions and computes the value. Allows you to use ES6-compatible JavaScript.</li></ul> | Required. |
| expression | The expression that is evaluated by the Switch task. The expression format depends on the evaluator type:<ul><li>For the `value-param` evaluator, the expression is the input parameter key.</li><li>For the `graaljs` evaluator, the expression is the JavaScript expression. </li></ul> | Required. |
| decisionCases | A map of the possible switch cases. The keys are the possible outputs of the evaluated expression, and the values are the list of tasks to be executed in each case. | Required. |
| defaultCase | The default branch. Contains the list of tasks to be executed when no matching value is found in the decision cases. | Optional. |

Expand Down
4 changes: 2 additions & 2 deletions docs/reference-docs/system-tasks/business-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Configure these parameters for the Business Rule task.
| --------- | ----------- | ----------------- |
| inputParamemeter.**ruleFileLocation** | URL of the spreadsheet to be evaluated, in CSV, XLS, or XLSX format. The file can be stored on the web, AWS S3, Azure Blob, etc.<br/><br/>**Note:**A spreadsheet without an explicitly-defined .csv, .xls, or .xlsx extension can also be processed as long as its the `Content-Type` indicates a supported format, such as a Google spreadsheet published to the web. | Required. |
| inputParamemeter.**executionStrategy** | Strategy for rule execution. Supported types:<ul><li>**FIRE_FIRST**—Uses the first rule that matches to generate the output.</li><li>**FIRE_ALL**—Uses all matching rules to generate the output, with subsequent rules overwriting previous values.</li></ul> | Required. |
| inputParamemeter.**inputColumn** | The inputs to the rule file, which can be fixed or [passed as variables](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor). Supports string, number, boolean, null, and object/array. | Required. |
| inputParamemeter.**outputColumn** | List of columns that will be present in the task output. | Required. |
| inputParamemeter.**inputColumns** | The inputs to the rule file, which can be fixed or [passed as variables](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor). Supports string, number, boolean, null, and object/array. | Required. |
| inputParamemeter.**outputColumns** | List of columns that will be present in the task output. | Required. |

### Execution Strategy

Expand Down
2 changes: 1 addition & 1 deletion docs/reference-docs/system-tasks/jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Configure these parameters for the JDBC task.
| --------- | ----------- | ----------------- |
| inputParamters. **integrationName** | Select the required database integration which you have access to. If your database isn't configured on your Orkes console, go to the **Integrations** tab and configure it under **[RDBMS > Relational Database](https://orkes.io/content/integrations/rdbms/relational-database)**. | Required. |
| inputParamters. **type** | Select the SQL statement type. Supported values:<ul><li>**SELECT**—Used to retrieve data from a database.</li><li>**UPDATE / DELETE**—Used to modify or delete existing data from the database.</li></ul>| Required. |
| inputParameters. **expectedOutputCount** | The number of rows to be updated/deleted from the database. | Required if the statement type is chosen as ‘UPDATE/DELETE’. | Required. |
| inputParameters. **expectedUpdateCount** | The number of rows to be updated/deleted from the database. | Required if the statement type is chosen as ‘UPDATE/DELETE’. | Required. |
| inputParameters. **statement** | The SQL statement to retrieve data from the SQL database. | Required. |
| inputParameters. **parameters** | The query parameters to be bound by the SQL statement. It can be a string, number, boolean, or null. | Required. |

Expand Down
2 changes: 1 addition & 1 deletion docs/reference-docs/system-tasks/query-processor.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Configure these parameters for the Query Processor task.
| inputParameters. **metricsQuery** | The Prometheus query to execute. Refer to [the list of metrics published to the Conductor server](docs/developer-guides/metrics-and-observability.md#conductor-metrics) to formulate your query. | Required. |
| inputParameters. **metricsStart** | The beginning of the time range for the query, in minutes from the current time. For example, setting this to 15 means the query will include data starting from 15 minutes ago. | Required. |
| inputParameters. **metricsEnd** | The end of the time range for the query, in minutes from the current time. Setting this to 0 means the query will include data up to the current time. | Required. |
| inputParameters. **metrics** | The time duration, in seconds, between data points in the query result (also known as the step or interval of the metrics query). For example, setting this to 1 means the query will include a data point for every 1 second. | Required. |
| inputParameters. **metricsStep** | The time duration, in seconds, between data points in the query result (also known as the step or interval of the metrics query). For example, setting this to 1 means the query will include a data point for every 1 second. | Required. |

</TabItem>
</Tabs>
Expand Down

0 comments on commit bfd68da

Please sign in to comment.