Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding initial cloud Structure docs #1036

Closed
wants to merge 213 commits into from
Closed

Adding initial cloud Structure docs #1036

wants to merge 213 commits into from

Conversation

zachgiordano
Copy link
Member

@zachgiordano zachgiordano commented Jul 31, 2024 •
edited
Loading

Describe your changes

Adding some initial documentation for Griptape Cloud Structures.

Issue ticket number and link

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

collindutter and others added 30 commits March 29, 2024 09:47
@collindutter @dylanholmes
Feature/query engine improvements (#713)
8e04019 
Co-authored-by: dylanholmes <[email protected]>
@cjkindel
Cjkindel/api keys (#721)
d05fb3c
@andrewfrench @collindutter @vasinov
Merge patch v0.24.1 back to dev (#720)
44dd2b8 
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: Vasily Vasinov <[email protected]>
@collindutter
Improve Tool Task system prompt (#723)
7582cf8
@collindutter
Output single artifact, move value to name (#724)
76e7177
@collindutter
Add minItems to ToolkitTask actions schema (#725)
af48466
@vasinov
Add FileManager.list_files_from_disk (#726)
b1aaab5
@vachillo
Update default API version for AzureOpenAiImageGenerationDriver (#731)
f8a7b69
@collindutter
Improve readme (#727)
ef764c9
@andrewfrench @collindutter @vasinov
Backmerge main to dev for v0.24.2 (#733)
44b0653 
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: Vasily Vasinov <[email protected]>
@dylanholmes
Remove file reading responsibility from loaders (#737)
c9edaff
@collindutter
Feature/event listener drivers (#735)
c403954
@collindutter
Fix trailing slash (#740)
f4b2af7
@dylanholmes
Add LocalFileManagerDriver (#738)
3cac561
@collindutter
Add new fields to events (#742)
fa2f337
@collindutter
Remove boto3 from types (#741)
fe53d86
@dylanholmes @collindutter
Add AmazonS3FileManagerDriver (#743)
2cc293c 
Co-authored-by: Collin Dutter <[email protected]>
@andrewfrench
Add MediaArtifact (#520)
54ef8fb
@collindutter
Add docs to repo (#744)
ed08311
@collindutter
Add missing readthedocs poetry setup (#748)
fe9abf9
@collindutter
Remove references to old docs repo (#749)
b944728
@vachillo
Fix type hint for token_provider, Add missing params in `AzureOpenAiC…
77ba1a7 
…ompletionPromptDriver` openai client (#750)
@michal-repo
Add optional exception attribute to ErrorArtifact (#747)
e16f729
@dylanholmes
Edit events route in GriptapeCloudEventListenerDriver (#753)
16305a0
@collindutter
Feature/conversation memory (#751)
f16f421
@collindutter
Pull cloud url from env var (#756)
670616f
@zachgiordano
Rename GT Cloud run ID env var (#758)
30d3e29
@collindutter
Fix vector query engine exceeding token limits (#759)
f2ac9ca
@zachgiordano
Add cloud docs API Reference (#760)
9aa2f02
@collindutter
Add file utils (#745)
5c93b4e
@codecov Codecov
Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@zachgiordano zachgiordano marked this pull request as ready for review August 1, 2024 16:01
vachillo
vachillo previously approved these changes Aug 1, 2024
View reviewed changes
docs/griptape-cloud/index.md Outdated
Comment on lines 0 to 3
# Griptape Cloud

Griptape Cloud is a managed platform for running AI-powered agents, pipelines, and workflows. No newline at end of file
Managed services for your AI app stack. Deploy and scale end-to-end solutions, from LLM-powered data prep and retrieval to AI agents, pipelines and workflows.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should consider putting a nice example here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll link to the managed template and samples. I imagine we'll want to do a rewrite of this main page, so this is just a placeholder.

collindutter
collindutter requested changes Aug 1, 2024
View reviewed changes
docs/griptape-cloud/index.md Outdated
Comment on lines 2 to 3
Griptape Cloud is a managed platform for running AI-powered agents, pipelines, and workflows. No newline at end of file
Managed services for your AI app stack. Deploy and scale end-to-end solutions, from LLM-powered data prep and retrieval to AI agents, pipelines and workflows.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads a bit odd, I think it should still start with "Griptape Cloud is...

docs/griptape-cloud/structures/structure-config.md Outdated
@@ -0,0 +1,54 @@
## Structure Config File
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should start with ## Overview for consistency with other pages.

SavagePencil
SavagePencil requested changes Aug 1, 2024
View reviewed changes
docs/griptape-cloud/structures/structure-config.md Outdated
@@ -0,0 +1,54 @@
## Structure Config File

Structure repositories require a yaml configuration file which informs Griptape Cloud of your Managed Structure's dependencies and how it needs to build and run.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest removing yaml from this sentence. Had a lot of back and forth with the customer outreach on how to say "A configuration file in the YAML format" and everything I tried sounded dumb. Suggest just saying requires a configuration file and leave it at that.

docs/griptape-cloud/structures/structure-config.md Outdated

#### version

The Structure Config YAML version number.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a YAML version, or a Structure Config schema version?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can update this to say "schema" version

docs/griptape-cloud/structures/structure-config.md Outdated

#### build

The build-time configuration for the Structure. This configuration is optional.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest we call out optional things clearly. Maybe at the #### build (OPTIONAL) level?

docs/griptape-cloud/structures/structure-config.md Outdated

The build-time configuration for the Structure. This configuration is optional.

* **pre_build_install_script** - The path to your pre_build_install_script, for running during the Structure build prior to dependency installation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this path is relative to the config file's location, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I'll update to note that

@zachgiordano zachgiordano force-pushed the zach/cloud-structure-docs branch from 328f784 to 66da467 Compare August 1, 2024 22:35
@zachgiordano zachgiordano requested a review from vachillo August 1, 2024 22:36
collindutter
collindutter previously approved these changes Aug 2, 2024
View reviewed changes
vachillo
vachillo previously approved these changes Aug 2, 2024
View reviewed changes
@collindutter collindutter changed the base branch from dev to main August 2, 2024 17:06
@collindutter collindutter dismissed stale reviews from vachillo and themself August 2, 2024 17:06

The base branch was changed.

@vachillo vachillo mentioned this pull request Aug 2, 2024
Merged
1 task
@zachgiordano zachgiordano deleted the zach/cloud-structure-docs branch August 2, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vachillo vachillo vachillo left review comments

@collindutter collindutter collindutter left review comments

@derekpai derekpai Awaiting requested review from derekpai

@SavagePencil SavagePencil Awaiting requested review from SavagePencil

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.