Add content for the limited public beta of Copilot Extensibility (#50525)
Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
Sam Browning
@@ -3,12 +3,13 @@ title: About GitHub Copilot Chat in GitHub Mobile
|
||||
intro: '{% data variables.product.prodname_copilot_chat %} can help you by providing answers to coding related questions directly within {% data variables.product.prodname_mobile %}.'
|
||||
redirect_from:
|
||||
- /early-access/copilot/about-github-copilot-chat-in-github-mobile
|
||||
- /copilot/github-copilot-chat/about-github-copilot-chat-in-github-mobile
|
||||
versions:
|
||||
feature: copilot-chat-for-mobile
|
||||
topics:
|
||||
- Copilot
|
||||
- Mobile
|
||||
shortTitle: About Copilot Chat (Mobile)
|
||||
shortTitle: About Copilot Chat
|
||||
type: rai
|
||||
---
|
||||
|
||||
@@ -6,7 +6,9 @@ topics:
|
||||
- Mobile
|
||||
versions:
|
||||
feature: copilot-chat-for-mobile
|
||||
shortTitle: Enabling Copilot Chat (Mobile)
|
||||
shortTitle: Enable Copilot Chat
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-chat/enabling-github-copilot-chat-for-github-mobile
|
||||
---
|
||||
|
||||
If you have a {% data variables.product.prodname_copilot_for_individuals %} subscription, {% data variables.product.prodname_copilot_mobile %} is already enabled.
|
||||
@@ -34,4 +36,4 @@ An enterprise owner can choose whether to enable a feature for all organizations
|
||||
|
||||
## Next steps
|
||||
|
||||
You successfully enabled {% data variables.product.prodname_copilot_mobile_short %} for your organization{% ifversion ghec %} or enterprise{% endif %}. To learn more about how to use it, see "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-github-mobile)."
|
||||
You successfully enabled {% data variables.product.prodname_copilot_mobile_short %} for your organization{% ifversion ghec %} or enterprise{% endif %}. To learn more about how to use it, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile)."
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Copilot Chat in GitHub Mobile
|
||||
intro: 'You can chat with {% data variables.product.prodname_copilot_chat_dotcom_short %} in {% data variables.product.prodname_mobile %} to learn out about aspects of software development, or to understand or improve specific lines of code.'
|
||||
versions:
|
||||
feature: 'copilot-chat-for-mobile'
|
||||
children:
|
||||
- /about-github-copilot-chat-in-github-mobile
|
||||
- /enabling-github-copilot-chat-for-github-mobile
|
||||
- /using-github-copilot-chat-in-github-mobile
|
||||
---
|
||||
@@ -6,14 +6,16 @@ topics:
|
||||
- Mobile
|
||||
versions:
|
||||
feature: copilot-chat-for-mobile
|
||||
shortTitle: Use Copilot Chat (Mobile)
|
||||
shortTitle: Use Copilot Chat
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-chat/using-github-copilot-chat-in-github-mobile
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{% data variables.product.prodname_copilot_chat %} is a chat interface that lets you ask and receive answers to coding-related questions in {% data variables.product.prodname_mobile %}. You can also use {% data variables.product.prodname_copilot_chat %} {% ifversion ghec %}on either {% data variables.product.prodname_dotcom_the_website %} or{% endif %} within a supported IDE. For information on using {% data variables.product.prodname_copilot_chat %} in an IDE, see "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)."
|
||||
{% data variables.product.prodname_copilot_chat %} is a chat interface that lets you ask and receive answers to coding-related questions in {% data variables.product.prodname_mobile %}. You can also use {% data variables.product.prodname_copilot_chat %} {% ifversion ghec %}on either {% data variables.product.prodname_dotcom_the_website %} or{% endif %} within a supported IDE. For information on using {% data variables.product.prodname_copilot_chat %} in an IDE, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide)."
|
||||
|
||||
{% data variables.product.prodname_copilot_mobile_short %} can help you with a variety of coding-related tasks, like offering you code suggestions, providing natural language descriptions of a piece of code's functionality and purpose, generating unit tests for your code, and proposing fixes for bugs in your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat-in-github-mobile)."
|
||||
{% data variables.product.prodname_copilot_mobile_short %} can help you with a variety of coding-related tasks, like offering you code suggestions, providing natural language descriptions of a piece of code's functionality and purpose, generating unit tests for your code, and proposing fixes for bugs in your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/about-github-copilot-chat-in-github-mobile)."
|
||||
|
||||
{% ifversion ghec %}
|
||||
In {% data variables.product.prodname_mobile %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask:
|
||||
@@ -38,7 +40,7 @@ To use {% data variables.product.prodname_copilot_mobile_short %} you will need
|
||||
|
||||
If you do not have a {% data variables.product.prodname_copilot %} subscription, you can purchase a {% data variables.product.prodname_copilot_individuals_short %} subscription directly in the iOS version of {% data variables.product.prodname_mobile %}, or in the Google Play Store for the Android version of {% data variables.product.prodname_mobile %}.
|
||||
|
||||
- **Access to {% data variables.product.prodname_copilot_mobile_short %}**: If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_cli_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/enabling-github-copilot-chat-for-github-mobile)."
|
||||
- **Access to {% data variables.product.prodname_copilot_mobile_short %}**: If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_cli_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/enabling-github-copilot-chat-for-github-mobile)."
|
||||
- **Enable {% data variables.product.prodname_copilot_short %} features for your device**: {% data variables.product.prodname_copilot_short %} needs to be enabled from within {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot#enabling-or-disabling-copilot-in-github-mobile)."
|
||||
|
||||
## Asking a general question about software development
|
||||
@@ -86,7 +88,7 @@ You can ask questions about a specific repository, to get help with understandin
|
||||
> [!IMPORTANT]
|
||||
> {% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. However, only members of an enterprise with a {% data variables.product.prodname_copilot_enterprise %} subscription can index a repository for semantic code search. Without indexing, {% data variables.product.prodname_copilot_mobile_short %} may not be able to provide the most relevant answers to your questions.
|
||||
>
|
||||
> Additionally, indexing a repository is not possible in {% data variables.product.prodname_mobile %}. To index a repository, you must use {% data variables.product.prodname_copilot_chat_short %} in a web browser. For more information, see step 6 of "[Asking a question about a specific repository, file or symbol](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)."
|
||||
> Additionally, indexing a repository is not possible in {% data variables.product.prodname_mobile %}. To index a repository, you must use {% data variables.product.prodname_copilot_chat_short %} in a web browser. For more information, see step 6 of "[Asking a question about a specific repository, file or symbol](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)."
|
||||
|
||||
{% data reusables.copilot.chat-mobile-conversation-buttons %}
|
||||
|
||||
@@ -0,0 +1,163 @@
|
||||
---
|
||||
title: About GitHub Copilot Chat in GitHub.com
|
||||
shortTitle: About Copilot Chat
|
||||
intro: '{% data variables.product.prodname_copilot_chat_dotcom %} can help you by providing answers to coding related questions directly within {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
product: 'Owners of organizations {% ifversion ghec %}or enterprises {% endif %}with a {% data variables.product.prodname_copilot_enterprise %} subscription can decide whether to grant access to the {% data variables.product.prodname_copilot_enterprise_short %} functionality for an organization. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)."'
|
||||
versions:
|
||||
feature: 'copilot-on-dotcom'
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Copilot
|
||||
type: rai
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat
|
||||
- /copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management
|
||||
- /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat-in-githubcom
|
||||
---
|
||||
|
||||
{% ifversion fpt %}
|
||||
|
||||
{% data reusables.rai.copilot.enterprise-fpt-link %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
## About {% data variables.product.prodname_copilot_chat_dotcom %}
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_dotcom %} is a chat interface that lets you interact with {% data variables.product.prodname_copilot %}, to ask and receive answers to coding-related questions within {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
The chat interface provides access to coding information and support without requiring you to navigate documentation or search online forums.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data variables.product.prodname_copilot_chat_short %} is also available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and the JetBrains suite of IDEs. However, features available in these IDEs differ from features available on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data variables.product.prodname_copilot_chat %} can answer a wide range of coding-related questions on topics including syntax, programming concepts, test cases, debugging, and more. {% data variables.product.prodname_copilot_chat %} is not designed to answer non-coding questions or provide general information on topics outside of coding.
|
||||
|
||||
The primary supported language for {% data variables.product.prodname_copilot_chat %} on {% data variables.product.prodname_dotcom_the_website %} is English.
|
||||
|
||||
{% data variables.product.prodname_copilot_chat %} works by using a combination of natural language processing and machine learning to understand your question and provide you with an answer. This process can be broken down into a number of steps.
|
||||
|
||||
### Input processing
|
||||
|
||||
The input prompt from the user is pre-processed by the {% data variables.product.prodname_copilot_chat_short %} system, combined with contextual information (for example, the current date and time and the name of the repository the user is currently viewing), and sent to a large language model. User input can take the form of code snippets or plain language.
|
||||
|
||||
The large language model will take the prompt, gather additional context (for example repository data stored on {% data variables.product.prodname_dotcom %} or search results from Bing), and provide a response based on the prompt. The system is only intended to respond to coding-related questions.
|
||||
|
||||
### Language model analysis
|
||||
|
||||
The pre-processed prompt is then passed through the {% data variables.product.prodname_copilot_chat_short %} language model, which is a neural network that has been trained on a large body of text data. The language model analyzes the input prompt.
|
||||
|
||||
### Response generation
|
||||
|
||||
The language model generates a response based on its analysis of the input prompt and the context provided to it. The language model can gather additional context (for example repository data stored on {% data variables.product.prodname_dotcom %} or search results from Bing), and provide a response based on the prompt. This response can take the form of generated code, code suggestions, or explanations of existing code.
|
||||
|
||||
### Output formatting
|
||||
|
||||
The response generated by {% data variables.product.prodname_copilot_chat_short %} is formatted and presented to the user. {% data variables.product.prodname_copilot_chat_short %} may use syntax highlighting, indentation, and other formatting features to add clarity to the generated response. Depending upon the type of question from the user, links to context that the model used when generating a response, such as source code files, issues, Bing search results, or documentation, may also be provided.
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} is intended to provide you with the most relevant answer to your question. However, it may not always provide the answer you are looking for. Users of {% data variables.product.prodname_copilot_chat_short %} are responsible for reviewing and validating responses generated by the system to ensure they are accurate and appropriate. Additionally, as part of our product development process, we undertake red teaming to understand and improve the safety of {% data variables.product.prodname_copilot_chat_short %}. Input prompts and output completions are run through content filters. The content filtering system detects and prevents the output on specific categories of content including harmful, offensive, or off-topic content. For more information on improving the performance of {% data variables.product.prodname_copilot_chat_short %}, see "[Improving performance for {% data variables.product.prodname_copilot_chat_short %}](#improving-performance-for-copilot-chat)."
|
||||
|
||||
## Use cases for {% data variables.product.prodname_copilot_chat_short %}
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can provide coding assistance in a variety of scenarios.
|
||||
|
||||
### Answering coding questions
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_chat_short %} for help or clarification on specific coding problems and receive responses in natural language format or in code snippet format.
|
||||
|
||||
The response generated by {% data variables.product.prodname_copilot_chat_short %} may use the model's training data set, search results from Bing, code in your repositories, and Markdown documentation in your knowledge bases to answer your questions.
|
||||
|
||||
This can be a useful tool for programmers, as it can provide guidance and support for common coding tasks and challenges.
|
||||
|
||||
### Explaining code and suggesting improvements
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can help explain selected code by generating natural language descriptions of the code's functionality and purpose. This can be useful if you want to understand the code's behavior or for non-technical stakeholders who need to understand how the code works. For example, if you select a function or code block in the code editor, {% data variables.product.prodname_copilot_chat_short %} can generate a natural language description of what the code does and how it fits into the overall system. This can include information such as the function's input and output parameters, its dependencies, and its purpose in the larger application.
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can also suggest potential improvements to selected code, such as improved handling of errors and edge cases, or changes to the logical flow to make the code more readable.
|
||||
|
||||
By generating explanations and suggesting related documentation, {% data variables.product.prodname_copilot_chat_short %} may help you to understand the selected code, leading to improved collaboration and more effective software development. However, it's important to note that the generated explanations and documentation may not always be accurate or complete, so you'll need to review, and occasionally correct, {% data variables.product.prodname_copilot_chat_short %}'s output.
|
||||
|
||||
### Proposing code fixes
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can propose a fix for bugs in your code by suggesting code snippets and solutions based on the context of the error or issue. This can be useful if you are struggling to identify the root cause of a bug or you need guidance on the best way to fix it. For example, if your code produces an error message or warning, {% data variables.product.prodname_copilot_chat_short %} can suggest possible fixes based on the error message, the code's syntax, and the surrounding code.
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can suggest changes to variables, control structures, or function calls that might resolve the issue and generate code snippets that can be incorporated into the codebase. However, it's important to note that the suggested fixes may not always be optimal or complete, so you'll need to review and test the suggestions.
|
||||
|
||||
### Planning coding tasks
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can read a {% data variables.product.prodname_dotcom %} issue and summarize it, answer questions about it, or propose next steps. This can be useful if you have a long, complex issue with many comments, and you want to understand it quickly or figure out what to do next.
|
||||
|
||||
However, it's important to note that {% data variables.product.prodname_copilot_chat_short %}'s answers and summaries may not always be accurate or complete, so you'll need to review {% data variables.product.prodname_copilot_chat_short %}'s output for accuracy.
|
||||
|
||||
## Improving performance for {% data variables.product.prodname_copilot_chat_short %}
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can support a wide range of practical applications like Q&A, code generation, code analysis, and code fixes, each with different performance metrics and mitigation strategies. To enhance performance and address some of the the limitations of {% data variables.product.prodname_copilot_chat_short %}, there are various measures that you can adopt. For more information on the limitations of {% data variables.product.prodname_copilot_chat_short %}, see "[Limitations of {% data variables.product.prodname_copilot_chat %}](#limitations-of-github-copilot-chat)."
|
||||
|
||||
### Keep your prompts on topic
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} is intended to address queries related to coding exclusively. Therefore, limiting the prompt to coding questions or tasks can enhance the model's output quality.
|
||||
|
||||
### Use {% data variables.product.prodname_copilot_chat_short %} as a tool, not a replacement
|
||||
|
||||
While {% data variables.product.prodname_copilot_chat_short %} can be a powerful tool for generating code, it is important to use it as a tool rather than a replacement for human programming. You should always review and test the code generated by {% data variables.product.prodname_copilot_chat_short %} to ensure that it meets your requirements and is free of errors or security concerns.
|
||||
|
||||
### Use secure coding and code review practices
|
||||
|
||||
While {% data variables.product.prodname_copilot_chat_short %} can generate syntactically correct code, it may not always be secure. You should always follow best practices for secure coding, such as avoiding hard-coded passwords or SQL injection vulnerabilities, as well as following code review best practices, to address {% data variables.product.prodname_copilot_chat_short %}'s limitations.
|
||||
|
||||
### Provide feedback
|
||||
|
||||
{% data reusables.rai.copilot-dotcom-feedback-collection %}
|
||||
|
||||
If you encounter any issues or limitations with {% data variables.product.prodname_copilot_chat_dotcom_short %}, we recommend that you provide feedback by clicking the thumbs down icon below each chat response. This can help the developers to improve the tool and address any concerns or limitations.
|
||||
|
||||
### Stay up to date
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} is a new technology and is likely to evolve over time. For {% data variables.product.prodname_copilot_chat_dotcom %} you will always have access to the latest product experience. You should stay up to date with any new security risks or best practices that may emerge.
|
||||
|
||||
## Limitations of {% data variables.product.prodname_copilot_chat %}
|
||||
|
||||
Depending on factors such as your codebase and input data, you may experience different levels of performance when using {% data variables.product.prodname_copilot_chat_short %}. The following information is designed to help you understand system limitations and key concepts about performance as they apply to {% data variables.product.prodname_copilot_chat_short %}.
|
||||
|
||||
### Limited scope
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} has been trained on a large body of code but still has a limited scope and may not be able to handle more complex code structures or obscure programming languages. For each language, the quality of suggestions you receive may depend on the volume and diversity of training data for that language. For example, JavaScript is well-represented in public repositories and is one of {% data variables.product.prodname_copilot %}'s best supported languages. Languages with less representation in public repositories may be more challenging for {% data variables.product.prodname_copilot_chat_short %} to provide assistance with. Additionally, {% data variables.product.prodname_copilot_chat_short %} can only suggest code based on the context of the code being written, so it may not be able to identify larger design or architectural issues.
|
||||
|
||||
### Potential biases
|
||||
|
||||
{% data variables.product.prodname_copilot_short %}'s training data (drawn from existing code repositories) and context gathered by the large language model (for example, Bing search results) may contain biases and errors that can be perpetuated by the tool. Additionally, {% data variables.product.prodname_copilot_chat_short %} may be biased towards certain programming languages or coding styles, which can lead to suboptimal or incomplete code suggestions.
|
||||
|
||||
### Security risks
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} generates code based on the context of the code being written, which can potentially expose sensitive information or vulnerabilities if not used carefully. You should be careful when using {% data variables.product.prodname_copilot_chat_short %} to generate code for security-sensitive applications and always review and test the generated code thoroughly.
|
||||
|
||||
### Matches with public code
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} is capable of generating new code, which it does in a probabilistic way. While the probability that it may produce code that matches code in the training set is low, a {% data variables.product.prodname_copilot_chat_short %} suggestion may contain some code snippets that match code in the training set. {% data variables.product.prodname_copilot_chat_short %} utilizes filters that block matches with public code on {% data variables.product.prodname_dotcom %} repositories, but you should always take the same precautions as you would with any code you write that uses material you did not independently originate, including precautions to ensure its suitability. These include rigorous testing, IP scanning, and checking for security vulnerabilities.
|
||||
|
||||
### Inaccurate code
|
||||
|
||||
One of the limitations of {% data variables.product.prodname_copilot_chat_short %} is that it may generate code that appears to be valid but may not actually be semantically or syntactically correct or may not accurately reflect the intent of the developer. To mitigate the risk of inaccurate code, you should carefully review and test the generated code, particularly when dealing with critical or sensitive applications. You should also ensure that the generated code adheres to best practices and design patterns and fits within the overall architecture and style of the codebase.
|
||||
|
||||
### Inaccurate responses to non-coding topics
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} is not designed to answer non-coding questions, and therefore its responses may not always be accurate or helpful in these contexts. If a user asks {% data variables.product.prodname_copilot_chat_short %} a non-coding question, it may generate an answer that is irrelevant or nonsensical, or it may simply indicate that it is unable to provide a useful response.
|
||||
|
||||
### Leveraging a web search to answer a question
|
||||
|
||||
Depending on the question you ask, {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_dotcom_the_website %} can optionally use a Bing search to help answer your question. {% data variables.product.prodname_copilot_short %} will use Bing for queries about recent events, new trends or technologies, highly specific subjects, or when a web search is explicitly requested by the user. Your {% data variables.product.prodname_enterprise %} administrator can enable Bing for your whole enterprise, or can delegate this decision to the organizational administrator. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-features-on-githubcom)."
|
||||
|
||||
When leveraging Bing, {% data variables.product.prodname_copilot_short %} will use the content of your prompt, as well as additional available context, to generate a Bing search query on your behalf that is sent to the Bing Search API. {% data variables.product.prodname_copilot_short %} will provide a link to the search results with its response. The search query sent to Bing is governed by [Microsoft's Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement).
|
||||
|
||||
## Next steps
|
||||
|
||||
For details of how to use {% data variables.product.prodname_copilot_chat_dotcom %}, see:
|
||||
|
||||
- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)"
|
||||
- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/)
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Copilot Chat in GitHub.com
|
||||
intro: 'You can chat with {% data variables.product.prodname_copilot_chat_dotcom_short %} in {% data variables.product.prodname_dotcom_the_website %} to learn out about aspects of software development, or to understand or improve specific lines of code.'
|
||||
versions:
|
||||
feature: 'copilot-on-dotcom'
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-enterprise/copilot-chat-in-github
|
||||
children:
|
||||
- /about-github-copilot-chat-in-githubcom
|
||||
- /using-github-copilot-chat-in-githubcom
|
||||
- /managing-copilot-knowledge-bases
|
||||
---
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: Managing Copilot knowledge bases
|
||||
shortTitle: Manage knowledge bases
|
||||
intro: 'Organization owners can create a knowledge base bringing together Markdown documentation across one or more repositories, and then organization members can use that knowledge base as context for {% data variables.product.prodname_copilot_chat_dotcom_short %}.'
|
||||
versions:
|
||||
feature: copilot-private-docsets
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-enterprise/copilot-docset-management/creating-private-docsets
|
||||
- /copilot/github-copilot-enterprise/copilot-docset-management
|
||||
- /copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases
|
||||
---
|
||||
|
||||
## About knowledge bases
|
||||
|
||||
Organization owners can create knowledge bases, bringing together Markdown documentation across one or more repositories. Organization members can then specify that knowledge base as the context for {% data variables.product.prodname_copilot_chat_dotcom_short %}.
|
||||
|
||||
When you ask a question in {% data variables.product.prodname_copilot_chat_dotcom_short %}, {% data variables.product.prodname_copilot %} will search the knowledge base for relevant information and synthesize a response. For more information on how to use knowledge bases in {% data variables.product.prodname_copilot_chat_dotcom_short %}, see "[Asking a question about a knowledge base](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom/#asking-a-question-about-a-knowledge-base)."
|
||||
|
||||
## Creating a knowledge base
|
||||
|
||||
You can create a knowledge base from a single repository or a selection of repositories. You can create a knowledge base using public, private, and/or internal repositories.
|
||||
|
||||
Knowledge bases you create will be accessible by all organization members with a {% data variables.product.prodname_copilot_enterprise %} subscription. When an organization member uses a knowledge base as context in {% data variables.product.prodname_copilot_chat_dotcom_short %}, the response will only use data from repositories that the organization member has read access to.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
|
||||
1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Customize**.
|
||||
1. To the right of "Knowledge", click **Add knowledge base**.
|
||||
1. In the "Name" field, enter a unique name for the knowledge base. Optionally, in the "Description" field, you can add a description for the knowledge base.
|
||||
|
||||
|
||||
|
||||
1. Under "Content", to see a full list of available repositories, click **Select repositories**.
|
||||
|
||||
|
||||
|
||||
1. To select a repository or repositories, click the checkbox next to the repository name. When you're finished selecting repositories, click **Apply**.
|
||||
|
||||
|
||||
|
||||
1. Optionally, you can define which paths within the selected repositories to index.
|
||||
|
||||
- Click **Edit file paths**.
|
||||
|
||||
|
||||
|
||||
- List the paths you want to include in the knowledge base, one path per line. When you're finished, click **Apply**.
|
||||
|
||||
1. Click **Create knowledge base**.
|
||||
|
||||
## Updating a knowledge base
|
||||
|
||||
Organization owners can delete a knowledge base created in their organization.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
|
||||
1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Customize**.
|
||||
1. To the right of the knowledge base you want to edit, click {% octicon "pencil" aria-label="The pencil symbol" %}.
|
||||
1. Make your desired changes to your knowledge base.
|
||||
1. Click **Update knowledge base**.
|
||||
|
||||
## Deleting a knowledge base
|
||||
|
||||
Organization owners can delete a knowledge base created in their organization.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
|
||||
1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Customize**.
|
||||
1. To the right of the knowledge base you want to delete, click {% octicon "trash" aria-label="The trash symbol" %}.
|
||||
1. In the "Confirm deletion" dialog box, review the information and click **Delete**.
|
||||
@@ -0,0 +1,330 @@
|
||||
---
|
||||
title: Using GitHub Copilot Chat in GitHub.com
|
||||
shortTitle: Use Copilot Chat
|
||||
intro: 'You can use {% data variables.product.prodname_copilot_chat_dotcom %} to answer general questions about software development, or specific questions about the issues or code in a repository.'
|
||||
versions:
|
||||
feature: 'copilot-on-dotcom'
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_dotcom %} is a chat interface that lets you ask and receive answers to coding-related questions on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data variables.product.prodname_copilot_chat_short %} is also available in selected IDEs. For information on using {% data variables.product.prodname_copilot_chat %} in an IDE, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can help you with a variety of coding-related tasks, like offering you code suggestions, providing natural language descriptions of a piece of code's functionality and purpose, generating unit tests for your code, and proposing fixes for bugs in your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom)."
|
||||
|
||||
On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask:
|
||||
|
||||
- General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)."
|
||||
- Exploratory questions asked in the context of a specific repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)."
|
||||
- Questions asked in the context of a specific repository, file or symbol. For more information, see "[Asking a question about a specific file or symbol](#asking-a-question-about-a-specific-file-or-symbol)."
|
||||
- Questions asked in the context of a knowledge base (that is, Markdown documentation across one or more repositories). For more information, see "[Asking a question about a knowledge base](#asking-a-question-about-a-knowledge-base)."
|
||||
- Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)."
|
||||
- Questions about a pull request diff. For more information, see "[Finding out about the changes in a pull request](#finding-out-about-the-changes-in-a-pull-request)."
|
||||
- Questions about a specific issue. For more information, see "[Asking a question about a specific issue](#asking-a-question-about-a-specific-issue)."
|
||||
|
||||
### Limitations
|
||||
|
||||
- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)."
|
||||
- The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
{% data reusables.copilot.chat-subscription-prerequisite %}
|
||||
- To use {% data variables.product.prodname_copilot_chat_dotcom %}, you must have been granted access to {% data variables.product.prodname_copilot_chat %} as part of {% data variables.product.prodname_copilot_enterprise %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)."
|
||||
|
||||
## Powered by skills
|
||||
|
||||
Under the hood, {% data variables.product.prodname_copilot_short %} is powered by a collection of skills that are dynamically selected based on the question you ask. You can tell which skill was selected by {% data variables.product.prodname_copilot_short %} based on the status updates in the chat window.
|
||||
|
||||
You can also 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
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: You can generate this list yourself by asking {% data variables.product.prodname_copilot_short %}: `What skills do you have available?`
|
||||
|
||||
{% endnote %}
|
||||
|
||||
| Skill | Description | Enabled by default? | Example question |
|
||||
| ------- | ----------- | ------------------ | -------------|
|
||||
| `codesearch` | Natural language 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. Note: this requires indexing to be enabled for the repository (see the note above indexing [below](#repo-indexing-note)). | Yes | _Where is the logic that controls the user session management, and how does it work?_ |
|
||||
| `show-symbol-definition` | Retrieves the lines of code that define a specific code symbol (function, class, or struct) in the default branch of the Git repository. This skill is useful when you have the exact name of a symbol, and want to understand it. | Yes | _Write unit tests for the AuthUser method_ |
|
||||
| `pathsearch` | 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 | _What logic does user_auth.js encapsulate?_ |
|
||||
| `bing-search` | Searches the web using the Bing search engine. This skill is useful for teaching Copilot about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No (requires admin approval - see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)")| _What are some recent articles about SAT tokens securing against vulnerabilities in Node?_ |
|
||||
| `get-issue` | 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_ |
|
||||
|
||||
## Asking a general question about software development
|
||||
|
||||
You can ask a general question about software development that is not focused on a particular context, such as a repository or a knowledge base.
|
||||
|
||||
Depending on the question you ask, and your enterprise and organization settings, {% data variables.product.prodname_copilot_short %} may respond using information based on the results of a Bing search. By using Bing search, {% data variables.product.prodname_copilot_short %} can answer a broad range of tech-related questions with up-to-date details based on information currently available on the internet. For information on how to enable or disable Bing search integration, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-features-on-githubcom)."
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Bing search integration into {% data variables.product.prodname_copilot_chat_dotcom_short %} is currently in beta and is subject to change.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.copilot.go-to-copilot-page %}
|
||||
|
||||
1. If the panel is headed "Chatting about OWNER/REPOSITORY," click **All repositories**.
|
||||
|
||||
|
||||
|
||||
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is displayed in the panel, click **General purpose chat**.
|
||||
|
||||
|
||||
|
||||
1. At the bottom of the panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
||||
|
||||
Some examples of general questions you could ask are:
|
||||
- What are the advantages of the Go programming language?
|
||||
- What is Agile software development?
|
||||
- What is the most popular JavaScript framework?
|
||||
- Give me some examples of regular expressions.
|
||||
- Write a bash script to output today's date.
|
||||
|
||||
1. If {% data variables.product.prodname_copilot_short %} uses a Bing search to answer your question, "Results from Bing" is displayed above the response. Click this to see the search results that {% data variables.product.prodname_copilot_short %} used to answer your question.
|
||||
1. Within a conversation thread, you can ask follow-up questions. {% data variables.product.prodname_copilot_short %} will answer within the context of the conversation. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment.
|
||||
|
||||
You can use your initial question as a foundation for follow-up questions. A detailed foundational prompt can help {% data variables.product.prodname_copilot_short %} provide more relevant answers to your follow-up questions. For more information, see "[Prompting {% data variables.product.prodname_copilot_chat %} to become your personal AI assistant for accessibility](https://github.blog/2023-10-09-prompting-github-copilot-chat-to-become-your-personal-ai-assistant-for-accessibility/)" on the {% data variables.product.prodname_dotcom %} Blog.
|
||||
|
||||
{% data reusables.copilot.chat-conversation-buttons %}
|
||||
|
||||
## Asking exploratory questions about a repository
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} allows you to use natural language questions to explore repositories on {% data variables.product.prodname_dotcom %}. This can help you get a better understanding of where specific aspects of a codebase are implemented.
|
||||
|
||||
{% data reusables.copilot.go-to-copilot-page %}
|
||||
|
||||
{% data reusables.copilot.ask-copilot-not-displayed %}
|
||||
|
||||
<a id="repo-indexing-note"></a>
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:**
|
||||
|
||||
{% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. The indexing status of the repository is displayed when you start a conversation that has a repository context.
|
||||
|
||||
If you get access to {% data variables.product.prodname_copilot_short %} from the organization that owns the repository, and the repository has not been indexed, an **Index REPOSITORY NAME** button is displayed. Click this button to start the indexing process.
|
||||
|
||||
|
||||
|
||||
{% endnote %}
|
||||
|
||||
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
||||
|
||||
For example, you could ask:
|
||||
|
||||
- Where is rate limiting implemented in our API?
|
||||
- How does the WidgetFactory class work?
|
||||
- Where is the code for converting an organization member to be an outside collaborator?
|
||||
- Where are SAT tokens generated?
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} replies in the chat panel.
|
||||
|
||||
{% data reusables.copilot.chat-conversation-buttons %}
|
||||
|
||||
## Asking a question about a specific file or symbol
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} about a specific file or symbol within a repository.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** A "symbol" is a named entity in code. This could be a variable, function, class, module, or any other identifier that's part of a codebase.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.copilot.go-to-copilot-page %}
|
||||
|
||||
{% data reusables.copilot.ask-copilot-not-displayed %}
|
||||
|
||||
1. Click the "Attach files or symbols" button (a paperclip icon) at the bottom of the chat panel, then search for and select one or more files and symbols.
|
||||
|
||||
|
||||
|
||||
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} replies in the chat panel.
|
||||
|
||||
{% data reusables.copilot.chat-conversation-buttons %}
|
||||
|
||||
## Asking a question about a knowledge base
|
||||
|
||||
Organization owners can create knowledge bases, grouping together Markdown documentation across one or more repositories. You can use a knowledge base to ask questions with that context in mind.
|
||||
|
||||
When you enter a query, {% data variables.product.prodname_copilot_short %} searches for relevant documentation snippets, synthesizes a summary of the relevant snippets to answer your question, and provides links to the source documentation for additional context.
|
||||
|
||||
{% data reusables.copilot.go-to-copilot-page %}
|
||||
|
||||
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is not displayed in the panel, click **All repositories**.
|
||||
|
||||
|
||||
|
||||
1. Start a conversation with {% data variables.product.prodname_copilot_short %} by either selecting a repository or clicking **General purpose chat**.
|
||||
1. Click the "Attach knowledge" button (a book icon) at the bottom of the chat panel, to view a list of the knowledge bases that you have access to.
|
||||
|
||||
|
||||
|
||||
1. Click the knowledge base that you want to use as context.
|
||||
|
||||
For example, you could choose a knowledge base containing your organization's internal developer documentation.
|
||||
|
||||
You can search for a knowledge base if you don't see one you want to use.
|
||||
|
||||
|
||||
|
||||
1. At the bottom of the page, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
||||
|
||||
For example, if you chose a knowledge base with your organization's internal developer documentation, you could ask:
|
||||
|
||||
- How do I deploy a new application?
|
||||
- What's the process for creating a new REST API?
|
||||
- What are our best practices for logging?
|
||||
|
||||
1. The response will typically contain numbered references to files that {% data variables.product.prodname_copilot_short %} uses to generate the answer, from the knowledge base you selected. To list the sources that were used, click **NUMBER references**.
|
||||
|
||||
|
||||
|
||||
1. To display information about a source reference, click its entry in the list.
|
||||
|
||||
Alternatively, to open the complete file, click the ellipsis (**...**), then select **Open**.
|
||||
|
||||
1. Within a conversation thread, you can ask follow-up questions. Follow-up questions will continue to use the selected knowledge base as context until you explicitly detach the knowledge base or select a different one.
|
||||
|
||||
{% data reusables.copilot.chat-conversation-buttons %}
|
||||
|
||||
## Asking questions about specific pieces of code
|
||||
|
||||
You can chat with {% data variables.product.prodname_copilot_short %} about a file in your repository, or about specific lines of code within a file.
|
||||
|
||||
1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository and open a file.
|
||||
1. Do one of the following:
|
||||
- To ask a question about the entire file, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) at the top right of the file view.
|
||||
|
||||
|
||||
|
||||
- To ask a question about specific lines within the file:
|
||||
|
||||
1. Select the lines by clicking the line number for the first line you want to select, holding down <kbd>Shift</kbd> and clicking the line number for the last line you want to select.
|
||||
1. To ask your own question about the selected lines, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) to the right of your selection.
|
||||
This displays the {% data variables.product.prodname_copilot_chat %} panel with the selected lines indicated as the context of your question.
|
||||
1. To ask a predefined question, click the downward-pointing button beside the {% data variables.product.prodname_copilot_short %} icon, then choose one of the options.
|
||||
|
||||
|
||||
|
||||
1. If you clicked the {% data variables.product.prodname_copilot_short %} icon, type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press <kbd>Enter</kbd>.
|
||||
|
||||
For example, if you are asking about the entire file, you could enter:
|
||||
|
||||
- Explain this file.
|
||||
- How could I improve this code?
|
||||
- How can I test this script?
|
||||
|
||||
If you are asking about specific lines, you could enter:
|
||||
- Explain the function at the selected lines.
|
||||
- How could I improve this class?
|
||||
- Add error handling to this code.
|
||||
- Write a unit test for this method.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} responds to your request in the panel.
|
||||
|
||||
|
||||
|
||||
1. You can continue the conversation by asking a follow-up question. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment.
|
||||
1. To clear, delete, or rename the current conversation thread, or to start a new thread, type `/` in the "Ask {% data variables.product.prodname_copilot_short %}" box, select from the options that are displayed, then press <kbd>Enter</kbd>.
|
||||
|
||||
1. To view a conversation in immersive mode, displaying just the conversation thread, click the dashed box icon at the top right of the conversation thread.
|
||||
|
||||
|
||||
|
||||
## Finding out about the changes in a pull request
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} to explain what's changed in any of the files in a pull request.
|
||||
|
||||
1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a pull request in a repository.
|
||||
1. Click the **Files changed** tab.
|
||||
1. Do one of the following:
|
||||
|
||||
- To ask a question about a file that's being changed by a pull request, click {% octicon "kebab-horizontal" aria-label="Show options" %} at the top right of the file, then click **Ask {% data variables.product.prodname_copilot_short %} about this diff**.
|
||||
- To ask a question about specific lines within a file in the pull request:
|
||||
|
||||
1. Select the lines by clicking the line number for the first line you want to select, holding down <kbd>Shift</kbd> and clicking the line number for the last line you want to select.
|
||||
1. To ask your own question about the selected lines, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) to the right of your selection.
|
||||
This displays the {% data variables.product.prodname_copilot_chat %} panel with the selected lines indicated as the context of your question.
|
||||
1. To ask a predefined question, click the downward-pointing button beside the {% data variables.product.prodname_copilot_short %} icon and click **Explain**.
|
||||
|
||||
1. If you clicked the {% data variables.product.prodname_copilot_short %} icon, or you chose **Ask {% data variables.product.prodname_copilot_short %} about this diff**, type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press <kbd>Enter</kbd>. For example, you could enter:
|
||||
|
||||
- Why has this module been included?
|
||||
- What is `actorData` in this line?
|
||||
- Explain this `do..end` block.
|
||||
- What's the purpose of this file?
|
||||
|
||||
## Asking a question about a specific issue
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} to summarize or answer questions about a specific issue. {% data variables.product.prodname_copilot_short %} has access to the issue's title, number, author, status, body, linked pull requests, and comments.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The quality of {% data variables.product.prodname_copilot_chat_short %}'s responses may be degraded when working with issues with very long bodies or large numbers of comments. Where this happens, {% data variables.product.prodname_copilot_short %} will warn you so you can double check its output.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
1. Navigate to an issue on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
{% data reusables.copilot.open-copilot %}
|
||||
|
||||
1. At the bottom of the {% data variables.product.prodname_copilot_short %} chat panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>. For example, you could enter:
|
||||
|
||||
- Summarize this issue
|
||||
- Recommend next steps for this issue
|
||||
- What are the acceptance criteria for this issue?
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** Instead of navigating to an issue in your browser, you can also refer to a specific issue in your message, for example `Summarize https://github.com/monalisa/octokit/issues/1`.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} responds to your request in the panel.
|
||||
|
||||
## Accessing {% data variables.product.prodname_copilot_chat_short %} from the search bar
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} a question about an entire repository by typing your question in the main search box of the repository.
|
||||
|
||||
1. Navigate to a repository on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
1. Press <kbd>/</kbd>, or click in the main search box at the top of the page.
|
||||
1. In the search box, after `repo:OWNER/REPO`, type the question you want to ask {% data variables.product.prodname_copilot_short %}.
|
||||
|
||||
For example, you could enter:
|
||||
|
||||
- What does this repo do?
|
||||
- Where is authentication implemented in this codebase?
|
||||
- How does license file detection work in this repo?
|
||||
|
||||
1. Click **Ask {% data variables.product.prodname_copilot_short %}**.
|
||||
|
||||
|
||||
|
||||
The {% data variables.product.prodname_copilot_chat %} panel is displayed and {% data variables.product.prodname_copilot_short %} responds to your request.
|
||||
|
||||
## Sharing feedback about {% data variables.product.prodname_copilot_chat_dotcom %}
|
||||
|
||||
{% data reusables.rai.copilot-dotcom-feedback-collection %}
|
||||
|
||||
To give feedback about a particular {% data variables.product.prodname_copilot_chat_short %} response, click either the thumbs up or thumbs down icon at the bottom of each chat response.
|
||||
|
||||
To give feedback about {% data variables.product.prodname_copilot_chat_short %} in general, click the ellipsis (**...**) at the top right of the chat panel, then click **Give feedback**.
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
title: About GitHub Copilot Chat in your IDE
|
||||
intro: '{% data variables.product.prodname_copilot_chat %} can help you by providing answers to coding related questions {% ifversion ghec %}on {% data variables.product.prodname_dotcom_the_website %} or{% endif %} directly within a supported IDE.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /early-access/copilot/github-copilot-chat-transparency-note
|
||||
- /early-access/copilot/github-copilot-chat-technical-preview-license-terms
|
||||
- /copilot/github-copilot-chat/about-github-copilot-chat
|
||||
product: '{% data reusables.gated-features.copilot-chat-callout %}'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: About Copilot Chat (IDE)
|
||||
shortTitle: About Copilot Chat
|
||||
type: rai
|
||||
---
|
||||
|
||||
@@ -40,7 +40,7 @@ The language model generates a response based on its analysis of the input promp
|
||||
|
||||
The response generated by {% data variables.product.prodname_copilot_chat_short %} is formatted and presented to the user. {% data variables.product.prodname_copilot_chat_short %} may use syntax highlighting, indentation, and other formatting features to add clarity to the generated response. Depending upon the type of question from the user, links to context that the model used when generating a response, such as source code files or documentation, may also be provided.
|
||||
|
||||
{% data variables.product.prodname_copilot_chat %} is intended to provide you with the most relevant answer to your question. However, it may not always provide the answer you are looking for. Users of {% data variables.product.prodname_copilot_chat_short %} are responsible for reviewing and validating responses generated by the system to ensure they are accurate and appropriate. Additionally, as part of our product development process, we undertake red teaming to understand and improve the safety of {% data variables.product.prodname_copilot_chat_short %}. Input prompts and output completions are run through content filters. The content filtering system detects and prevents the output on specific categories of content including harmful, offensive, or off-topic content. For more information on improving the performance of {% data variables.product.prodname_copilot_chat %}, see "[Improving performance for {% data variables.product.prodname_copilot_chat %}](/copilot/github-copilot-chat/about-github-copilot-chat#improving-performance-for-github-copilot-chat)."
|
||||
{% data variables.product.prodname_copilot_chat %} is intended to provide you with the most relevant answer to your question. However, it may not always provide the answer you are looking for. Users of {% data variables.product.prodname_copilot_chat_short %} are responsible for reviewing and validating responses generated by the system to ensure they are accurate and appropriate. Additionally, as part of our product development process, we undertake red teaming to understand and improve the safety of {% data variables.product.prodname_copilot_chat_short %}. Input prompts and output completions are run through content filters. The content filtering system detects and prevents the output on specific categories of content including harmful, offensive, or off-topic content. For more information on improving the performance of {% data variables.product.prodname_copilot_chat %}, see "[Improving performance for {% data variables.product.prodname_copilot_chat %}](/copilot/github-copilot-chat/copilot-chat-in-ides/about-github-copilot-chat-in-your-ide#improving-performance-for-github-copilot-chat)."
|
||||
|
||||
## Use cases for {% data variables.product.prodname_copilot_chat %}
|
||||
|
||||
@@ -50,7 +50,7 @@ The response generated by {% data variables.product.prodname_copilot_chat_short
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can help you write unit test cases by generating code snippets based on the code open in the editor or the code snippet you highlight in the editor. This may help you write test cases without spending as much time on repetitive tasks. For example, if you are writing a test case for a specific function, you can use {% data variables.product.prodname_copilot_chat_short %} to suggest possible input parameters and expected output values based on the function's signature and body. {% data variables.product.prodname_copilot_chat_short %} can also suggest assertions that ensure the function is working correctly, based on the code's context and semantics.
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can also help you write test cases for edge cases and boundary conditions that might be difficult to identify manually. For instance, {% data variables.product.prodname_copilot_chat_short %} can suggest test cases for error handling, null values, or unexpected input types, helping you ensure your code is robust and resilient. However, it is important to note that generated test cases may not cover all possible scenarios, and manual testing and code review are still necessary to ensure the quality of the code. For more information on generating unit test cases, see "[Asking {% data variables.product.prodname_copilot_chat %} questions about your code](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide#asking-github-copilot-chat-questions-about-your-code)."
|
||||
{% data variables.product.prodname_copilot_chat_short %} can also help you write test cases for edge cases and boundary conditions that might be difficult to identify manually. For instance, {% data variables.product.prodname_copilot_chat_short %} can suggest test cases for error handling, null values, or unexpected input types, helping you ensure your code is robust and resilient. However, it is important to note that generated test cases may not cover all possible scenarios, and manual testing and code review are still necessary to ensure the quality of the code. For more information on generating unit test cases, see "[Asking {% data variables.product.prodname_copilot_chat %} questions about your code](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide#asking-github-copilot-chat-questions-about-your-code)."
|
||||
|
||||
### Explaining code and suggesting improvements
|
||||
|
||||
@@ -72,7 +72,7 @@ You can ask {% data variables.product.prodname_copilot_chat_short %} for help or
|
||||
|
||||
## Improving performance for {% data variables.product.prodname_copilot_chat %}
|
||||
|
||||
{% data variables.product.prodname_copilot_chat_short %} can support a wide range of practical applications like code generation, code analysis, and code fixes, each with different performance metrics and mitigation strategies. To enhance performance and address some of the the limitations of {% data variables.product.prodname_copilot_chat_short %}, there are various measures that you can adopt. For more information on the limitations of {% data variables.product.prodname_copilot_chat_short %}, see "[Limitations of {% data variables.product.prodname_copilot_chat %}](/copilot/github-copilot-chat/about-github-copilot-chat#limitations-of-github-copilot-chat)."
|
||||
{% data variables.product.prodname_copilot_chat_short %} can support a wide range of practical applications like code generation, code analysis, and code fixes, each with different performance metrics and mitigation strategies. To enhance performance and address some of the the limitations of {% data variables.product.prodname_copilot_chat_short %}, there are various measures that you can adopt. For more information on the limitations of {% data variables.product.prodname_copilot_chat_short %}, see "[Limitations of {% data variables.product.prodname_copilot_chat %}](/copilot/github-copilot-chat/copilot-chat-in-ides/about-github-copilot-chat-in-your-ide#limitations-of-github-copilot-chat)."
|
||||
|
||||
### Keep your prompts on topic
|
||||
|
||||
@@ -126,8 +126,8 @@ One of the limitations of {% data variables.product.prodname_copilot_chat_short
|
||||
|
||||
For details of how to use {% data variables.product.prodname_copilot_chat %}, see:
|
||||
|
||||
- "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)"
|
||||
- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}
|
||||
- "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide)"
|
||||
- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Copilot Chat in IDEs
|
||||
intro: 'You can chat with {% data variables.product.prodname_copilot_chat_dotcom_short %} in IDEs to learn out about aspects of software development, or to understand or improve specific lines of code.'
|
||||
versions:
|
||||
feature: 'copilot'
|
||||
children:
|
||||
- /about-github-copilot-chat-in-your-ide
|
||||
- /using-github-copilot-chat-in-your-ide
|
||||
---
|
||||
@@ -5,10 +5,11 @@ topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-chat/using-github-copilot-chat
|
||||
- /copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide
|
||||
defaultTool: vscode
|
||||
versions:
|
||||
feature: copilot
|
||||
shortTitle: Use Copilot Chat (IDE)
|
||||
shortTitle: Use Copilot Chat
|
||||
---
|
||||
|
||||
{% vscode %}
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: About GitHub Copilot Extensions
|
||||
intro: '{% data variables.product.prodname_copilot_extensions %} are integrations for external tools in {% data variables.product.prodname_copilot_chat %}.'
|
||||
product: '{% data reusables.gated-features.copilot-extensions %}'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: About Copilot Extensions
|
||||
type: overview
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %}
|
||||
|
||||
> [!NOTE] {% data variables.product.prodname_copilot_extensions %} are not the same as the {% data variables.product.prodname_copilot %} extension, which you install in an external application to access {% data variables.product.prodname_copilot_short %} within that application. For more information on the {% data variables.product.prodname_copilot %} extension, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)."
|
||||
|
||||
After you install a {% data variables.product.prodname_copilot_extension_short %} from {% data variables.product.prodname_marketplace %}, you can interact with that extension in a {% data variables.product.prodname_copilot_chat_short %} conversation, asking questions and authorizing actions that combine the capabilities of the external tool and {% data variables.product.prodname_dotcom %}. For example, if you install the Sentry extension for {% data variables.product.prodname_copilot %}, you can use the extension to get information about Sentry issues, then create and assign related tracking issues on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} provide several benefits, including:
|
||||
|
||||
- Interaction with external tools using natural language
|
||||
- Reduced context switching
|
||||
- Customization of your {% data variables.product.prodname_copilot_chat_short %} experience for your developer flow
|
||||
|
||||
**{% data variables.product.prodname_copilot_extensions_short %} are included in all {% data variables.product.prodname_copilot_short %} subscriptions**, and can be used with:
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.compatible-chat-interfaces %}
|
||||
|
||||
## Next steps
|
||||
|
||||
If you have a {% data variables.product.prodname_copilot_individuals_short %} subscription, to get started with {% data variables.product.prodname_copilot_extensions_short %}, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account)."
|
||||
|
||||
If you are an organization owner or enterprise administrator with a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, you should set a policy for {% data variables.product.prodname_copilot_extension_short %} usage in your enterprise or organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions)."
|
||||
|
||||
If you are a developer with {% data variables.product.prodname_copilot_short %} access through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, to get started with {% data variables.product.prodname_copilot_extensions_short %}, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: GitHub Copilot Extensions
|
||||
shortTitle: Copilot Extensions
|
||||
intro: 'Learn about {% data variables.product.prodname_copilot_extensions %} (beta) and their uses.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /about-github-copilot-extensions
|
||||
- /managing-github-copilot-extensions
|
||||
- /installing-github-copilot-extensions-for-your-personal-account
|
||||
- /installing-github-copilot-extensions-for-your-organization
|
||||
- /using-github-copilot-extensions
|
||||
---
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Installing GitHub Copilot Extensions for your organization
|
||||
intro: 'You can install {% data variables.product.prodname_copilot_extensions %} for your organization from {% data variables.product.prodname_marketplace %}.'
|
||||
product: 'Organization owners can install {% data variables.product.prodname_copilot_extensions %} for an organization.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Install organization extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About installing {% data variables.product.prodname_copilot_extensions %} for your organization
|
||||
|
||||
Before you install any {% data variables.product.prodname_copilot_extensions_short %} in your organization, you should set a usage policy for {% data variables.product.prodname_copilot_extensions_short %} at the {% ifversion ghec %}enterprise or {% endif %}organization level. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions)."
|
||||
|
||||
Any organization owner can install {% data variables.product.prodname_copilot_extensions_short %} for their organization, but your organization must meet the following criteria to use an installed {% data variables.product.prodname_copilot_extension_short %}:
|
||||
|
||||
- Your organization is enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
- Your organization has an active {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription.
|
||||
|
||||
> [!NOTE] Anyone can install a {% data variables.product.prodname_copilot_extension_short %} on their personal account. However, if they get access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, they will only be able to use the extension if it is installed at the organization level.
|
||||
|
||||
## Installing {% data variables.product.prodname_copilot_extensions %} for your organization
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-on-marketplace %}
|
||||
|
||||
To install a {% data variables.product.prodname_copilot_extension_short %} on an organization with a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)."
|
||||
|
||||
## Next steps
|
||||
|
||||
After installing a {% data variables.product.prodname_copilot_extension_short %} for your organization, developers in your organization can start using the extension. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Installing GitHub Copilot Extensions for your personal account
|
||||
intro: 'You can install {% data variables.product.prodname_copilot_extensions %} for your personal account from {% data variables.product.prodname_marketplace %}.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Install personal extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About installing {% data variables.product.prodname_copilot_extensions %} for your personal account
|
||||
|
||||
Anyone can install {% data variables.product.prodname_copilot_extensions_short %} for their personal account, but you must meet the following criteria to use a {% data variables.product.prodname_copilot_extension_short %} you install:
|
||||
|
||||
- You are enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
- You have an active {% data variables.product.prodname_copilot_individuals_short %} subscription.
|
||||
|
||||
> [!NOTE] If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, {% data variables.product.prodname_copilot_extensions_short %} are installed by organization owners at the organization level, and you do not need to install the extension on your personal account. To start using {% data variables.product.prodname_copilot_extensions_short %} installed in your organization, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
|
||||
## Installing {% data variables.product.prodname_copilot_extensions %} for your personal account
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-on-marketplace %}
|
||||
|
||||
To install a {% data variables.product.prodname_copilot_extension_short %} on your personal account, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account#installing-a-github-app-in-your-personal-account)."
|
||||
|
||||
## Next steps
|
||||
|
||||
After installing a {% data variables.product.prodname_copilot_extension_short %}, you can start using the extension in {% data variables.product.prodname_copilot_chat_short %}. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Managing GitHub Copilot Extensions
|
||||
intro: 'You can manage {% data variables.product.prodname_copilot_extension %} policies and permissions in your organization{% ifversion ghec %} or enterprise{% endif %}.'
|
||||
product: 'Organization owners {% ifversion ghec %}and enterprise administrators {% endif %}can manage {% data variables.product.prodname_copilot_extensions_short %}.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Manage Copilot Extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About managing {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
Before you install {% data variables.product.prodname_copilot_extensions_short %} in your organization, you should set a usage policy for your {% ifversion ghec %}enterprise or {% endif %}organization. Setting a usage policy allows you to enable or disable {% data variables.product.prodname_copilot_extensions_short %} for all members of your {% ifversion ghec %}enterprise or {% endif %}organization, limiting your security risk. See {% ifversion ghec %}"[Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your enterprise](#setting-a-policy-for-github-copilot-extensions-in-your-enterprise)" and {% endif %}"[Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your organization](#setting-a-policy-for-github-copilot-extensions-in-your-organization)."
|
||||
|
||||
Additionally, after you install a {% data variables.product.prodname_copilot_extension_short %} in your organization, you can view and manage the permissions for that extension. See "[Managing permissions for a {% data variables.product.prodname_copilot_extension %} in your organization](#managing-permissions-for-a-github-copilot-extension-in-your-organization)."
|
||||
|
||||
{% ifversion ghec %}
|
||||
|
||||
## Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.copilot-tab %}
|
||||
{% data reusables.enterprise-accounts.copilot-policies-tab %}
|
||||
1. In the "{% data variables.product.prodname_copilot_extensions_short %}" section, select the dropdown menu, then click one of the following options:
|
||||
- **No policy**: organizations within your enterprise can set their own policies for {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
- **Enabled**: {% data variables.product.prodname_copilot_extensions_short %} are enabled for all organizations in your enterprise.
|
||||
- **Disabled**: {% data variables.product.prodname_copilot_extensions_short %} are disabled for all organizations in your enterprise.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your organization
|
||||
|
||||
{% ifversion ghec %}
|
||||
If {% data variables.product.prodname_copilot_extensions_short %} have not been enabled or disabled at the enterprise level, you can set a {% data variables.product.prodname_copilot_extensions_short %} policy for your organization.
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.copilot.policy-settings %}
|
||||
1. In the "{% data variables.product.prodname_copilot_extensions_short %}" section, select the dropdown menu, then enable or disable {% data variables.product.prodname_copilot_extensions_short %} for your organization.
|
||||
|
||||
## Managing permissions for a {% data variables.product.prodname_copilot_extension %} in your organization
|
||||
|
||||
After you have installed a {% data variables.product.prodname_copilot_extension_short %} in your organization, you can view the permissions the extension has in your organization, and why those permissions are necessary. If you do not want the {% data variables.product.prodname_copilot_extension_short %} to have the listed permissions, you can suspend or uninstall the extension.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.apps.access-org-app-settings %}
|
||||
1. Optionally, to filter your installed {% data variables.product.prodname_github_apps %} for {% data variables.product.prodname_copilot_extensions_short %}, select the **Filter:** dropdown menu, then click **{% data variables.product.prodname_copilot_extensions_short %}**.
|
||||
1. Next to the {% data variables.product.prodname_copilot_extension_short %} you want to review or modify, click **Configure**.
|
||||
1. In the "Permissions" section, review the permissions listed for the {% data variables.product.prodname_copilot_extension_short %}. Optionally, you can block the {% data variables.product.prodname_copilot_extension_short %}'s access to your organization in one of two ways:
|
||||
- To indefinitely suspend the {% data variables.product.prodname_copilot_extension_short %}'s access to resources in your organization while keeping the extension installed, in the "Danger zone" section, click **Suspend**.
|
||||
- To uninstall a {% data variables.product.prodname_copilot_extension_short %} completely, in the "Danger zone" section, click **Uninstall**.
|
||||
|
||||
## Next steps
|
||||
|
||||
After you have set a {% data variables.product.prodname_copilot_extensions_short %} policy, you can install {% data variables.product.prodname_copilot_extensions_short %} for your organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization)."
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Using GitHub Copilot Extensions
|
||||
intro: 'You can use {% data variables.product.prodname_copilot_extensions %} to interact with external tools in {% data variables.product.prodname_copilot_chat %}.'
|
||||
product: '{% data reusables.gated-features.copilot-extensions %}'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Use Copilot Extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About using {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} **work the same way across all {% data variables.product.prodname_copilot_chat_short %} interfaces where {% data variables.product.prodname_copilot_extensions_short %} are available**. {% data variables.product.prodname_copilot_extensions_short %} are available in:
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.compatible-chat-interfaces %}
|
||||
|
||||
If you have a {% data variables.product.prodname_copilot_individuals_short %} subscription, you need to install a {% data variables.product.prodname_copilot_extension_short %} before you can use the extension in {% data variables.product.prodname_copilot_chat_short %}. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account)."
|
||||
|
||||
If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, an organization owner needs to install {% data variables.product.prodname_copilot_extensions_short %} for your organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization)."
|
||||
|
||||
## Using {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
1. To start using a {% data variables.product.prodname_copilot_extension_short %}, open any of the following {% data variables.product.prodname_copilot_chat_short %} interfaces:
|
||||
- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=vscode#asking-your-first-question)."
|
||||
- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=visualstudio#asking-your-first-question-1)."{% ifversion ghec %}
|
||||
- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %} (if you have a {% data variables.product.prodname_copilot_enterprise_short %} subscription). See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)."{% endif %}
|
||||
1. To see a list of all {% data variables.product.prodname_copilot_extensions_short %} available in your {% data variables.product.prodname_copilot_chat_short %} conversation, in the {% data variables.product.prodname_copilot_chat_short %} text box, type `@`.
|
||||
|
||||
> [!NOTE] If you are using {% data variables.product.prodname_copilot_chat_short %} in an IDE, and you or your organization owner install a {% data variables.product.prodname_copilot_extension_short %} while your IDE is open, you need to restart your IDE to begin using the {% data variables.product.prodname_copilot_extension_short %}.
|
||||
|
||||
1. In the list of available {% data variables.product.prodname_copilot_extensions_short %}, click the one you want to use.
|
||||
1. To begin interacting with the {% data variables.product.prodname_copilot_extension_short %}, in the {% data variables.product.prodname_copilot_chat_short %} text box, ask the extension to answer a question or perform an action, then press <kbd>Enter</kbd>. For each new request, be sure to include `@EXTENSION-NAME` at the beginning of your sentence.
|
||||
- If you did not install the {% data variables.product.prodname_copilot_extension_short %} yourself, and it is your first time using the {% data variables.product.prodname_copilot_extension_short %}, you will be asked to authorize the extension. See "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
|
||||
- If you ask a {% data variables.product.prodname_copilot_extension_short %} to perform an action, you need to confirm the extension has your permission to act on your behalf before it will complete the task. After carefully reviewing the proposed action, in the confirmation dialog, click **Allow** or **Dismiss**.
|
||||
|
||||
## Tips for using {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
- When you are using a {% data variables.product.prodname_copilot_extension_short %}, consider how you would interact with the tool outside of {% data variables.product.prodname_copilot_chat_short %}, then use natural language to ask questions and assign tasks that integrate the capabilities of the tool with {% data variables.product.prodname_dotcom %}. For example, [Sentry](https://sentry.io/welcome/) is an application monitoring software with a {% data variables.product.prodname_copilot_extension_short %}. The following are some example prompts for the Sentry extension for {% data variables.product.prodname_copilot %}:
|
||||
- `@sentry list my most recent issues`
|
||||
- `@sentry tell me more about issue ISSUE-ID-OR-ISSUE-LINK`
|
||||
- `@sentry create a {% data variables.product.prodname_dotcom %} issue for the most recent Sentry issue and assign it to @DEVELOPER`
|
||||
|
||||
For information on the best ways to use a specific {% data variables.product.prodname_copilot_extension_short %}, read the description of the extension on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=apps&copilot_app=true).
|
||||
- Interactions with one {% data variables.product.prodname_copilot_extension_short %} will never be shared with another {% data variables.product.prodname_copilot_extension_short %}. To interact with different {% data variables.product.prodname_copilot_extensions_short %} in an IDE, change the `@EXTENSION-NAME` at the beginning of each sentence. Interactions with different extensions will appear in the same {% data variables.product.prodname_copilot_chat_short %} window, but the conversations themselves are automatically separated.
|
||||
|
||||
{% ifversion ghec %} To interact with different {% data variables.product.prodname_copilot_extensions_short %} on {% data variables.product.prodname_dotcom_the_website %}, you need to start a new conversation for each extension by clicking {% octicon "plus" aria-label="New conversation" %} at the top of the {% data variables.product.prodname_copilot_chat_short %} window.{% endif %}
|
||||
@@ -1,15 +1,14 @@
|
||||
---
|
||||
title: GitHub Copilot Chat
|
||||
shortTitle: Copilot Chat
|
||||
intro: 'Learn about {% data variables.product.prodname_copilot_chat %}, including use cases, best practices, and limitations.'
|
||||
intro: 'Learn about {% data variables.product.prodname_copilot_chat %}, including use cases, tools, best practices, and limitations.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /about-github-copilot-chat-in-github-mobile
|
||||
- /enabling-github-copilot-chat-for-github-mobile
|
||||
- /using-github-copilot-chat-in-github-mobile
|
||||
- /about-github-copilot-chat
|
||||
- /using-github-copilot-chat-in-your-ide
|
||||
- /copilot-chat-in-github
|
||||
- /copilot-chat-in-ides
|
||||
- /copilot-chat-in-github-mobile
|
||||
- /github-copilot-extensions
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user