[Obs AI Assistant] Update README.md #180786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgieselaar
added
release_note:skip
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
x-pack/plugins/observability_solution/observability_ai_assistant/README.md
Outdated
Show resolved
Hide resolved
sorenlouv
reviewed
Apr 15, 2024
x-pack/plugins/observability_solution/observability_ai_assistant/README.md
Show resolved
Hide resolved
sorenlouv
reviewed
Apr 15, 2024
x-pack/plugins/observability_solution/observability_ai_assistant/README.md
Outdated
Show resolved
Hide resolved
sorenlouv
reviewed
Apr 15, 2024
|
|
||
| #### **2.1** Functions | ||
|
|
||
| Functions are the heartbeat of the Assistant. It allows the LLM to pull data from the Platform, rather than us just pushing it. |
There was a problem hiding this comment.
I think it's worth pointing out that functions should be used in open-ended scenarios where they don't know what data the user needs. Functions shouldn't be used if the developer knows what data they want fetched. In that case they should fetch it explicitly and add it to the conversation
sorenlouv
reviewed
Apr 15, 2024
| import { createScreenContext } from '@kbn/observability-ai-assistant-plugin/public'; | ||
| useEffect(() => { | ||
| return observabilityAIAssistant?.service.setScreenContext({ | ||
| actions: createScreenContextAction( |
There was a problem hiding this comment.
From this example it's not clear to me what createScreenContextAction does or how the action is invoked. An example where myProperty was actually used and made sense would help
There was a problem hiding this comment.
yeah I forgot to finish the createScreenContext explanation above. will add!
sorenlouv
reviewed
Apr 15, 2024
| }, [observabilityAIAssistant?.service, moveToUrl]); | ||
| ``` | ||
|
|
||
| `navigate` is a utility function that waits until the network is silent for at least a second, and then sends the screen context from the new page back to the Assistant. `createScreenContext` is a utility |
There was a problem hiding this comment.
Is that a made up example or does navigate actually exist?
There was a problem hiding this comment.
Huh 😄 I think I only implemented this in a POC. I'll remove this part and re-add it if I ever find the code again 😭
…nt/README.md Co-authored-by: Søren Louv-Jansen <[email protected]>
sorenlouv
approved these changes
Apr 25, 2024
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Apr 25, 2024
Updates the README file w/ the new screen context API. --------- Co-authored-by: Søren Louv-Jansen <[email protected]> (cherry picked from commit dd15fba)
💚 All backports created successfully
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
Apr 25, 2024
# Backport This will backport the following commits from `main` to `8.14`: - [[Obs AI Assistant] Update README.md (#180786)](#180786) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Dario Gieselaar","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-04-25T11:42:52Z","message":"[Obs AI Assistant] Update README.md (#180786)\n\nUpdates the README file w/ the new screen context API.\r\n\r\n---------\r\n\r\nCo-authored-by: Søren Louv-Jansen <[email protected]>","sha":"dd15fba4e3d86ae2683b7cbc1a7720ba562f5f73","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Obs AI Assistant","v8.14.0","v8.15.0"],"title":"[Obs AI Assistant] Update README.md","number":180786,"url":"https://github.com/elastic/kibana/pull/180786","mergeCommit":{"message":"[Obs AI Assistant] Update README.md (#180786)\n\nUpdates the README file w/ the new screen context API.\r\n\r\n---------\r\n\r\nCo-authored-by: Søren Louv-Jansen <[email protected]>","sha":"dd15fba4e3d86ae2683b7cbc1a7720ba562f5f73"}},"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":"https://github.com/elastic/kibana/pull/180786","number":180786,"mergeCommit":{"message":"[Obs AI Assistant] Update README.md (#180786)\n\nUpdates the README file w/ the new screen context API.\r\n\r\n---------\r\n\r\nCo-authored-by: Søren Louv-Jansen <[email protected]>","sha":"dd15fba4e3d86ae2683b7cbc1a7720ba562f5f73"}}]}] BACKPORT--> Co-authored-by: Dario Gieselaar <[email protected]>
kpatticha
pushed a commit
to kpatticha/kibana
that referenced
this pull request
Apr 26, 2024
Updates the README file w/ the new screen context API. --------- Co-authored-by: Søren Louv-Jansen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the README file w/ the new screen context API.