add documentation about file and template node #112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MoElkhidir
suggested changes
Dec 11, 2023
|
|
||
| - [Checklist](/instructions/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 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. |
There was a problem hiding this comment.
this sentence is a bit confusing, could be simplified? something like "this will run your prompt over a document, validate a checklist you specify and fill the result in a table format"
| A tool is a series of [instructions](instructions.md) that can be combined to create more complex features. Once created, your tool can be deployed and becomes available through an API. You can use our SDK or our Rest API to integrate the workflow into your codebase. You can also share a preview of the tool using our [shareable ui](../tools/preview.md) feature. | ||
| 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. |
There was a problem hiding this comment.
complex features can be complex logic or advance functionality?
|
|
||
| The file node has the following inputs: | ||
|
|
||
| **`Text`** content of the file, _ignore this if you just want to upload a file_ |
There was a problem hiding this comment.
This might not be the time to fix this but I have always wondered why do we have text field in this nod and the user can use the node as template node without uploading any file?
There was a problem hiding this comment.
currently all "fields" are considered inputs, even if in this case it doesn't make sense. We could extend the node API to fix this
| - **Control**: if this field is not connected the instruction will not 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 | ||
| **`Control`** if this field is not connected the instruction will not run |
There was a problem hiding this comment.
can we expand on this and explain why it won't run? maybe something similar to "this controls the execution order of the node"
There was a problem hiding this comment.
what do you think about this version?
websites/docs/pages/nodes/table.md
Outdated
| @@ -0,0 +1,35 @@ | |||
| # 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. | |||
There was a problem hiding this comment.
similar to previous comment related to this
websites/docs/pages/nodes/table.md
Outdated
| @@ -0,0 +1,35 @@ | |||
| # 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. | |||
websites/docs/pages/nodes/table.md
Outdated
|
|
||
| ## Inputs | ||
|
|
||
| The Instruction node has the following inputs: |
websites/docs/pages/nodes/table.md
Outdated
|
|
||
| The Instruction node has the following inputs: | ||
|
|
||
| **`Control`** if this field is not connected the instruction will not run. |
There was a problem hiding this comment.
similar to the previous comment related to the control field
MoElkhidir
approved these changes
Dec 11, 2023
au-re
deleted the
111-add-documentation-about-file-and-template-nodes
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.