chore: Adding Documentation for OpenAI client #134
Conversation
KavithaSiva
requested review from
marikaner,
jjtang1985,
tomfrenken,
deekshas8 and
ZhongpinWang
There was a problem hiding this comment.
🚨 The style guide police is on its way (I am the police) ;)
I think it would be nice if we were to explain the concept of a deployment somewhere in a few words (or at least link to it).
I couldn't find anything on a resource group, which can also be passed. For me that would be fine for now as this should not be widely used anyways.
packages/foundation-models/README.md
Outdated
| const responseContent = response.getContent(); | ||
| ``` | ||
|
|
||
| It is also possible to create a chat client by passing a `deploymentId` instead of a `modelName`. |
There was a problem hiding this comment.
[req] Please try to avoid passive voice as much as possible.
[req] Please also recheck our docs style guide => instead of passing a deploymentId either use "passing the deploymentId parameter" or "passing a deployment ID"
[pp] I would explain it a little more in depth, why would you ever do that? Consider adding a subsection:
| It is also possible to create a chat client by passing a `deploymentId` instead of a `modelName`. | |
| #### Obtaining a deployment ID on your own | |
| In case you want to obtain the ID of your deployment on your own you can pass it instead of a model name. | |
| EXAMPLE |
=> as this is true for all clients this could be in some shared documentation for all of them.
There was a problem hiding this comment.
I have repeated this subsection for both clients as I don't have a shared documentation for all clients yet.
I will create a follow-up to create this shared documentation.
As a result, some information could be repeated for both clients for now.
Co-authored-by: Matthias Kuhr <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
…js into documentation-open-ai-client
…js into documentation-open-ai-client
Co-authored-by: Matthias Kuhr <[email protected]>
Co-authored-by: Matthias Kuhr <[email protected]>
There was a problem hiding this comment.
Some super minor suggestions.
I see many times that the word also was used. I get it as there are so many features in our SDK and we tend to say also. 😆
Also, I used LLM to correct the sentences. I would say maybe we can feed LLM with our styleguide and let it correct documentation automatically in the future. Robot style guide police 🤖 . @marikaner
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
KavithaSiva
dismissed
marikaner’s stale review
The PR was approved by 2 other reviewers.
Context
AI/gen-ai-hub-sdk-js-backlog#65
Definition of Done
[ ] Code is tested (Unit, E2E)[ ] Error handling created / updated & covered by the tests above[ ] (Optional) Aligned changes with the Java SDK[ ] (Optional) Release notes updated