Skip to content
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

Merged
merged 16 commits into from
Jul 1, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Jun 17, 2024

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

@szabosteve szabosteve added >docs General docs changes WIP Team:Docs Meta label for docs team v8.15.0 labels Jun 17, 2024
Copy link

Documentation preview:

@szabosteve szabosteve changed the title [DOCS] Refactors PUT inference API docs. [DOCS] Refactors PUT inference API docs Jun 17, 2024
@szabosteve szabosteve marked this pull request as ready for review June 20, 2024 09:52
Copy link
Contributor

@jonathan-buttner jonathan-buttner left a 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.

@maxhniebergall
Copy link
Member

Thanks Istvan!

@davidkyle
Copy link
Member

Thanks for making this change @szabosteve this is so much easier to read

Copy link
Contributor

@jonathan-buttner jonathan-buttner left a 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.

docs/reference/inference/service-cohere.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-google-ai-studio.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-hugging-face.asciidoc Outdated Show resolved Hide resolved
docs/reference/inference/service-mistral.asciidoc Outdated Show resolved Hide resolved
@szabosteve
Copy link
Contributor Author

@jonathan-buttner Thank you for your suggestions, Jonathan, I addressed them via 3f28ce8.

Copy link
Contributor

@jonathan-buttner jonathan-buttner left a 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
Copy link
Contributor

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.

Copy link
Contributor Author

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?

Copy link
Contributor

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

Copy link
Contributor Author

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.

@szabosteve szabosteve merged commit 43f5696 into elastic:main Jul 1, 2024
5 checks passed
@szabosteve szabosteve deleted the refactor-put-inference-api-docs branch July 1, 2024 08:12
@szabosteve szabosteve removed the WIP label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants