diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md index 5a5c5e666987..a58f42a723e0 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md @@ -41,28 +41,8 @@ When using the GPT 4o and {% data variables.copilot.copilot_claude_sonnet %} mod You can explicitly ask {% data variables.product.prodname_copilot_chat_dotcom %} to use a particular skill - for example, `Use the Bing skill to find the latest GPT4 model from OpenAI`. -### Currently available skills - You can generate a list of currently available skills by asking {% data variables.product.prodname_copilot_short %}: `What skills are available?` -The skills you can use in {% data variables.product.prodname_copilot_chat_dotcom_short %} include those shown in the table below. - - -| Skill | Description | Enabled by default? | Example question | -| ----- | ----------- | ------------------- | ---------------- | -| **Commit details** | Retrieves a list of commits, or the contents of a specific commit, to provide answers to commit-related questions. | Yes | `Explain the changes in the code of this commit`| -| **Discussion details** | Retrieves a specific {% data variables.product.prodname_dotcom %} discussion. This is useful for quickly getting the gist of the conversation in a discussion. | Yes | `Summarize this discussion` | -| **File details** | Retrieves a specific file in the default branch of the Git repository, allowing you to ask questions about the file and the recent changes made to it. This skill is useful when you provide the exact path of a file in the repository. | Yes | `What logic does user_auth.js encapsulate?`

`What is the file history of user_auth.js?` | -| **{% data variables.product.prodname_GH_advanced_security %}** | Retrieves information about security alerts within your organization from {% data variables.product.prodname_GH_advanced_security %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). | Yes | `How would I fix this {% data variables.product.prodname_code_scanning %} alert?` | -| **Issue details** | Retrieves a specific {% data variables.product.prodname_dotcom %} issue, including the issue's title, number, author, status, body, linked pull requests, comments, and timestamps. | Yes | `Summarize the conversation on this issue and suggest next steps` | -| **Lexical code search** | Keyword code search in the default branch of the Git repository. This skill is useful when you want to know about specific functions, methods or keywords that exist in the code. This skill leverages most of the functionality available to [{% data variables.product.prodname_dotcom %} Search](/search-github/github-code-search/understanding-github-code-search-syntax#using-qualifiers) like `symbol` and `path`. | Yes | `Find me the tests for the GitService class` | -| **Pull request details** | Retrieves a specific pull request. This allows you to ask questions about the pull request, including getting a summary of the pull request, its comments, or the code it changes. | Yes | `Summarize this PR for me`

`Summarize the changes in this PR` | -| **Release details** | Retrieves the latest, or specified, release. This allows you to find out who created a release, when it happened, and information included in the release notes. | Yes | `When was the latest release?` | -| **Repository details** | Retrieves a specific {% data variables.product.prodname_dotcom %} repository. This is useful for finding out details such as the repository owner and the main language used. | Yes | `Tell me about this repo` | -| **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. | Yes

