adding initial docs for structure as transform

griptape-ai / griptape

Modular Python framework for AI agents and workflows with chain-of-thought reasoning, tools, and memory.

https://www.griptape.ai

Apache License 2.0

1.95k stars 160 forks source link

adding initial docs for structure as transform #1172

Closed emjay07 closed 1 week ago

emjay07 commented 2 weeks ago

[ x] I have read and agree to the contributing guidelines for submitting new pull requests.

Describe your changes

Adding docs for Structure as Transform

Issue ticket number and link

N/A

📚 Documentation preview 📚: https://griptape--1172.org.readthedocs.build//1172/

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:loudspeaker: Thoughts on this report? Let us know!

emjay07 commented 1 week ago

I can move my Sample structure to the public repo and link that. When you say example Payload, do you mean to create a DC with a Transform?

collindutter commented 1 week ago

I just mean including some sort of snippet that explains what this:

Ensure the Structure you select to run as a Transform is configured to take in a ListArtifact as its first positional argument and returns either a TextArtifact or ListArtifact.

looks like in practice.

emjay07 commented 1 week ago

Will do -- the Sample will cover that.