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

[E&A] Drafts initial conceptual docs for EIS #733

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Mar 11, 2025

Overview

Related to https://github.com/elastic/search-docs-team/issues/245

This PR adds the initial conceptual documentation about EIS to the E&A/Elastic Inference section.

Preview

EIS

Verified

This commit was signed with the committer’s verified signature.
szabosteve István Zoltán Szabó

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was signed with the committer’s verified signature.
szabosteve István Zoltán Szabó

Verified

This commit was signed with the committer’s verified signature.
szabosteve István Zoltán Szabó
…ontent into szabosteve/conceptual-eis

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few ideas about this overview, LMKWYT :)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

Verified

This commit was signed with the committer’s verified signature.
szabosteve István Zoltán Szabó

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link

@maxjakob maxjakob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for starting this 🙏 I left a bunch of suggestions.

Generally, I would suggest a slightly different structure to not break the flow of Inference API-related info:

  • Intro
  • AI features powered by EIS
  • Available task types
  • Default EIS endpoints
    • Examples (as sub-heading as this uses the default endpoint)
  • Regions

Of course these are all just suggestions :)

Also note that I'm not 100% sure we want to encourage Inference API usage at all. We should share this with Shubha soon.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Max Jakob <max.jakob@elastic.co>

Verified

This commit was signed with the committer’s verified signature.
szabosteve István Zoltán Szabó

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@maxjakob
Copy link

Looks good 👍 We just need to clarify if we want to even document the Inference API usage.

@szabosteve szabosteve requested a review from shubhaat March 17, 2025 12:37
Copy link

@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! I'll defer to Max and the search team if they want the inference API documented.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was signed with the committer’s verified signature.
szabosteve István Zoltán Szabó
@shubhaat
Copy link

@szabosteve we discussed this in the EIS leads meeting today, and have a few major changes to the plan. Given that the first release is for the LLM to be available only for the AI assistants, and we are not telling customers the underlying model, we want to perhaps only update EIS docs when we introduce ELSER in 9.1/8.19.

For now we only want to update the AI Assistant docs and the Playground docs to include that we now host a default LLM (ElasticLLM) that is available out of the box. The ElasticLLM is hosted as a service and will entail additional charges as per our pricing. We should link out to the pricing page.

@szabosteve
Copy link
Contributor Author

@shubhaat Thank you for the heads-up! I'll leave this PR open and amend it as necessary when we are ready to publish the docs in 9.1.

@szabosteve szabosteve marked this pull request as draft March 26, 2025 14:11

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation inference
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants