Skip to content

Commit

Permalink
various fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
au-re committed Dec 11, 2023
1 parent fff9373 commit 36f8a06
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion websites/docs/pages/concepts/instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Below is a list of currently available instructions and when to use them.

- [Instruction](/nodes/instruction) : will provide your prompt to a language model without any transformation besides inserting variables. For prompts that exceed the context length of the target llm, the start and end of the prompt are preserved while the center is summarized.

- [Checklist](/nodes/table): will run your prompt sequentially over a document of variable length and fill a table with parameters you requested. The full document is provided to the LLM as is to ensure no information is missed. This Instruction type is ideal for analyzing documents, running checklists or extracting information from unstructured data.
- [Checklist](/nodes/table): will process your document, no matter its length, and fill a table with the requested parameters. The entire document is given to the AI to make sure no details are overlooked. This method is great for analyzing documents, completing checklists, or getting information from unstructured data.

## Instruction Playground

Expand Down
2 changes: 1 addition & 1 deletion websites/docs/pages/concepts/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Tools can automate tasks, process documents, classify data and do a lot more. We are constantly expanding the set of features available within the tool editor.

A tool is a series of `nodes` that can either be [instructions](instructions.md) or [data](file.md) and that can be combined together to create more complex features. Once created, your tool can be deployed through an API. You can use our [SDK](/sdk/js) or our [Rest API](/api/getting-started) to integrate the tool into your codebase. You can also share a preview of the tool using our [shareable ui](../tools/preview.md) feature.
A tool is a series of `nodes` that can either be [instructions](instructions.md) or [data](file.md) and that can be combined together to create more advance functionality. Once created, your tool can be deployed through an API. You can use our [SDK](/sdk/js) or our [Rest API](/api/getting-started) to integrate the tool into your codebase. You can also share a preview of the tool using our [shareable ui](../tools/preview.md) feature.

::: warning Under Construction

Expand Down
6 changes: 3 additions & 3 deletions websites/docs/pages/nodes/instruction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ The default instruction will provide your prompt to a language model without any

The Instruction node has the following inputs:

**`Control`** if this field is not connected the instruction will not run
**`Control`** controls the order in which instructions are run. This field needs to be connected for the instruction to run.

**`AI Settings`** what [language model](/concepts/llms) and parameters to use to complete the instruction

**`Prompt`** The [prompt](/concepts/prompts) to provide to the language model
**`Prompt`** the [prompt](/concepts/prompts) to provide to the language model

## Outputs

**`Results`** The resulting values generated by the LLM
**`Results`** the resulting values generated by the LLM

## Adding variables

Expand Down
6 changes: 3 additions & 3 deletions websites/docs/pages/nodes/table.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Checklist

The **checklist instruction** will run your prompt sequentially over a document of any length and fill a table with parameters you requested. The full document is provided to the LLM as is, to ensure no information is missed. This is ideal for analyzing documents, running checklists or extracting information from unstructured data.
The **checklist node** will process your document, no matter its length, and fill a table with the requested parameters. The entire document is given to the AI to make sure no details are overlooked. This method is great for analyzing documents, completing checklists, or getting information from unstructured data.

This node returns a table in either CSV or markdown formats, and will self heal incompatible results.

![Table](./images/table.png)

## Inputs

The Instruction node has the following inputs:
The Checklist node has the following inputs:

**`Control`** if this field is not connected the instruction will not run.
**`Control`** controls the order in which instructions are run. This field needs to be connected for the instruction to run.

**`AI Settings`** what [language model](/concepts/llms) and parameters to use to complete the instruction

Expand Down

0 comments on commit 36f8a06

Please sign in to comment.