Skip to content

Commit f8c9980

Browse files
committed
Add initial placeholder for PA
1 parent c1eb4be commit f8c9980

File tree

1 file changed

+38
-36
lines changed

1 file changed

+38
-36
lines changed

assistant.qmd

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Positron Assistant"
44

55
::: {.callout-note}
66

7-
The Positron Assistant is currently an experimental feature in Positron. We are actively improving the user experience and functionality, so please provide feedback and report any issues you encounter.
7+
The Positron Assistant is currently an experimental feature in Positron, available in 2025.06.0-167 and beyond. We are actively improving the user experience and functionality, so please provide feedback and report any issues you encounter.
88

99
:::
1010

@@ -26,7 +26,7 @@ A few examples include:
2626

2727
All of that Positron-specific context is in addition to the core capabilities of what traditional software-oriented GenAI clients have (active file(s), selected line(s) of code, files in project, training data in the model, etc).
2828

29-
## Get Started
29+
## Get started
3030

3131
The general steps to use Positron Assistant are:
3232

@@ -63,22 +63,20 @@ Positron Assistant is not enabled by default. Follow these steps to enable it:
6363

6464
## Configuring Positron Assistant
6565

66-
### Adding Language Models
67-
68-
Anthropic and Github Copilot are the currently supported language model providers for Positron Assistant. Anthropic Claude is available for sidebar chat and inline chat, while Github Copilot is available for inline code completions only.
69-
70-
#### Pre-requisites
71-
72-
Currently, Positron Assistant uses a bring-your-own API key model, so you'll need to get keys set up ahead of time and bring those into Positron.
66+
Currently, Positron Assistant uses a bring-your-own API key model for Anthropic, so you'll need to get keys set up ahead of time and bring those into Positron. GitHub Copilot uses an OAuth flow for authentication, so you will need to have a GitHub account with Copilot enabled.
7367

7468
- **Chat model providers:** Anthropic Claude is available for sidebar chat and inline chat.
7569
- **Inline code completion model providers:** only GitHub Copilot is available. Positron's status bar will show registered inline code completion providers in the robot icon tooltip in the bottom-right of the Positron window.
7670

77-
If you don't already have API keys for these providers, see the [Language Model Provider API Keys](#language-model-provider-api-keys-authentication) section below for instructions on how to get them, before continuing with the steps below.
71+
If you don't already have API keys or an account for these providers, see the [Language Model Provider API Keys](#language-model-provider-api-keys-authentication) section below for instructions on how to get them, before continuing with the steps below.
7872

79-
#### Signing into Language Model Providers
73+
### Managing language model providers
8074

81-
1. Run the `Positron Assistant: Add Language Model` command to open the language model dialog. You can also click the "Add Language Model" button in the Positron Assistant chat area (note: the button may be collapsed within the `...` context menu).
75+
Anthropic and Github Copilot are the currently supported language model providers for Positron Assistant. Anthropic Claude is available for sidebar chat and inline chat, while Github Copilot is available for inline code completions only.
76+
77+
#### Adding language model providers
78+
79+
1. Run the `Positron Assistant: Add Language Model` command to open the language model provider dialog. You can also click the "Add Language Model provider" button in the Positron Assistant chat area (note: the button may be collapsed within the `...` context menu).
8280

8381
1. Select the model provider you want to add and authenticate with the API key or OAuth flow as required by the provider.
8482

