[DOCS][ML UI][9.x & Serverless] Host Elastic documentation for AI assistant#5613
[DOCS][ML UI][9.x & Serverless] Host Elastic documentation for AI assistant#5613nastasha-solomon merged 23 commits intomainfrom
Conversation
Adjusts changes that were made in #5521
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
…ost-doc-artifacts.md
|
|
||
| For example, when {{kib}} is 9.0, the four ZIP files are: | ||
|
|
||
| * `kb-product-doc-elasticsearch-9.0.zip` |
There was a problem hiding this comment.
Just a heads up, in 9.4, we are adding a new zip file called kb-product-doc-openapi-9.4.zip which will be installed at the same time as these 4 files. The zip file will support elastic/kibana#255717, which dynamically generates elasticsearch tools for the agent builder. So customer should also install that for 9.4+ version after the PR is merged.
Vale Linting ResultsSummary: 2 warnings, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 48 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 48 | Elastic.DontUse | Don't use 'just'. |
💡 Suggestions (1)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 48 | Elastic.FirstPerson | Use caution when using first-person pronouns such as 'me.' |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
yetanothertw
left a comment
There was a problem hiding this comment.
The Admin docs-related changes look good, thanks!
Approving to unblock, but left a suggestion to simplify that last paragraph.
florent-leborgne
left a comment
There was a problem hiding this comment.
Really nice, leaving a suggestion regarding the "titles inside of tabs" issue that I think we should fix
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
|
Thanks for the early feedback @yetanothertw and @florent-leborgne . I'm actually still working on this PR, which is why I reverted it back to draft mode. |
mdbirnstiehl
left a comment
There was a problem hiding this comment.
LGTM! I had a couple of little things that may or may not make sense.
| children: | ||
| - file: ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md | ||
| - file: ai-features/ai-chat-experiences/ai-assistant.md | ||
| - file: ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md |
There was a problem hiding this comment.
Would it make sense for this to be nested under AI assistants?
There was a problem hiding this comment.
I think either could work. Moving this page under "AI assistants in Kibana" makese sense from a TOC hierarchy perspective. But there's also a chance it could be misinterpreted as being "the next step" in setting up the assistant, when it's really just an option for certain users (folks on air-gapped or restricted networks). Keeping it on the same level as "AI assistants in Kibana" fosters a stronger relationship with the top level title "AI chat experiences", which might be more relevant. I'm really not sure tho - you and @benironside are the experts here, so I'll defer to you. : )
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
…ost-doc-artifacts.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com>
…Assistant settings (#259418) ## Summary This PR docs the new `xpack.productDocBase.artifactRepositoryProxyUrl` setting and refocuses the scope of the page to only cover Kibana settings for configuring the knowledge base artifact repo URL. ### Major changes - **Procedural content removed**: Step-by-step guidance for tasks such as mirroring artifacts to S3 or a CDN, bucket listings, restart flows, and similar has been removed from the page since it doesn't fit the page's content type. The content is being re-added to the docs as a new page within the [AI chat experiences](https://www.elastic.co/docs/explore-analyze/ai-features/ai-chat-experiences) section via elastic/docs-content#5613. - **Title and framing updated**: The page title and navigation label now describe knowledge base artifact settings for the AI assistants. The former title (“AI Assistant settings”) was a tad too broad in scope. - **Setting descriptions expanded**: Both settings are documented to show how they should be used for internet-connected deployments or restricted/isolated setups. ### Related - Companion docs-content PR: ~elastic/docs-content#5521~ elastic/docs-content#5613 - Docs issue: elastic/docs-content#5519 - Implementation PR: #250771 - Scoping issue: #244738 ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### Release note Document `xpack.productDocBase.artifactRepositoryProxyUrl` setting for configuring HTTP proxy access to the AI Assistant knowledge base artifact repository. Made with [Cursor](https://cursor.com) --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md
Show resolved
Hide resolved
…Assistant settings (elastic#259418) ## Summary This PR docs the new `xpack.productDocBase.artifactRepositoryProxyUrl` setting and refocuses the scope of the page to only cover Kibana settings for configuring the knowledge base artifact repo URL. ### Major changes - **Procedural content removed**: Step-by-step guidance for tasks such as mirroring artifacts to S3 or a CDN, bucket listings, restart flows, and similar has been removed from the page since it doesn't fit the page's content type. The content is being re-added to the docs as a new page within the [AI chat experiences](https://www.elastic.co/docs/explore-analyze/ai-features/ai-chat-experiences) section via elastic/docs-content#5613. - **Title and framing updated**: The page title and navigation label now describe knowledge base artifact settings for the AI assistants. The former title (“AI Assistant settings”) was a tad too broad in scope. - **Setting descriptions expanded**: Both settings are documented to show how they should be used for internet-connected deployments or restricted/isolated setups. ### Related - Companion docs-content PR: ~elastic/docs-content#5521~ elastic/docs-content#5613 - Docs issue: elastic/docs-content#5519 - Implementation PR: elastic#250771 - Scoping issue: elastic#244738 ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### Release note Document `xpack.productDocBase.artifactRepositoryProxyUrl` setting for configuring HTTP proxy access to the AI Assistant knowledge base artifact repository. Made with [Cursor](https://cursor.com) --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…tings - PT 2 (#260113) ## Summary This PR is a continuation of #259418. It uncomments the reference to the "Host a knowledge base artifact repo for AI assistants" page, which is being added to the narrative docs in [a separate PR](elastic/docs-content#5613). **Note:** Must merge elastic/docs-content#5613 for the CI checks in this PR to go green.
…Assistant settings (elastic#259418) ## Summary This PR docs the new `xpack.productDocBase.artifactRepositoryProxyUrl` setting and refocuses the scope of the page to only cover Kibana settings for configuring the knowledge base artifact repo URL. ### Major changes - **Procedural content removed**: Step-by-step guidance for tasks such as mirroring artifacts to S3 or a CDN, bucket listings, restart flows, and similar has been removed from the page since it doesn't fit the page's content type. The content is being re-added to the docs as a new page within the [AI chat experiences](https://www.elastic.co/docs/explore-analyze/ai-features/ai-chat-experiences) section via elastic/docs-content#5613. - **Title and framing updated**: The page title and navigation label now describe knowledge base artifact settings for the AI assistants. The former title (“AI Assistant settings”) was a tad too broad in scope. - **Setting descriptions expanded**: Both settings are documented to show how they should be used for internet-connected deployments or restricted/isolated setups. ### Related - Companion docs-content PR: ~elastic/docs-content#5521~ elastic/docs-content#5613 - Docs issue: elastic/docs-content#5519 - Implementation PR: elastic#250771 - Scoping issue: elastic#244738 ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### Release note Document `xpack.productDocBase.artifactRepositoryProxyUrl` setting for configuring HTTP proxy access to the AI Assistant knowledge base artifact repository. Made with [Cursor](https://cursor.com) --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…tings - PT 2 (elastic#260113) ## Summary This PR is a continuation of elastic#259418. It uncomments the reference to the "Host a knowledge base artifact repo for AI assistants" page, which is being added to the narrative docs in [a separate PR](elastic/docs-content#5613). **Note:** Must merge elastic/docs-content#5613 for the CI checks in this PR to go green.
…Assistant settings (elastic#259418) ## Summary This PR docs the new `xpack.productDocBase.artifactRepositoryProxyUrl` setting and refocuses the scope of the page to only cover Kibana settings for configuring the knowledge base artifact repo URL. ### Major changes - **Procedural content removed**: Step-by-step guidance for tasks such as mirroring artifacts to S3 or a CDN, bucket listings, restart flows, and similar has been removed from the page since it doesn't fit the page's content type. The content is being re-added to the docs as a new page within the [AI chat experiences](https://www.elastic.co/docs/explore-analyze/ai-features/ai-chat-experiences) section via elastic/docs-content#5613. - **Title and framing updated**: The page title and navigation label now describe knowledge base artifact settings for the AI assistants. The former title (“AI Assistant settings”) was a tad too broad in scope. - **Setting descriptions expanded**: Both settings are documented to show how they should be used for internet-connected deployments or restricted/isolated setups. ### Related - Companion docs-content PR: ~elastic/docs-content#5521~ elastic/docs-content#5613 - Docs issue: elastic/docs-content#5519 - Implementation PR: elastic#250771 - Scoping issue: elastic#244738 ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### Release note Document `xpack.productDocBase.artifactRepositoryProxyUrl` setting for configuring HTTP proxy access to the AI Assistant knowledge base artifact repository. Made with [Cursor](https://cursor.com) --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…tings - PT 2 (elastic#260113) ## Summary This PR is a continuation of elastic#259418. It uncomments the reference to the "Host a knowledge base artifact repo for AI assistants" page, which is being added to the narrative docs in [a separate PR](elastic/docs-content#5613). **Note:** Must merge elastic/docs-content#5613 for the CI checks in this PR to go green.
Summary
This PR fixes #5519 and continues work started in elastic/kibana#259418. More details are below in the section requesting reviews.
Generative AI disclosure
Cursor + Composer 2
Reviews needed
This PR needs an editorial, technical, and code owner review. Instructions for each are below.
📋 What this PR does
This PR adds Host a knowledge base artifact repo for AI assistants (a new page) to the AI chat experiences section. It ports and reorganizes procedural content that previously lived in the Kibana AI Assistant settings reference, and adds net-new content (generated with AI assistance) covering three hosting options for air-gapped or restricted network deployments: S3-compatible bucket, CDN, and local file path.
Several other files have minor updates to replace or add cross-references pointing to the new page.
📁 Files changed
explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.mdexplore-analyze/toc.ymldeploy-manage/deploy/self-managed/air-gapped-install.mdapplies_totag changed fromstacktoself; updated cross-referenceexplore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.mdsolutions/observability/ai/observability-ai-assistant.mdsolutions/security/ai/ai-assistant-knowledge-base.md✏️ Editorial reviewer
Please review the new page and the updated cross-references for:
viaon line 10 of the new file — please confirm the fix. Check for any other style issues (tone, active voice, second person, etc.).🔧 Technical reviewer
Please review the new page for technical accuracy. The net-new content especially needs validation. Focus on:
kb-product-doc-{product}-{major}.{minor}.zip) accurate? Are the example filenames for 9.0 correct and complete? (Note: The tech reviewer has flagged that in 9.4, a newkb-product-doc-openapi-9.4.zipwill be added. This will be doc'd in a separate PR once the implementation PR adding that zip file is merged.)ListObjectsresponse, object key requirements) accurate? Are there missing edge cases or gotchas?file://URI approach described correctly? Are the permissions guidance and constraints accurate?xpack.productDocBase.artifactRepositoryUrl: Are the configuration examples and constraints correct?Related Kibana PR for context: elastic/kibana#259418
👤 Area/Code owner reviewers
Please review only the files listed for you below and confirm that the changes to your area are correct, don't introduce inaccuracies, and don't conflict with anything in progress or recently merged.
@mdbirnstiehl please review:
solutions/observability/ai/observability-ai-assistant.mdandexplore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.md: Updated cross-references@benironside please review:
solutions/security/ai/ai-assistant-knowledge-base.md: Updated cross-referenceIs the change technically correct?
Does it accurately represent the behavior/feature in your area?
Does it conflict with anything in progress or recently merged?
Are there missing details or anything that could mislead users?