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.

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

docs: add assistant guidelines #138

Merged
merged 13 commits into from
Oct 2, 2024
Merged

docs: add assistant guidelines #138

merged 13 commits into from
Oct 2, 2024

Conversation

Martin-Hoppe
Copy link
Contributor

@Martin-Hoppe Martin-Hoppe commented Sep 20, 2024

Fixes #134

@mirkolenz
Copy link
Member

The content looks good, thank you! I did some formatting and renamed the file. One thing to be added to this guide could be a small explanation of the new parameters the assistant now has. These mostly mimic the OpenAI API Parameters as described here: https://platform.openai.com/docs/api-reference/chat/create

Would be nice to have concise descriptions for these so that non-developers get an idea how to tweak the output.

Add parameter descriptions
@mirkolenz
Copy link
Member

Thanks, the new descriptions are looking good! One last thing that came to my mind: Could you add some more information the the two example workflows based on your experience (i.e., which types of texts work good for generating the entire graph, which ones would require the user to perform the steps individually and correct potential errors). Thank you!

@mirkolenz mirkolenz changed the title Add assistant guidelines markdown for Issue #134 docs: add assistant guidelines Oct 2, 2024
@mirkolenz mirkolenz merged commit cc80835 into recap-utr:main Oct 2, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write documentation/guidelines for the assistant feature
2 participants