@@ -90,7 +88,7 @@ If you don't already have API keys for these providers, see the [Language Model
9088
There is a known issue on Mac that may occur when logging into a language model provider. If you see auth errors or keychain error notifications and cannot successfully use Positron Assistant, you may want to try the workaround in [this issue](https://github.com/posit-dev/positron/issues/7331).
9189
:::
9290

93-
### Removing Language Models
91+
#### Removing language model providers
9492

9593
1. Run the `Positron Assistant: Add Language Model` command to open the language model dialog. You can also click the "Add Language Model" button in the Positron Assistant chat area (note: the button may be collapsed within the `...` context menu).
9694

@@ -100,10 +98,31 @@ There is a known issue on Mac that may occur when logging into a language model
10098

10199
1. Click the "Done" button to close the dialog.
102100

103-
## Language Model Provider API Keys & Authentication
101+
## Using Positron Assistant
102+
103+
### Chat Pane
104+
105+
Click on the chat robot icon in the sidebar, or run the `Chat: Open Chat in Sidebar` command in the Command Palette to open the chat.
106+
107+
Assistant's Chat pane (in the Activity Panel by default) knows about your R and Python console session inputs/outputs, in-memory objects and dataframes as available in the variables pane, and can look at the Plots pane too, if instructed. The user can attach files via the @ icon in or drag files as attachments to ask questions about specific files.
108+
109+
Code generated by Assistant can be run in the Console, copied to the clipboard, or sent to the Editor via controls attached to code output blocks.
110+
111+
### Inline Chat
112+
113+
The command _Inline Chat: Editor Inline Chat_ (default keybinding: Cmd + I) will open a mini chat right in the editor. This is very useful for asking questions in context, and also includes a good UX for integrating changes suggested by the model.
114+
115+
### Completions
116+
117+
If GitHub Copilot is enabled and the user pauses typing for a few seconds, Positron Assistant will offer completions in most contexts. If it is not working, check the following:
118+
119+
- Make sure you have a [language model provider added](#adding-language-model-providers) for completions.
120+
- Check the DevTools Console logs to see if there are any errors logged. Run the `Developer: Toggle Developer Tools` command in the Command Palette to open DevTools.
121+
122+
## Language model provider API keys & authentication
104123

105124
::: {.callout-tip}
106-
Since you may need to access these API keys multiple times, we recommend storing them in a password manager 1Password, or another secure location.
125+
Since you may need to access these API keys multiple times, we recommend storing them in a password manager such as 1Password, or another secure location.
107126
:::
108127

109128
### Anthropic Claude
@@ -127,33 +146,16 @@ Note that the available models in Positron are:
127146

128147
If you have a Github account with Copilot enabled, you can authenticate to Github Copilot in Positron Assistant in the language model dialog. The authentication flow will open up a browser and direct you to sign into Github. Once authenticated, Copilot will be available for inline code completions only.
129148

130-
## Using Positron Assistant
131-
132-
### Chat Pane
133-
134-
Click on the chat robot icon in the sidebar, or run the `Chat: Open Chat in Sidebar` command in the Command Palette to open the chat.
135-
136-
Assistant's Chat pane (in the Activity Panel by default) knows about your R and Python console session and variables, and can look at the Plots pane too, if instructed. You can drag files as attachments to ask questions about specific code.
137-
138-
Code generated by Assistant can be run in the Console, copied, or sent to the Editor.
139-
140-
### Inline Chat
141-
142-
The command _Inline Chat: Editor Inline Chat_ (default keybinding: Cmd + I) will open a mini chat right in the editor. This is very useful for asking questions in context, and also includes a good UX for integrating changes suggested by the model.
143-
144-
### Completions
145-
146-
If you pause typing for a few seconds, Positron Assistant will offer completions in most contexts. If it isn't working, check the following:
147-
148-
- Make sure you have a [language model added](#adding-language-models) for completions.
149-
- Check the DevTools Console logs to see if there are any errors logged. Run the `Developer: Toggle Developer Tools` command in the Command Palette to open DevTools.
150-
151149
## Support and Terms of Service
152150

153151
Posit does not provide support or assistance for any code written or generated in RStudio, with or without Positron Assistant via any model provider. Posit does not support the Anthropic or GitHub Copilot output, or test the logic used by either to generate code from prompts.
154152

153+
### Anthropic
154+
155155
Anthropic Claude is considered "Third Party Materials" as defined in the Posit EULA and subject to the Anthropic [Terms of Service](https://www.anthropic.com/legal/consumer-terms) and [Privacy Policy](https://www.anthropic.com/legal/privacy). Anthropic Claude is considered “Third Party Materials” as defined in the [Posit End User License Agreement](https://posit.co/about/eula/) and Posit assumes no liability or other obligations with respect thereto and, without limiting the foregoing, is not liable for any loss or damage resulting from the use or access thereof.
156156

157+
### GitHub Copilot
158+
157159
GitHub Copilot is a proprietary tool from GitHub. If you want to use GitHub Copilot, you need a [subscription for GitHub Copilot](https://docs.github.com/en/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot) in your personal GitHub account or to be assigned a seat by an organization with a subscription for GitHub Copilot for Business. Individual snippets of source code or the contents of entire files may be sent to GitHub’s servers to generate suggestions, for more information about how this information is handled, please see the [Copilot Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement#personal-data-we-collect).
158160

159161
Students and faculty can use GitHub Copilot for free as part of the GitHub Education program. For more information, see the [GitHub Education page](https://education.github.com/).

0 commit comments

Comments
 (0)