[Assist] Add in SSH context Assist endpoints #30319
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
ryanclark
reviewed
Aug 11, 2023
| // acknowledgement field is used to convince the LLM to return the JSON. | ||
| // Base on my testing LLM ignores the JSON when the schema has only one field. | ||
| // Adding additional "pseudo-fields" to the schema makes the LLM return the JSON. | ||
| return fmt.Sprintf(`Generate a Bash command. |
There was a problem hiding this comment.
Should we specify something other than bash here? Maybe we could feed the prompt the OS (if we have that available during an SSH session?)
If not, something more generic would avoid the assumption the user's shell is always bash
There was a problem hiding this comment.
I think this is something that we could explore "when needed". WebUI doesn't know what OS the client is using. I'm also not sure how good OpenAI is at generating commands for different terminals. I think that the bottom line, 98% of the syntax is the same between bash, sh, zsh, fish or whatever you're using. The differences are mainly when you write a script which we don't do.
Comment on lines
+44
to
+47
| { | ||
| "command": string, \\ The generated command | ||
| "acknowledgement": boolean \\ Set to true to ackowledge that you understand the formatting | ||
| } |
There was a problem hiding this comment.
I'm not too familiar with the structure of Assist but could this generate markdown instead? We could stream it to the UI quickly if that was the case, with the suggested command going in between three backticks
There was a problem hiding this comment.
OpenAI sends the markdown back most of the time.
teleport/lib/ai/model/prompt.go
Line 104 in 8895915
|
Friendly ping @ryanclark @xacrimon |
ryanclark
approved these changes
Aug 14, 2023
xacrimon
approved these changes
Aug 14, 2023
|
lgtm but tests seem to be failing, both units and flakies |
This change introduces web endpoints used by Assist to support in SSH context functionality in the WebUI. Now a user will be able to generate Bash command and explain output in the terminal (like application logs).
This commit removes a redundant comment on the AI model selection in client.go that suggested a model change that is not needed. It also adds missing documentation in chat.go, to clarify the purpose and functionality of the Reply function.
Usage of the fake clock was failing the tests, and it's not really beneficial in this case.
jakule
force-pushed
the
jakule/assist-in-ssh-context
branch
from
8c0cf6d
to
608d3be
Compare
Fixed. That was me fixing too many things at once 😒 |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
jakule
added a commit
that referenced
this pull request
Aug 21, 2023
* Add in SSH context Assist endpoints This change introduces web endpoints used by Assist to support in SSH context functionality in the WebUI. Now a user will be able to generate Bash command and explain output in the terminal (like application logs). * Remove mockup web UI * Make the linter happy * Remove unnecessary comments and add missing documentation This commit removes a redundant comment on the AI model selection in client.go that suggested a model change that is not needed. It also adds missing documentation in chat.go, to clarify the purpose and functionality of the Reply function. * Revert ws.WriteControl to use real time. Usage of the fake clock was failing the tests, and it's not really beneficial in this case.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 22, 2023
* assist: move embeddings in a separate library, add tool config, opportunistic node lookup (#29716) * assist: extract embedding types into a dedicated module * assist: allow the embedding tool to query nodes from proxy cache This commit does two things: - Introduce a new toolsConfig structure to pass all required clients to the tools. This can also be used to enable or disable specicifc tools, which helps with testing - Pass the proxy node cache and the request access checker to the embedding tool so it can try to lookup nodes from cache in if the user has less than 10 nodes available. * Add tests for the opportunistic proxy node lookup * Apply suggestions from code review * Update lib/ai/client.go * [Assist] Add Assist to the terminal UI (#30496) * Add Assist to the terminal UI * Use getPlatform() * Fix spacing beneath the message box * [Assist] Add in SSH context Assist endpoints (#30319) * Add in SSH context Assist endpoints This change introduces web endpoints used by Assist to support in SSH context functionality in the WebUI. Now a user will be able to generate Bash command and explain output in the terminal (like application logs). * Remove mockup web UI * Make the linter happy * Remove unnecessary comments and add missing documentation This commit removes a redundant comment on the AI model selection in client.go that suggested a model change that is not needed. It also adds missing documentation in chat.go, to clarify the purpose and functionality of the Reply function. * Revert ws.WriteControl to use real time. Usage of the fake clock was failing the tests, and it's not really beneficial in this case. * Replace caret symbol with Windows key in Terminal utility (#30642) The caret symbol (^) previously used in the Terminal utility was not universally recognized or understanding. To increase usability, it has been replaced with the Windows key symbol (⊞). This should make the tool more intuitive to use for a wider range of users. * [Assist] Add AssistAction and AssistAccessRequest PostHog event reporting (#30513) * Add AssistAction and AssistAccessRequest PostHog event reporting This commit introduced new usage tracking for Assist features. AssistAction event is emitted when user triggers an action like SSH command generation or output explaining. AssistAccessRequest event is fired when user requests access to a resource. The events capture anonymized username, resource type or action triggered, and a breakdown of tokens used for generating command summaries or completion responses. * "Removed userName in AssistAccessRequest and AssistAction" Both "AssistAccessRequest" and "AssistAction" messages in usageevents.proto file and their corresponding Go structures were modified to remove the "userName" field. * Add GoDoc --------- Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com> Co-authored-by: Ryan Clark <ryan.clark@goteleport.com>
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.
This change introduces web endpoints used by Assist to support SSH context functionality in the WebUI. Now a user will be able to generate Bash command and explain output in the terminal (like application logs).
Posthog events will be introduced in a following PR.
Closes https://github.com/gravitational/teleport.e/issues/1986