docs: [OpenAI] Update documentation and release notes for new api #354
Conversation
This file contains hidden or 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
rpanackal
commented
Feb 27, 2025
Comment on lines
127
to
137
| Since v1.4.0 | ||
|
|
||
| ```java | ||
| var request = | ||
| new OpenAiChatCompletionRequest( | ||
| OpenAiMessage.system("I'm fine, thank you!"), | ||
| OpenAiMessage.user("Hello, how are you?")); | ||
|
|
||
| var response = OpenAiClient.forModel(GPT_4O).chatCompletion(request).getContent(); | ||
| ``` | ||
|
|
Member
Author
There was a problem hiding this comment.
Yet to add link to sample app as the latest service class not advertised and maintained in test package.
- True for all new added samples
| ### 🔧 Compatibility Notes | ||
|
|
||
| - The constructors `UserMessage(MessageContent)` and `SystemMessage(MessageContent)` are removed. Use `Message.user(String)`, `Message.user(ImageItem)`, or `Message.system(String)` instead. | ||
| - [Orchestration] The constructors `UserMessage(MessageContent)` and `SystemMessage(MessageContent)` are removed. Use `Message.user(String)`, `Message.user(ImageItem)`, or `Message.system(String)` instead. |
Member
Author
There was a problem hiding this comment.
Its time we have a format to clarify which module a change is about?
Member
There was a problem hiding this comment.
I would say that it makes sense to put [module] in front if it is just one line. For multiple changes in the same line we should probably do what we did before:
- Module
- change 1
- change 2
Jonas-Isr
requested changes
Feb 27, 2025
Member
Jonas-Isr
left a comment
Jonas-Isr
left a comment
There was a problem hiding this comment.
Just some very minor things.
Otherwise LGTM!
| ### 🔧 Compatibility Notes | ||
|
|
||
| - The constructors `UserMessage(MessageContent)` and `SystemMessage(MessageContent)` are removed. Use `Message.user(String)`, `Message.user(ImageItem)`, or `Message.system(String)` instead. | ||
| - [Orchestration] The constructors `UserMessage(MessageContent)` and `SystemMessage(MessageContent)` are removed. Use `Message.user(String)`, `Message.user(ImageItem)`, or `Message.system(String)` instead. |
Member
There was a problem hiding this comment.
I would say that it makes sense to put [module] in front if it is just one line. For multiple changes in the same line we should probably do what we did before:
- Module
- change 1
- change 2
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.
Context
AI/ai-sdk-java-backlog#172.
Feature scope:
Definition of Done
Functionality scope stated & coveredTests cover the scope aboveError handling created / updated & covered by the tests aboveAligned changes with the JavaScript SDK