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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Obs AI Assistant connector #183792

Merged
merged 10 commits into from
May 31, 2024
Merged

[DOCS] Obs AI Assistant connector #183792

merged 10 commits into from
May 31, 2024

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented May 18, 2024 •
edited

Summary

Adds reference documentation about the Obs AI Assistant connector (requested in #181282)

Click to see the preview here

This should be reviewed along side elastic/observability-docs#3906 (AI Assistant docs about using this feature).

Questions

  • Where are the api:observabilityAIAssistant and app:observabilityAIAssistant privileges documented and how are they specified? I don't see these privileges under available feature privileges in the Kibana docs at https://www.elastic.co/guide/en/kibana/master/kibana-privileges.html#kibana-feature-privileges. (I do see all or none privileges for the Observability AI Assistant.)
  • @lcawl Should we be generating the screen captures used in this topic? If so, let me know what file(s) I need to update.

TODO (after merging):

@dedemorton dedemorton self-assigned this May 18, 2024
@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@dedemorton dedemorton mentioned this pull request May 18, 2024
Merged
5 tasks
@dedemorton dedemorton requested a review from lcawl May 24, 2024 23:14
@dedemorton dedemorton marked this pull request as ready for review May 24, 2024 23:15
@dedemorton dedemorton requested a review from a team as a code owner May 24, 2024 23:15
@dedemorton dedemorton added release_note:skip Skip the PR/issue when compiling release notes v8.14.0 docs Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework Team:obs-knowledge Observability Experience Knowledge team labels May 24, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-knowledge-team (Team:obs-knowledge)

@lcawl
Copy link
Contributor

lcawl commented May 27, 2024 •
edited

Should we be generating the screen captures used in this topic? If so, let me know what file(s) I need to update.

I generated the case connector screenshot on the Elasticsearch query rule creation script:
https://github.com/elastic/kibana/blob/main/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/es_query_rule.ts#L134

This screenshot will be more complex, however. The act of pasting the example text into the observabilityAiAssistantAlertConnectorMessageTextArea shouldn't be difficult and can be copied from other screenshot-generation scripts (e.g. https://github.com/elastic/kibana/blob/main/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_connectors/generative_ai_connector.ts#L41). The tricky part will be having the OpenAI or Amazon Bedrock connector configured in order to have something to pick for the connector dropdown. It looks like there are BedrockSimulator and OpenAISimulator in some other test suites that might work. Alternatively, you could leave that drop-down empty. If you want to discuss further, lmk!

@dedemorton
Copy link
Contributor Author

@elasticmachine merge upstream

@dedemorton
Copy link
Contributor Author

This screenshot will be more complex

@lcawl Ah OK. We can maintain this screenshot manually for now. I'll create a follow-up issue to remind us to generate it.

@dedemorton dedemorton mentioned this pull request May 28, 2024
Open
klacabane
klacabane approved these changes May 30, 2024
View reviewed changes
Copy link
Contributor

@klacabane klacabane left a comment

Choose a reason for hiding this comment

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

LGTM!

@dedemorton
Copy link
Contributor Author

@klacabane Thanks for reviewing. Do you know the answer to the following question? Should I document users must have All Kibana privileges for the Observability AI Assistant feature? Or is there some way to assign the more granular privileges?

Here's the question:
Where are the api:observabilityAIAssistant and app:observabilityAIAssistant privileges documented and how are they specified? I don't see these privileges under available feature privileges in the Kibana docs at https://www.elastic.co/guide/en/kibana/master/kibana-privileges.html#kibana-feature-privileges. (I do see all or none privileges for the Observability AI Assistant.)

@dgieselaar
Copy link
Member

@dedemorton these are implied access tags that are granted by giving the user access to the feature. Eg, we register a Kibana feature for the Observability AI Assistant, and then the user has access to any endpoints tagged with api: observabilityAiAssistant. I would say it's more of an implementation detail than something that would need to be documented. I am on mobile so I cannot confirm the exact tags.

@dedemorton
Copy link
Contributor Author

@lcawl I need code owner approval to merge this. Are you The One? :-)

@mergify mergify bot mentioned this pull request May 30, 2024
Merged
@dedemorton dedemorton merged commit 310f4ff into elastic:main May 31, 2024
5 checks passed
@dedemorton dedemorton deleted the issue#181282 branch May 31, 2024 18:26
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 31, 2024
@dedemorton
[DOCS] Obs AI Assistant connector (elastic#183792)
b0af268 
## Summary

Adds reference documentation about the Obs AI Assistant connector
(requested in elastic#181282)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 310f4ff)
@kibanamachine kibanamachine mentioned this pull request May 31, 2024
Merged
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.14

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request May 31, 2024
@kibanamachine @dedemorton
[8.14] [DOCS] Obs AI Assistant connector (#183792) (#184609)
9a783d7 
# Backport

This will backport the following commits from `main` to `8.14`:
- [[DOCS] Obs AI Assistant connector
(#183792)](#183792)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"DeDe
Morton","email":"dede.morton@elastic.co"},"sourceCommit":{"committedDate":"2024-05-31T18:26:12Z","message":"[DOCS]
Obs AI Assistant connector (#183792)\n\n## Summary\r\n\r\nAdds reference
documentation about the Obs AI Assistant connector\r\n(requested in
#181282)\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"310f4ff79cbe5d2ec7e699d9ffb3aefdc51da9ec","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Feature:Actions/ConnectorTypes","Team:obs-knowledge","v8.14.0","v8.15.0"],"title":"[DOCS]
Obs AI Assistant
connector","number":183792,"url":"#183792
Obs AI Assistant connector (#183792)\n\n## Summary\r\n\r\nAdds reference
documentation about the Obs AI Assistant connector\r\n(requested in
#181282)\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"310f4ff79cbe5d2ec7e699d9ffb3aefdc51da9ec"}},"sourceBranch":"main","suggestedTargetBranches":["8.14"],"targetPullRequestStates":[{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"#183792
Obs AI Assistant connector (#183792)\n\n## Summary\r\n\r\nAdds reference
documentation about the Obs AI Assistant connector\r\n(requested in
#181282)\r\n\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>","sha":"310f4ff79cbe5d2ec7e699d9ffb3aefdc51da9ec"}}]}]
BACKPORT-->

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
This was referenced May 31, 2024
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@klacabane klacabane klacabane approved these changes

@lcawl lcawl lcawl approved these changes

Assignees

@dedemorton dedemorton

Labels
docs Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework release_note:skip Skip the PR/issue when compiling release notes Team:obs-knowledge Observability Experience Knowledge team v8.14.0 v8.15.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@dedemorton @apmmachine @elasticmachine @lcawl @dgieselaar @kibanamachine @klacabane