ai-dial icon indicating copy to clipboard operation
ai-dial copied to clipboard

API documentation does not explian data model and used concepts

Open alexei-osipov opened this issue 1 year ago • 0 comments

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.

alexei-osipov avatar Jul 17 '24 20:07 alexei-osipov