You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The README places links to OpenAI's reference documentation above the fold (at the very beginning), creating the impression that the library's methods have the same name as the path of the OpenAI endpoints. For example, it may be common for new users of the library to assume Completions are accessed by a method names "completions" such as:
$openai->completion() (spelled singular)
since the linked OpenAI reference documentation for "completions" endpoint describes endpoint as
Yet, the library's method is completion (spelled singular)
$openai->completion() (spelled singular)
This is made clear further down the README, but it's possible many new users will get sidetracked following links to OpenAI's reference and trying to copy the endpoint paths as library method names. Suggest several possible fixes:
At the top of the Readme, calling out the fact method names are described further down the README.
Create a prominent table mapping the OpenAI Reference endpoints to the library's methods.
Thnx
To Reproduce
$openai->completion()
Code snippets
No response
OS
Linux
PHP version
PHP 7.4
Library version
openai v3
The text was updated successfully, but these errors were encountered:
Thanks but I'm not sure this is indispensable, but Ill watch the feedback if we get a lot of requests about this feature. I'll take a look. now pr is closing
Describe the bug
The README places links to OpenAI's reference documentation above the fold (at the very beginning), creating the impression that the library's methods have the same name as the path of the OpenAI endpoints. For example, it may be common for new users of the library to assume Completions are accessed by a method names "completions" such as:
since the linked OpenAI reference documentation for "completions" endpoint describes endpoint as
POST https://api.openai.com/v1/completions (spelled plural)
Yet, the library's method is completion (spelled singular)
This is made clear further down the README, but it's possible many new users will get sidetracked following links to OpenAI's reference and trying to copy the endpoint paths as library method names. Suggest several possible fixes:
At the top of the Readme, calling out the fact method names are described further down the README.
Create a prominent table mapping the OpenAI Reference endpoints to the library's methods.
Thnx
To Reproduce
$openai->completion()
Code snippets
No response
OS
Linux
PHP version
PHP 7.4
Library version
openai v3
The text was updated successfully, but these errors were encountered: