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

API documentation does not explian data model and used concepts #140

Open
alexei-osipov opened this issue Jul 17, 2024 · 0 comments
Open

Comments

@alexei-osipov
Copy link

Please add a basic explanation of concepts used in each section of DIAL API at https://epam-rail.com/dial_api

Currently if I open https://epam-rail.com/dial_api and then click, for example, on "Prompts" section, then all what I see is a dry definition of /v1/bucket request followed by another dry definition of /v1/prompts/{Bucket}/{Prompt Path} API request. There are no even minimalistic explanation of what "Prompt" or "Bucket" means in the DIAL API. As result, it takes much more time to figure intended use of each section than it could.

Please add a basic high-level explanation of what is Deployment, Bucket, Prompt, Conversation etc. in corresponding documentation sections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant