chore: Add a doc section for harmonised API #225
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ZhongpinWang
approved these changes
Oct 21, 2024
| > | ||
| > #### 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.
Suggested change
| > 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.
Suggested change
| > 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.
[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.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To highlight the harmonised API, we should mention this explicitly.