-
Notifications
You must be signed in to change notification settings - Fork 2
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
chore: Add a doc section for harmonised API #225
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor suggestion
> | ||
> #### Harmonized API | ||
> | ||
> You can switch to a different model, even from another vendor, by leveraging the harmonized API of the orchestration service. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> You can switch to a different model, even from another vendor, by leveraging the harmonized API of the orchestration service. | |
> As the orchestration service API is harmonized, you can switch to a different model, even from another vendor, by changing only the `model_name` property. | |
> All other configurations remain the same. |
> #### Harmonized API | ||
> | ||
> You can switch to a different model, even from another vendor, by leveraging the harmonized API of the orchestration service. | ||
> Here’s an example where only one line of code is changed.. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> Here’s an example where only one line of code is changed.. | |
> Here’s an example where only one line of code is changed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[pp] Not sure if it is necessary to provide a complete example here just for changing a property. It feels hard to emphasize this advantage on written text unlike seeing a line change in a real demo.
To highlight the harmonised API, we should mention this explicitly.