Merge pull request #2117 from n8n-io/tools-schema

Add Tool input schema docs and update output parser docs
This commit is contained in:
Ricardo Espinoza 2024-05-22 11:31:15 -04:00 committed by GitHub
commit 49c40fd938
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 17 additions and 1 deletions

View File

@ -0,0 +1,3 @@
1. **Generate from JSON Example**: Input an example JSON object to automatically generate the schema. The node uses the object property types and names. It ignores the actual values.
2. **Define Below**: Manually input the JSON schema. Read the JSON Schema [guides and examples](https://json-schema.org/learn/miscellaneous-examples){:target=_blank .external-link} for help creating a valid JSON schema.

View File

@ -17,7 +17,9 @@ For usage examples and templates to help you get started, refer to n8n's [Struct
## Node parameters
**JSON Schema**: a JSON schema to structure and validate the output. Read the JSON Schema [guides and examples](https://json-schema.org/learn/miscellaneous-examples){:target=_blank .external-link} for help creating a valid JSON schema.
**Schema Type**: Define the output structure and validation. You have two options to provide the schema:
--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/schema-type-structuring.md"
## Related resources

View File

@ -42,6 +42,17 @@ This must match the name of the output property in the workflow you're calling.
--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/workflow-values.md"
### Specify input schema
/// note | Agent support
The structured input schema requires with a Tools Agent or OpenAI Functions Agent.
///
Enable this option to define the input schema for the workflow you're calling. This is useful when you want to make sure the input data the LLM provides is in the correct format.
**Schema Type**: Define the input structure and validation. You have two options to provide the schema:
--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/schema-type-structuring.md"
## Related resources