Available for all public and private repositories with any subscription. | `How does this repo manage HTTP requests and responses?`| -| **Support search** | Retrieves information from the {% data variables.contact.contact_support_portal %}. This skill is useful for asking {% data variables.product.prodname_copilot_chat_short %} about {% data variables.product.prodname_dotcom %} products and support related questions. | Yes | `Can I use {% data variables.product.prodname_copilot_short %} knowledge bases with {% data variables.product.prodname_copilot_individuals_short %}?` | -| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | - ## AI models for {% data variables.product.prodname_copilot_chat_short %} {% data reusables.copilot.change-the-ai-model %} diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md index 69b2dad44d40..345a039db2c9 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md @@ -49,50 +49,33 @@ You can use special keywords to help {% data variables.product.prodname_copilot_ ### Chat participants -Chat participants are AI domain experts that can perform tasks or answer questions in a specific domain. +Chat participants are like domain experts who have a specialty that they can help you with. -{% data variables.product.prodname_copilot_chat_short %} can infer relevant chat participants based on your natural language prompt, improving discovery of advanced capabilities without you having to explicitly specify the participant you want to use in your prompt. However, if you prefer, you can still manually specify a chat participant to scope your prompt to a specific domain. To do this, type `@` in the chat prompt box, followed by a chat participant name. +{% data variables.product.prodname_copilot_chat_short %} can infer relevant chat participants based on your natural language prompt, improving discovery of advanced capabilities without you having to explicitly specify the participant you want to use in your prompt. > [!NOTE] Automatic inference for chat participants is currently in {% data variables.release-phases.public_preview %} and is subject to change. -Chat participants include: +Alternatively, you can manually specify a chat participant to scope your prompt to a specific domain. To do this, type `@` in the chat prompt box, followed by a chat participant name. -* `@workspace`: Has context about the code in your workspace. Use `@workspace` when you want {% data variables.product.prodname_copilot_short %} to consider the structure of your project, how different parts of your code interact, or design patterns in your project. -* `@vscode`: Has context about {% data variables.product.prodname_vscode %} commands and features. Use `@vscode` when you want help with {% data variables.product.prodname_vscode %}. -* `@terminal`: Has context about the {% data variables.product.prodname_vscode %} terminal shell and its contents. Use `@terminal` when you want help creating or debugging terminal commands. -* `@azure`: Has context about Azure services and how to use, deploy and manage them. Use `@azure` when you want help with Azure. The `@azure` chat participant is currently in {% data variables.release-phases.public_preview %} and is subject to change. -{% ifversion ghec %} -* `@github`: Allows you to use {% data variables.product.prodname_dotcom %}-specific {% data variables.product.prodname_copilot_short %} skills. See [Using {% data variables.product.prodname_dotcom %} skills for {% data variables.product.prodname_copilot_short %}](#using-github-skills-for-copilot). -{% endif %} +For a list of available chat participants, type `@` in the chat prompt box. See also [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?tool=vscode#chat-participants) or [Chat participants](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-participants) in the {% data variables.product.prodname_vscode %} documentation. -In addition to the built-in {% data variables.product.prodname_vscode %} chat participants, you can also install {% data variables.product.prodname_copilot_extensions_short %} that provide chat participants. You can install these extensions from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=apps&copilot_app=true) and from [{% data variables.product.prodname_vscode_marketplace %}](https://marketplace.visualstudio.com/search?target=VSCode&category=Chat&sortBy=Installs). For information about extensions from {% data variables.product.prodname_marketplace %} that provide chat participants, see [AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions). - -{% data reusables.copilot.copilot-extensions.public-preview-note %} +### {% data variables.product.prodname_copilot_extensions_short %} chat participants -To see all available chat participants, type `@` in the chat prompt box. +You can also install {% data variables.product.prodname_copilot_extensions_short %} that provide chat participants. You can install these extensions from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=apps&copilot_app=true) and from [{% data variables.product.prodname_vscode_marketplace %}](https://marketplace.visualstudio.com/search?target=VSCode&category=Chat&sortBy=Installs). For information about extensions from {% data variables.product.prodname_marketplace %} that provide chat participants, see [AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions). -See also [Chat participants](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-participants) in the {% data variables.product.prodname_vscode %} documentation. +{% data reusables.copilot.copilot-extensions.public-preview-note %} ### Slash commands -Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. Slash commands include: - -* `/tests`: Generate unit tests for the selected code -* `/fix`: Propose a fix for problems in the selected code -* `/explain`: Explain the selected code -* `/clear`: Start a new chat +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. -To see all available slash commands, type `/` in the chat prompt box. See also [Slash commands](https://code.visualstudio.com/docs/copilot/copilot-chat#_slash-commands) in the {% data variables.product.prodname_vscode %} documentation. +To see all available slash commands, type `/` in the chat prompt box. See also [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?tool=vscode#slash-commands) or [Slash commands](https://code.visualstudio.com/docs/copilot/copilot-chat#_slash-commands) in the {% data variables.product.prodname_vscode %} documentation. ### Chat variables -Use chat variables to include specific context in your prompt. To use a chat variable, type `#` in the chat prompt box, followed by a chat variable. Chat variables include: +Use chat variables to include specific context in your prompt. To use a chat variable, type `#` in the chat prompt box, followed by a chat variable. -* `#file`: Include a specific file as context in the chat. -* `#git`: Include information about the current Git repository. -* `#terminalLastCommand`: Include the last run command in the active {% data variables.product.prodname_vscode %} terminal. - -To see all available chat variables, type `#` in the chat prompt box. See also [Chat variables](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-variables) in the {% data variables.product.prodname_vscode %} documentation. +To see all available chat variables, type `#` in the chat prompt box. See also [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?tool=vscode#chat-variables) or [Chat variables](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-variables) in the {% data variables.product.prodname_vscode %} documentation. ## Using {% data variables.product.prodname_dotcom %} skills for {% data variables.product.prodname_copilot_short %} @@ -105,33 +88,8 @@ When you add `@github` to a question, {% data variables.product.prodname_copilot * Use natural language to ask {% data variables.product.prodname_copilot_chat_short %} to use a skill. For example, `@github Search the web to find the latest GPT4 model from OpenAI.` * To specifically invoke a web search you can include the `#web` variable in your question. For example, `@github #web What is the latest LTS of Node.js?` -### Currently available skills - You can generate a list of currently available skills by asking {% data variables.product.prodname_copilot_short %}: `@github What skills are available?` -The skills you can use in {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %} include those shown in the table below. - - - -| Skill | Description | Enabled by default? | Example question | -| ----- | ----------- | ------------------- | ---------------- | -| **Commit details** | Retrieves a list of commits, or the contents of a specific commit, to provide answers to commit-related questions. | Yes | `@github Explain the changes in the code of this commit` | -| **Discussion details** | Retrieves a specific {% data variables.product.prodname_dotcom %} discussion. This is useful for quickly getting the gist of the conversation in a discussion. | Yes | `@github Summarize this discussion LINK-TO-DISCUSSION` | -| **File details** | Retrieves a specific file in the default branch of the Git repository, allowing you to ask questions about the file and the recent changes made to it. This skill is useful when you provide the exact path of a file in the repository. | Yes | `@github What logic does user_auth.js encapsulate?`

