-
Notifications
You must be signed in to change notification settings - Fork 24.5k
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
[DOCS] Refactors PUT inference API docs #109812
[DOCS] Refactors PUT inference API docs #109812
Conversation
Documentation preview: |
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.
Overall it's looking good. Each service that supports text_embedding
will have a few of the same service settings so I think it'd make sense to have each service have its own collapsable section for service_settings
. We can work on adding the exact settings that are missing in a separate PR though.
Thanks Istvan! |
…ve/elasticsearch into refactor-put-inference-api-docs
Thanks for making this change @szabosteve this is so much easier to read |
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.
Looking great, left a few more suggestions.
@jonathan-buttner Thank you for your suggestions, Jonathan, I addressed them via 3f28ce8. |
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.
Looks good! One last change.
`model_id`:: | ||
(Optional, string) | ||
The name of the model to use for the {infer} task. | ||
To review the available `rerank` models, refer to the |
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.
Let's update rerank
here to completion
and update the doc link below.
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.
Nice catch, thanks!
However, I haven't found a page on Cohere's side to link to. Am I missing something?
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.
I think these are the chat completion models: https://docs.cohere.com/docs/models#command
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.
@jonathan-buttner Thank you, I updated the PR via d8769ec.
Overview
This PR refactors the PUT inference API docs to list the available services in standalone pages for ease of use.
Preview
PUT Inference API