`@github What is the file history of user_auth.js?` | -| **{% data variables.product.prodname_GH_advanced_security %}** | Retrieves information about security alerts within your organization from {% data variables.product.prodname_GH_advanced_security %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). | Yes | `@github How would I fix this {% data variables.product.prodname_code_scanning %} alert?` | -| **Issue details** | Retrieves a specific {% data variables.product.prodname_dotcom %} issue, including the issue's title, number, author, status, body, linked pull requests, comments, and timestamps. | Yes | `@github List issues assigned to me` | -| {% ifversion ghec %} | -| **Knowledge base search** | Tell {% data variables.product.prodname_copilot_chat_short %} to answer a question within the context of a knowledge base. To initiate a knowledge base search, first enter `@github #kb`. | Yes | Enter `@github #kb`, then choose your organization's style guide knowledge base, then ask: `What is our coding convention for indentation?` | -| {% endif %} | -| **Lexical code search** | Keyword code search in the default branch of the Git repository. This skill is useful when you want to know about specific functions, methods or keywords that exist in the code. This skill leverages most of the functionality available to [{% data variables.product.prodname_dotcom %} Search](/search-github/github-code-search/understanding-github-code-search-syntax#using-qualifiers) like `symbol` and `path`. | Yes | `Find me the tests for the GitService class` | -| **Path search** | Retrieves a specific file in the default branch of the Git repository. This skill is useful when you provide the exact path of a file in the repository. | Yes | `@github What logic does user_auth.js encapsulate?` | -| **Pull request details** | Retrieves a specific pull request. This allows you to ask questions about the pull request, including getting a summary of the pull request, its comments, or the code it changes. | Yes | `@github List my recent pull requests` | -| **Release details** | Retrieves the latest, or specified, release. This allows you to find out who created a release, when it happened, and information included in the release notes. | Yes | `@github When was the latest release?` | -| **Repository details** | Retrieves a specific {% data variables.product.prodname_dotcom %} repository. This is useful for finding out details such as the repository owner and the main language used. | Yes | `@github Tell me about PATH-TO-REPOSITORY` | -| **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/indexing-repositories-for-copilot-chat). | Yes

Available for all public and private repositories with any subscription. | `How does this repo manage HTTP requests and responses?`| -| **Support search** | Retrieves information from the {% data variables.contact.contact_support_portal %}. This skill is useful for asking {% data variables.product.prodname_copilot_chat_short %} about {% data variables.product.prodname_dotcom %} products and support related questions. | Yes | `@github Can I use {% data variables.product.prodname_copilot_short %} knowledge bases with {% data variables.product.prodname_copilot_individuals_short %}?` | -| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github #web What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | - {% ifversion ghec %} ## Asking a question about a knowledge base @@ -229,25 +187,15 @@ You can use special keywords to help {% data variables.product.prodname_copilot_ ### Slash commands -Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. Slash commands include: - -* `/tests`: Generate unit tests for the selected code -* `/fix`: Propose a fix for problems in the selected code -* `/explain`: Explain the selected code -* `/optimize`: Analyze and improve the runtime of the selected code +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. -To see all available slash commands, type `/` in the chat prompt box. See also [Slash commands](https://learn.microsoft.com/visualstudio/ide/copilot-chat-context#slash-commands) in the {% data variables.product.prodname_vs %} documentation. +To see all available slash commands, type `/` in the chat prompt box. See also [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?tool=vscode#slash-commands) or [Slash commands](https://learn.microsoft.com/visualstudio/ide/copilot-chat-context#slash-commands) in the {% data variables.product.prodname_vs %} documentation. ### References -By default, {% data variables.product.prodname_copilot_chat_short %} will reference the file that you have open or the code that you have selected. You can also use `#` followed by a file name, file name and line numbers, or `solution` to reference a specific file, lines, or solution. For example: +By default, {% data variables.product.prodname_copilot_chat_short %} will reference the file that you have open or the code that you have selected. You can also use `#` followed by a file name, file name and line numbers, or `solution` to reference a specific file, lines, or solution. -* Reference a specific file: `Where are the tests in #MyFile.cs?` -* Reference multiple files: `How are these files related #MyFile.cs #MyFile2.cs` -* Reference specific lines in a file: `Explain this function #MyFile.cs: 66-72?` -* Reference the current file: `Is there a delete method in this #solution` - -See also [Reference](https://learn.microsoft.com/visualstudio/ide/copilot-chat-context#reference) in the {% data variables.product.prodname_vs %} documentation. +See also [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?tool=visualstudio#references) or [Reference](https://learn.microsoft.com/visualstudio/ide/copilot-chat-context#reference) in the {% data variables.product.prodname_vs %} documentation. ## Using {% data variables.product.prodname_dotcom %} skills for {% data variables.product.prodname_copilot_short %} (preview) @@ -258,24 +206,8 @@ See also [Reference](https://learn.microsoft.com/visualstudio/ide/copilot-chat-c When you add `@github` to a question, {% data variables.product.prodname_copilot_short %} dynamically selects an appropriate skill, based on the content of your question. You can also explicitly ask {% data variables.product.prodname_copilot_chat_short %} to use a particular skill. For example, `@github Search the web to find the latest GPT4 model from OpenAI.` -### Currently available skills - You can generate a list of currently available skills by asking {% data variables.product.prodname_copilot_short %}: `@github What skills are available?` -The skills you can use in {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %} include those shown in the table below. - - - -| Skill | Description | Enabled by default? | Example question | -| ------ | ----------- | ------------------- | -----------------| -| {% ifversion ghec %} | -| **Knowledge base search** | Tell {% data variables.product.prodname_copilot_chat_short %} to answer a question within the context of a knowledge base. To initiate a knowledge base search, first enter `@github`, then press **#**, then select a knowledge base. | Yes | Enter `@github #`, then choose your organization's style guide knowledge base, then ask: `What is our coding convention for indentation?` | -| {% endif %} | -| **Lexical code search** | Keyword code search in the default branch of the Git repository. This skill is useful when you want to know about specific functions, methods or keywords that exist in the code. This skill leverages most of the functionality available to [{% data variables.product.prodname_dotcom %} Search](/search-github/github-code-search/understanding-github-code-search-syntax#using-qualifiers) like `symbol` and `path`. | Yes | `Find me the tests for the GitService class` | -| **Path search** | Retrieves a specific file in the default branch of the Git repository. This skill is useful when you provide the exact path of a file in the repository. | Yes | `@github What logic does user_auth.js encapsulate?` | -| **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/indexing-repositories-for-copilot-chat). | Yes

Available for all public and private repositories with any subscription. | `How does this repo manage HTTP requests and responses?`| -| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | - {% ifversion ghec %} ## Asking a question about a knowledge base (preview) @@ -367,14 +299,9 @@ You can use special keywords to help {% data variables.product.prodname_copilot_ ### Slash commands -Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. Slash commands include: - -* `/tests`: Generate unit tests for the selected code -* `/fix`: Propose a fix for problems in the selected code -* `/explain`: Explain the selected code -* `/help`: Learn more about using {% data variables.product.prodname_copilot_chat_short %} +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. -To see all available slash commands, type `/` in the chat prompt box. +To see all available slash commands, type `/` in the chat prompt box. See also [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?tool=jetbrains#slash-commands-2) ### File references diff --git a/content/copilot/using-github-copilot/github-copilot-chat-cheat-sheet.md b/content/copilot/using-github-copilot/github-copilot-chat-cheat-sheet.md new file mode 100644 index 000000000000..193f3e53cfa9 --- /dev/null +++ b/content/copilot/using-github-copilot/github-copilot-chat-cheat-sheet.md @@ -0,0 +1,178 @@ +--- +title: GitHub Copilot Chat cheat sheet +shortTitle: Copilot Chat cheat sheet +intro: "Use this cheat sheet to quickly reference the most common commands and options for using {% data variables.product.prodname_copilot_chat %}." +versions: + feature: copilot +topics: + - Copilot +--- + +{% webui %} + +This version of this article is for {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website. For other versions of this article, click the tabs above. + +{% endwebui %} + +{% vscode %} + +This version of this article is for {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode %}. For other versions of this article, click the tabs above. + +{% endvscode %} + +{% visualstudio %} + +This version of this article is for {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vs %}. For other versions of this article, click the tabs above. + +{% endvisualstudio %} + +{% jetbrains %} + +This version of this article is for {% data variables.product.prodname_copilot_short %} in JetBrains. For other versions of this article, click the tabs above. + +{% endjetbrains %} + +## About {% data variables.product.prodname_copilot %} enhancements + +You can enhance your experience of {% data variables.product.prodname_copilot_chat_short %} with a variety of commands and options. Finding the right command or option for the task you are working on can help you achieve your goals more efficiently. This cheat sheet provides a quick reference to the most common commands and options for using {% data variables.product.prodname_copilot_chat_short %}. + +{% visualstudio %} + +For information about how to get started with {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). + +## Slash commands + +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by the command name. + +Available slash commands may vary, depending on your environment and the context of your chat. To view a list of currently available slash commands, type `/` in the chat prompt box of your current environment. Below is a list of some of the most common slash commands for using {% data variables.product.prodname_copilot_chat_short %}. + +| Command | Description | +| --- | --- | +| `/help` | Quick reference and basics of using {% data variables.product.prodname_copilot %}. | +| `/tests` | Generate unit tests for the selected code. | +| `/fix` | Propose a fix for problems in the selected code. | +| `/explain` | Explain how the code in your active editor works. | +| `/optimize` | Analyze and improve running time of the selected code. | +| `/doc` | Add documentation comment for this symbol. | + +{% endvisualstudio %} + +{% vscode %} + +For information about how to get started with {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). + +## Slash commands + +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by the command name. + +Available slash commands may vary, depending on your environment and the context of your chat. To view a list of currently available slash commands, type `/` in the chat prompt box of your current environment. Below is a list of some of the most common slash commands for using {% data variables.product.prodname_copilot_chat_short %}. + +| Command | Description | +| --- | --- | +| `/help` | Quick reference and basics of using {% data variables.product.prodname_copilot %}. | +| `/tests` | Generate unit tests for the selected code. | +| `/fix` | Propose a fix for problems in the selected code. | +| `/explain` | Explain how the code in your active editor works. | +| `/fixTestFailure` | Find and fix a failing test. | +| `/new` | Create a new project. | +| `/clear` | Start a new chat session. | + +{% endvscode %} + +{% jetbrains %} + +For information about how to get started with {% data variables.product.prodname_copilot_chat_short %} in JetBrains, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). + +## Slash commands + +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by the command name. + +Available slash commands may vary, depending on your environment and the context of your chat. To view a list of currently available slash commands, type `/` in the chat prompt box of your current environment. Below is a list of some of the most common slash commands for using {% data variables.product.prodname_copilot_chat_short %}. + +| Command | Description | +| --- | --- | +| `/help` | Quick reference and basics of using {% data variables.product.prodname_copilot %}. | +| `/tests` | Generate unit tests for the selected code. | +| `/fix` | Propose a fix for problems in the selected code. | +| `/explain` | Explain how the code in your active editor works. | +| `/fixTestFailure` | Find and fix a failing test. | +| `/new` | Create a new project. | +| `/clear` | Start a new chat session. | + +{% endjetbrains %} + +{% webui %} + +For information about how to get started with {% data variables.product.prodname_copilot_chat_short %} in the {% data variables.product.github %} website, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github). + +## Slash commands + +Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by the command name. + +Available slash commands may vary, depending on your environment and the context of your chat. To view a list of currently available slash commands, type `/` in the chat prompt box of your current environment. Below is a list of some of the most common slash commands for using {% data variables.product.prodname_copilot_chat_short %}. + +| Command | Description | +| --- | --- | +| `/help` | Quick reference and basics of using {% data variables.product.prodname_copilot %}. | +| `/search` | Performs a search within the repository, including issues, pull requests, and code. | +| `/file` | Retrieves a specific file from the repository by its path. | +| `/rename` | Rename a conversation. | +| `/delete` | Delete a conversation. | +| `/new` | Start a new conversation | +| `/clear` | Clear conversation. | + +{% endwebui %} + +{% vscode %} + +## Chat variables + +Use chat variables to include specific context in your prompt. To use a chat variable, type `#` in the chat prompt box, followed by a chat variable. + +| Variable | Description | +| --- | --- | +| `#file` | Includes the current file's content in the prompt. | +| `#selection` | Includes the currently selected text in the prompt. | +| `#line` | Includes the current line of code in the prompt. | +| `#project` | Includes the project context in the prompt. | +| `#path` | Includes the file path in the prompt. | +| `#function` | Includes the current function or method in the prompt. | +| `#class` | Includes the current class in the prompt. | +| `#comment` | Includes the current comment in the prompt. | +| `#block` | Includes the current block of code in the prompt. | +| `#sym` | Includes the current symbol in the prompt. | + +{% endvscode %} + +{% visualstudio %} + +## References + +By default, {% data variables.product.prodname_copilot_chat_short %} will reference the file that you have open or the code that you have selected. You can also use # followed by a file name, file name and line numbers, or solution to reference a specific file, lines, or solution. + +| Example | Description | +| --- | --- | +| `Where are the tests in #MyFile.cs?` | References a specific file | +| `How are these files related #MyFile.cs #MyFile2.cs` | References multiple files | +| `Explain this function #MyFile.cs: 66-72?` | References specific lines in a file | +| `Is there a delete method in this #solution?` | References the current file | + +{% endvisualstudio %} + +{% vscode %} + +## Chat participants + +Chat participants are like domain experts who have a specialty that they can help you with. You can specify a chat participant by typing `@` in the chat prompt box, followed by a chat participant name. To see all available chat participants, type `@` in the chat prompt box. + +Below is a list of some of the most common chat participants for using {% data variables.product.prodname_copilot_chat_short %}. + +| Variable | Description | +|--------------|----------------------------------------------------------------------------------------------| +| `@workspace` | Has context about the code in your workspace. Use `@workspace` when you want {% data variables.product.prodname_copilot_short %} to consider the structure of your project, how different parts of your code interact, or design patterns in your project. | +| `@vscode` | Has context about {% data variables.product.prodname_vscode %} commands and features. Use `@vscode` when you want help with {% data variables.product.prodname_vscode %}. | +| `@terminal` | Has context about the {% data variables.product.prodname_vscode %} terminal shell and its contents. Use `@terminal` when you want help creating or debugging terminal commands. | +| `@azure` | Has context about Azure services and how to use, deploy and manage them. Use `@azure` when you want help with Azure. The `@azure` chat participant is currently in {% data variables.release-phases.public_preview %} and is subject to change. | +| `@github` | Allows you to use {% data variables.product.prodname_dotcom %}-specific {% data variables.product.prodname_copilot_short %} skills. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-github-skills-for-copilot). | + +{% endvscode %} diff --git a/content/copilot/using-github-copilot/index.md b/content/copilot/using-github-copilot/index.md index 3dacf0b5bec3..254db55c26c7 100644 --- a/content/copilot/using-github-copilot/index.md +++ b/content/copilot/using-github-copilot/index.md @@ -21,6 +21,7 @@ children: - /using-extensions-to-integrate-external-tools-with-copilot-chat - /ai-models - /finding-public-code-that-matches-github-copilot-suggestions + - /github-copilot-chat-cheat-sheet - /using-github-copilot-for-pull-requests - /guides-on-using-github-copilot redirect_from: diff --git a/data/reusables/copilot/ai-models-intro.md b/data/reusables/copilot/ai-models-intro.md new file mode 100644 index 000000000000..8a84af2193f2 --- /dev/null +++ b/data/reusables/copilot/ai-models-intro.md @@ -0,0 +1,5 @@ +{% data variables.product.prodname_copilot_chat_short %} uses the GPT 4o model by default. Depending on the task you are working on, you may want to use a different model, such as the {% data variables.copilot.copilot_claude_sonnet %} model or the o1 model. For a list of all AI models currently available to {% data variables.product.prodname_copilot_chat_short %}, and the advantages and limitations of each model, see [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?#ai-models). + +For more information about the o1 models, see [Models](https://platform.openai.com/docs/models/models) in the OpenAI Platform documentation. + +For more information about the {% data variables.copilot.copilot_claude_sonnet %} model from Anthropic, see [AUTOTITLE](/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot). diff --git a/data/reusables/copilot/copilot-chat-models-list-o1-preview.md b/data/reusables/copilot/copilot-chat-models-list-o1-preview.md new file mode 100644 index 000000000000..e84fe492519c --- /dev/null +++ b/data/reusables/copilot/copilot-chat-models-list-o1-preview.md @@ -0,0 +1,15 @@ +Below is a list of all currently available AI models for using {% data variables.product.prodname_copilot_chat_short %}, and the advantages and limitations of each model. For information on how to change your AI model, see [Changing your AI model](/copilot/using-github-copilot/asking-github-copilot-questions-in-github#changing-your-ai-model). + +| Model | Description | Hosting Platform | +|---------------------|---------------|---------------------------| +| GPT 4o | This is the default {% data variables.product.prodname_copilot_chat_short %} model. It is a versatile, multimodal model that excels in both text and image processing and is designed to provide fast, reliable responses. It also has superior performance in non-English languages. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/gpt-4o) and review the [model card](https://openai.com/index/gpt-4o-system-card/). | Azure | +| Claude 3.5 Sonnet | This model excels at coding tasks across the entire software development lifecycle, from initial design to bug fixes, maintenance to optimizations. Learn more about the [model's capabilities](https://www.anthropic.com/claude/sonnet) or read the [model card](https://assets.anthropic.com/m/61e7d27f8c8f5919/original/Claude-3-Model-Card.pdf). | Amazon Web Services | +| o1-preview | This model is focused on advanced reasoning and solving complex problems, in particular in math and science. It responds more slowly than the `gpt-4o` model. You can make 10 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). | Azure | +| o1-mini | This is the faster version of the `o1-preview` model, balancing the use of complex reasoning with the need for faster responses. It is best suited for code generation and small context operations. You can make 50 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). | Azure | + +> [!NOTE] +> Support for the `o1` model, replacing `o1-preview`, is coming soon to {% data variables.product.prodname_vs %}. + +For more information about the o1 models, see [Models](https://platform.openai.com/docs/models/models) in the OpenAI Platform documentation. + +For more information about the {% data variables.copilot.copilot_claude_sonnet %} model from Anthropic, see [AUTOTITLE](/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot). diff --git a/data/reusables/copilot/copilot-chat-models-list-visual-studio.md b/data/reusables/copilot/copilot-chat-models-list-visual-studio.md index 7c81451ca633..ab4effa700fd 100644 --- a/data/reusables/copilot/copilot-chat-models-list-visual-studio.md +++ b/data/reusables/copilot/copilot-chat-models-list-visual-studio.md @@ -1,9 +1,13 @@ +<<<<<<< HEAD:data/reusables/copilot/copilot-chat-models-list-o1.md +{% data variables.product.prodname_copilot_chat_short %} uses the GPT 4o model by default. Depending on the task you are working on, you may want to use a different model, such as the {% data variables.copilot.copilot_claude_sonnet %} model or the o1 model. For a list of all AI models currently available to {% data variables.product.prodname_copilot_chat_short %}, and the advantages and limitations of each model, see [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet?#ai-models-1). +======= The following models are currently available through multi-model {% data variables.product.prodname_copilot_chat_short %}: * **GPT 4o:** This is the default {% data variables.product.prodname_copilot_chat_short %} model. It is a versatile, multimodal model that excels in both text and image processing and is designed to provide fast, reliable responses. It also has superior performance in non-English languages. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/gpt-4o) and review the [model card](https://openai.com/index/gpt-4o-system-card/). GPT 4o is hosted on Azure. * **{% data variables.copilot.copilot_claude_sonnet %}:** This model excels at coding tasks across the entire software development lifecycle, from initial design to bug fixes, maintenance to optimizations. Learn more about the [model's capabilities](https://www.anthropic.com/claude/sonnet) or read the [model card](https://assets.anthropic.com/m/61e7d27f8c8f5919/original/Claude-3-Model-Card.pdf). {% data variables.product.prodname_copilot %} uses {% data variables.copilot.copilot_claude_sonnet %} hosted on Amazon Web Services. * **o1:** This model is focused on advanced reasoning and solving complex problems, in particular in math and science. It responds more slowly than the GPT 4o model. You can make 10 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). o1 is hosted on Azure. * **o1-mini:** This is the faster version of the o1 model, balancing the use of complex reasoning with the need for faster responses. It is best suited for code generation and small context operations. You can make 50 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). o1-mini is hosted on Azure. +>>>>>>> main:data/reusables/copilot/copilot-chat-models-list-visual-studio.md For more information about the o1 models, see [Models](https://platform.openai.com/docs/models/models) in the OpenAI Platform documentation.