зеркало из https://github.com/github/docs.git
Updating Extensibility docs for more clarity (#52371)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
This commit is contained in:
Dimitrios Philliou
GitHub
Родитель
3cc4fe19db
Коммит
f9fdbe499a
|
|
@ -38,7 +38,7 @@ All listings should meet the following requirements, regardless of whether they
|
|||
* Listings must have a relevant description of the application.
|
||||
* Listings must specify a pricing plan.
|
||||
* Apps must provide value to customers and integrate with the platform in some way beyond authentication.
|
||||
* Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in beta or available by invite only.
|
||||
* Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in beta or available by invite only, with the exception of {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
* Apps must have webhook events set up to notify the publisher of any plan changes or cancellations using the {% data variables.product.prodname_marketplace %} API. For more information, see "[AUTOTITLE](/apps/github-marketplace/using-the-github-marketplace-api-in-your-app)."
|
||||
|
||||
For more information on providing a good customer experience, see "[AUTOTITLE](/apps/github-marketplace/creating-apps-for-github-marketplace/customer-experience-best-practices-for-apps)."
|
||||
|
|
@ -55,9 +55,24 @@ To protect your customers, we recommend that you also follow security best pract
|
|||
|
||||
{% data reusables.marketplace.free-apps-encouraged %}
|
||||
|
||||
## Requirements for {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} are essentially {% data variables.product.prodname_github_apps %} with additional read access to {% data variables.product.prodname_copilot_chat_short %}, integration with the {% data variables.product.prodname_copilot_short %} API, and optional integration into other LLMs.
|
||||
|
||||
To publish an extension, it must be owned by an organization account with Verified Creator status. For more information about the verification process or transferring ownership of your app, see "[AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization)."
|
||||
|
||||
The requirements to publish a {% data variables.product.prodname_copilot_extension_short %} are the same as the requirements for free apps, with the following exceptions:
|
||||
* Your extension must provide a clear and descriptive response to a prompt like "What can you do?" or "List your capabilities".
|
||||
* Your extension can be in beta as long as that is clearly communicated in the listing description. If you are using a waitlist, you must also include a link to sign up at the top of the description. Someone from the {% data variables.product.github %} review team will join the waitlist and email your technical lead requesting access for testing.
|
||||
* You must include links to two videos that demonstrate the following:
|
||||
* A few example prompts and responses from your extension
|
||||
* A net new user installing, authenticating, and sending their first prompt to your extension. These videos are private to {% data variables.product.github %} and are used solely for reviewing your listing submission. It's okay if the videos are brief and unedited.
|
||||
* Your extension must provide a stable and reliable user experience, and be able to perform the capabilities listed in the description.
|
||||
* A pathway must be provided for new users to install, setup and authorize your extension with minimal friction. If the {% data variables.product.github %} review team is not able to successfully onboard to your extension for testing, it will not be approved for publishing.
|
||||
|
||||
## Requirements for paid apps
|
||||
|
||||
To publish a paid plan for your app on {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transferring ownership of your app, see "[AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization)."
|
||||
To publish a paid plan for your app on the {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transferring ownership of your app, see "[AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization)."
|
||||
|
||||
If your app is already published and you're a verified publisher, then you can publish a new paid plan from the pricing plan editor. For more information, see "[AUTOTITLE](/apps/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing)."
|
||||
|
||||
|
|
@ -79,7 +94,7 @@ When you are ready to publish the app on {% data variables.product.prodname_mark
|
|||
|
||||
Your app does not need to handle payments but does need to use {% data variables.product.prodname_marketplace %} purchase events to manage new purchases, upgrades, downgrades, cancellations, and free trials. For information about how integrate these events into your app, see "[AUTOTITLE](/apps/github-marketplace/using-the-github-marketplace-api-in-your-app)."
|
||||
|
||||
Using GitHub's billing API allows customers to purchase an app without leaving GitHub and to pay for the service with the payment method already attached to their account on {% data variables.product.github %}.
|
||||
Using {% data variables.product.github %}'s billing API allows customers to purchase an app without leaving {% data variables.product.github %} and to pay for the service with the payment method already attached to their account on {% data variables.product.github %}.
|
||||
|
||||
* Apps must support both monthly and annual billing for paid subscriptions purchases.
|
||||
* Listings may offer any combination of free and paid plans. Free plans are optional but encouraged. For more information, see "[AUTOTITLE](/apps/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing)."
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ type: overview
|
|||
|
||||
## About {% data variables.product.prodname_copilot_extensions_short %}
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} are integrations that expand the functionality of {% data variables.product.prodname_copilot_chat_short %}. {% data variables.product.prodname_copilot_extensions_short %} allow developers to integrate external tools, services, and custom behaviours into the {% data variables.product.prodname_copilot_chat_short %} experience across all supported IDEs and {% data variables.product.company_short %}.
|
||||
{% data variables.product.prodname_copilot_extensions_short %} are integrations that expand the functionality of {% data variables.product.prodname_copilot_chat_short %}. {% data variables.product.prodname_copilot_extensions_short %} allow developers to integrate external tools, services, and custom behaviors into the {% data variables.product.prodname_copilot_chat_short %} experience across all supported IDEs and {% data variables.product.company_short %}.
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} are built as {% data variables.product.prodname_github_apps %} with additional capabilities, including:
|
||||
* Read-access to your {% data variables.product.prodname_copilot_chat_short %} history
|
||||
|
|
@ -57,22 +57,24 @@ You can use {% data variables.product.prodname_copilot_extensions_short %} to ex
|
|||
Before creating your own {% data variables.product.prodname_copilot_extension_short %} from scratch, you may want to explore an existing {% data variables.product.prodname_copilot_agent_short %}, and integrate it with a {% data variables.product.prodname_github_app %} to see how it works. {% data variables.product.company_short %} provides a few example {% data variables.product.prodname_copilot_agents_short %}, that you can clone and use as the basis for your own {% data variables.product.prodname_copilot_extension_short %}, including:
|
||||
|
||||
* **Blackbeard**: A simple {% data variables.product.prodname_copilot_agent_short %} that responds to requests like a pirate, using {% data variables.product.prodname_copilot_short %}'s LLM API and special system prompts. It is a good starting point for learning how to build a {% data variables.product.prodname_copilot_extension_short %}. For more information, see the [Blackbeard {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/blackbeard-extension).
|
||||
* **{% data variables.product.prodname_github_models %}**: A more complex {% data variables.product.prodname_copilot_agent_short %} that let's you ask about and interact with various LLMs listed on the {% data variables.product.prodname_marketplace %} from within {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [{% data variables.product.prodname_github_models %} {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/github-models-extension).
|
||||
* **{% data variables.product.prodname_github_models %}**: A more complex {% data variables.product.prodname_copilot_agent_short %} that lets you ask about and interact with various LLMs listed on the {% data variables.product.prodname_marketplace %} from within {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [{% data variables.product.prodname_github_models %} {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/github-models-extension).
|
||||
|
||||
> [!NOTE] {% data variables.product.prodname_github_models %} are in public beta and subject to change. To request access, join the [waitlist](https://github.com/marketplace/models/waitlist).
|
||||
* **Function calling**: an example agent written in Go that demonstrates function calling and confirmation dialogues. For more information, see the [Function calling extension](https://github.com/copilot-extensions/function-calling-extension).
|
||||
* **RAG extension**: an example agent written in Go that demonstrates a simple implementation of retrieval augmented generation. For more information, see the [RAG extension](https://github.com/copilot-extensions/rag-extension).
|
||||
* **Preview SDK**: An SDK that simplifies the process of building {% data variables.product.prodname_copilot_extensions_short %} by handling request verification, response formatting, and API interactions. It allows builders to focus on their extension's core functionality rather than boilerplate, by streamlining the integration of tools, APIs, and data sources into {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [Preview SDK](https://github.com/copilot-extensions/preview-sdk.js).
|
||||
|
||||
## About {% data variables.product.prodname_vscode %} Chat extensions
|
||||
## About {% data variables.product.prodname_copilot_extensions_vsc %}
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions %} are generally built as {% data variables.product.prodname_github_apps %}. However, there is also an option to build a {% data variables.product.prodname_vscode %} Chat extension that integrates with {% data variables.product.prodname_copilot_chat_short %} and provides a similar end user experience. {% data variables.product.prodname_vscode %} Chat extensions are a good option for developers looking to customize their copilot experience with functionalities specific to {% data variables.product.prodname_vscode %}.
|
||||
Alternatively, you can build a {% data variables.product.prodname_copilot_extension_short %} that is exclusive and native to {% data variables.product.prodname_vscode %}. These extensions are called {% data variables.product.prodname_copilot_extensions_vsc %}, or {% data variables.product.prodname_vscode %} Chat extensions. {% data variables.product.prodname_vscode_shortname %} Chat extensions can only be used in {% data variables.product.prodname_copilot_chat_short %} for {% data variables.product.prodname_vscode_shortname %}, and are a good option for developers who want to build extensions that use specific {% data variables.product.prodname_vscode %} functionality.
|
||||
|
||||
There are some key differences from {% data variables.product.prodname_github_app %} {% data variables.product.prodname_copilot_extensions_short %}:
|
||||
* {% data variables.product.prodname_vscode %} Specific: Unlike {% data variables.product.prodname_github_app %} {% data variables.product.prodname_copilot_extensions_short %}, which work across all supported IDEs and {% data variables.product.company_short %}, {% data variables.product.prodname_vscode %} Chat extensions only work within the {% data variables.product.prodname_vscode %} environment.
|
||||
* Capabilities: They have more access to {% data variables.product.prodname_vscode %}'s features and APIs, allowing for more editor-specific interactions, such as accessing local workspace data and manipulating {% data variables.product.prodname_vscode %}'s interface.
|
||||
* Publishing: They can be published to the {% data variables.product.prodname_vscode %} Marketplace. They cannot be published on the {% data variables.product.prodname_marketplace %}.
|
||||
There are some key differences from {% data variables.product.prodname_copilot_extensions %}:
|
||||
* {% data variables.product.prodname_vscode %} Chat extensions only work within the {% data variables.product.prodname_vscode %} environment.
|
||||
* {% data variables.product.prodname_copilot_extensions_vsc %} have more access to {% data variables.product.prodname_vscode %}'s features and APIs, allowing for more editor-specific interactions like accessing local workspace data, manipulating {% data variables.product.prodname_vscode %}'s interface, and read/write access to local files.
|
||||
* {% data variables.product.prodname_copilot_extensions_vsc %} are published to the {% data variables.product.prodname_vscode %} Marketplace, not the {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
For more information, see [{% data variables.product.prodname_vscode %} Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the Visual Studio Code documentation.
|
||||
For more information, see [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
|
||||
## Further reading
|
||||
|
||||
* For a glossary of terms used in the context of {% data variables.product.prodname_copilot_extensions_short %}, see [Copilot Extensions Glossary](/copilot/building-copilot-extensions/copilot-extensions-glossary)
|
||||
* "[AUTOTITLE](/copilot/building-copilot-extensions/copilot-extensions-glossary)"
|
||||
|
|
|
|||
|
|
@ -89,8 +89,6 @@ data: [{
|
|||
|
||||
### `copilot_references`
|
||||
|
||||
> [!NOTE] The `copilot_references` SSE is not yet available when using {% data variables.product.prodname_copilot_chat_dotcom_short %}.
|
||||
|
||||
The `copilot_references` SSE sends the user a list of references used to generate a response. This SSE is sent through an event type and data field. See the following code for an example of a `copilot_references` SSE:
|
||||
|
||||
```typescript annotate
|
||||
|
|
|
|||
|
|
@ -29,13 +29,17 @@ A {% data variables.product.prodname_github_app %} with additional access to the
|
|||
|
||||
The system that handles authentication and proxies requests between clients and agent plugins.
|
||||
|
||||
#### {% data variables.product.prodname_copilot_extension_vsc %}
|
||||
|
||||
Also known as {% data variables.product.prodname_vscode %} Chat extensions, {% data variables.product.prodname_copilot_extensions_vsc %} are built as a {% data variables.product.prodname_vscode %} extension rather than a {% data variables.product.prodname_github_app %}. These extensions are exclusive to {% data variables.product.prodname_vscode_shortname %} and can be downloaded from the {% data variables.product.prodname_vscode_shortname %} Marketplace.
|
||||
|
||||
#### {% data variables.product.prodname_github_app %}
|
||||
|
||||
The foundation for a {% data variables.product.prodname_copilot_extension_short %} that provides the necessary infrastructure, permissions, and context from {% data variables.product.company_short %}, such as user, repo and organization metadata.
|
||||
|
||||
##### {% data variables.product.prodname_marketplace %}
|
||||
|
||||
The platform where {% data variables.product.company_short %} approved {% data variables.product.prodname_copilot_extensions_short %} can be listed publicly and discovered by users.
|
||||
The platform where {% data variables.product.company_short %} approved {% data variables.product.prodname_copilot_extensions %} can be listed publicly and discovered by users.
|
||||
|
||||
#### Listed/Published Extension
|
||||
|
||||
|
|
@ -64,7 +68,3 @@ An extension that is not published on the {% data variables.product.prodname_mar
|
|||
#### Verified Creator
|
||||
|
||||
A status required for organizations to publish extensions on the {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
#### {% data variables.product.prodname_vscode %} Chat Extensions
|
||||
|
||||
{% data variables.product.prodname_vscode %} Chat Extensions extend {% data variables.product.prodname_copilot_chat_short %} functionality for a similar end-user experience, but they’re built as a {% data variables.product.prodname_vscode %} Extension rather than a {% data variables.product.prodname_github_app %}.
|
||||
|
|
|
|||
|
|
@ -16,12 +16,7 @@ When you build a {% data variables.product.prodname_copilot_extension_short %},
|
|||
* **Public**: Any user or organization account with the link to your app's installation page can install it. Making your app public automatically creates a public installation page, but does not list the app on the {% data variables.product.prodname_marketplace %}.
|
||||
* **Private**: Only the user or organization account that created the app can install it.
|
||||
|
||||
If you make your app public, you can choose to publish it on the {% data variables.product.prodname_marketplace %}. To list your {% data variables.product.prodname_copilot_extension_short %} on the {% data variables.product.prodname_marketplace %}, you must meet the following requirements:
|
||||
|
||||
* You must publish your app from an organization that is a verified publisher on the {% data variables.product.prodname_marketplace %}.
|
||||
* If your organization is not yet verified, see "[AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization)."
|
||||
* If you need to transfer ownership of your app from your personal account to your organization account, see "[AUTOTITLE](/apps/maintaining-github-apps/transferring-ownership-of-a-github-app)."
|
||||
* Your app must meet the requirements for all listings on the {% data variables.product.prodname_marketplace %}. See "[AUTOTITLE](/apps/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app#requirements-for-all-github-marketplace-listings)."
|
||||
If you make your app public, you can choose to publish it on the {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
## Changing the visibility of your {% data variables.product.prodname_copilot_extension_short %}
|
||||
|
||||
|
|
@ -36,21 +31,35 @@ If you make your app public, you can choose to publish it on the {% data variabl
|
|||
|
||||
## Listing your {% data variables.product.prodname_copilot_extension_short %} on the {% data variables.product.prodname_marketplace %}
|
||||
|
||||
Once your public app is owned by a verified publisher, you can apply to list it on the {% data variables.product.prodname_marketplace %}.
|
||||
To list your {% data variables.product.prodname_copilot_extension_short %} on the {% data variables.product.prodname_marketplace %}, you must meet the following requirements:
|
||||
|
||||
* You must publish your app from an organization that is a verified publisher on the {% data variables.product.prodname_marketplace %}.
|
||||
* If your organization is not yet verified, see "[AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization)."
|
||||
* If you need to transfer ownership of your app from your personal account to your organization account, see "[AUTOTITLE](/apps/maintaining-github-apps/transferring-ownership-of-a-github-app)."
|
||||
* Your app must meet the requirements for all {% data variables.product.prodname_copilot_extension_short %} listings on the {% data variables.product.prodname_marketplace %}. See "[AUTOTITLE](/apps/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app#requirements-for-github-copilot-extensions)."
|
||||
|
||||
App managers cannot create, edit, or publish extensions on the {% data variables.product.prodname_marketplace %}. To manage a listing, you should be an organization owner for the publishing organization.
|
||||
|
||||
> [!NOTE] Paid plans are not supported for {% data variables.product.prodname_copilot_extensions_short %} during public beta. Any requests to publish with a paid plan attached will not be approved.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.org-list %}
|
||||
1. At the bottom of the sidebar, select {% octicon "code" aria-hidden="true" %} **Developer settings**, then click **{% data variables.product.prodname_github_apps %}**.
|
||||
1. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}.
|
||||
1. Select the app you'd like to publish to the {% data variables.product.prodname_marketplace %}.
|
||||
1. On the app settings landing page, scroll down to the Marketplace section, then click **List in Marketplace**. The Marketplace section is only visible if your app is public.
|
||||
1. Once you've created a new draft listing, you'll see an overview of the sections that you'll need to visit before your {% data variables.product.prodname_marketplace %} listing will be complete. Complete the required sections.
|
||||
1. When naming your listing for your {% data variables.product.prodname_copilot_extension_short %}, use any of the following naming conventions:
|
||||
* `YOUR-PRODUCT-NAME` (example: "{% data variables.product.prodname_copilot_short %}")
|
||||
* `YOUR-COMPANY-NAME` (example: "{% data variables.product.github %}")
|
||||
* `YOUR-COMPANY-AND-PRODUCT-NAMES` (example: "{% data variables.product.prodname_copilot %}")
|
||||
* `YOUR-COMPANY-OR-PRODUCT-NAME for {% data variables.product.prodname_copilot %}` (example: "Docker for {% data variables.product.prodname_copilot %}")
|
||||
1. When choosing the slug users will type to invoke your {% data variables.product.prodname_copilot_extension_short %}, use the name of your listing, substituting dashes for spaces. If that slug is taken, try appending `-app`.
|
||||
1. In the sidebar, click **Overview**, then read and accept the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
1. To submit your listing, click **Submit for review**. After you submit your app for review, an onboarding expert will contact you with additional information about the onboarding process.
|
||||
1. In the "Listing name" text box, type a name for your listing. This name is displayed on the {% data variables.product.prodname_marketplace %} page and in search results, and can be changed later. {% data variables.product.github %} recommends using any of the following naming conventions:
|
||||
* `YOUR-PRODUCT-NAME` (example: "{% data variables.product.prodname_copilot_short %}"): We recommend this convention if your extension stays within the scope of a single product and there are no other well-known products with the same name.
|
||||
* `YOUR-COMPANY-NAME` (example "{% data variables.product.github %}"): We recommend this convention if your extension spans multiple products.
|
||||
* `YOUR-COMPANY-PRODUCT-NAME` (example: "{% data variables.product.prodname_copilot %}"): We recommend this convention if your extension stays within the scope of one product, but there are other well-known products with the same name.
|
||||
|
||||
> [!NOTE] {% data variables.product.github %} reviews all {% data variables.product.prodname_copilot_extension_short %} submissions to ensure they meet our standards for quality, performance, reliability, and security. We may deny submissions at our discretion, but we will provide reasons for any rejections. You are welcome to address any issues and resubmit your extension for review.
|
||||
> [!NOTE] The listing name is not the same as your {% data variables.product.prodname_github_app %}'s name or your {% data variables.product.prodname_copilot_extension_short %}'s slug. Changing the listing name will not affect the app name or slug.
|
||||
|
||||
1. In the "Primary category" section, select the dropdown menu, then click a category. You can change your selection or add a secondary category later.
|
||||
1. To create a draft listing for your {% data variables.product.prodname_copilot_extension_short %}, click **Save and add more details**.
|
||||
1. After you create a new draft listing, you'll see a view where you can manage your listing. Before you can submit your listing for review, you need to:
|
||||
* Fill out each of the required sections
|
||||
* Verify the organization account that owns the {% data variables.product.prodname_github_app %}
|
||||
* Accept the {% data variables.product.prodname_marketplace %} Developer Agreement
|
||||
1. To submit your listing, click **Submit for review**. After your listing is reviewed, an onboarding expert will let you know if your submission was approved or denied.
|
||||
|
||||
> [!NOTE] {% data variables.product.github %} reviews all submissions to ensure they meet our standards for quality, performance, reliability, and security. {% data variables.product.github %} may deny submissions at its own discretion, and will provide reasons for denials. You are welcome to address any issues and resubmit your extension for review. You may also go through the [GitHub Appeal and Reinstatement Process](/free-pro-team@latest/site-policy/acceptable-use-policies/github-appeal-and-reinstatement).
|
||||
|
|
|
|||
|
|
@ -431,6 +431,10 @@ You can ask {% data variables.product.prodname_copilot_short %} a question about
|
|||
|
||||
{% data reusables.copilot.stop-response-generation %}
|
||||
|
||||
## Extending {% data variables.product.prodname_copilot_chat_dotcom_short %}
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.extending-copilot-chat %}
|
||||
|
||||
## Sharing feedback about {% data variables.product.prodname_copilot_chat_dotcom %}
|
||||
|
||||
{% data reusables.rai.copilot-dotcom-feedback-collection %}
|
||||
|
|
|
|||
|
|
@ -205,6 +205,10 @@ You can ask {% data variables.product.prodname_copilot_chat_short %} to give cod
|
|||
|
||||
You can use special keywords to help {% data variables.product.prodname_copilot_short %} understand your prompt.
|
||||
|
||||
### Extending {% data variables.product.prodname_copilot_chat_short %}
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.extending-copilot-chat %}
|
||||
|
||||
### 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:
|
||||
|
|
|
|||
|
|
@ -34,17 +34,7 @@ You can interact with your custom-built or installed extension in a {% data vari
|
|||
* 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 %}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
**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**:
|
||||
1. An organization owner or enterprise owner needs to enable the {% data variables.product.prodname_copilot_extensions_short %} policy for your organization or enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#setting-a-policy-for-github-copilot-extensions-in-your-organization)" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
1. 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)."
|
||||
{% data variables.product.prodname_copilot_extensions_short %} are included in all {% data variables.product.prodname_copilot_short %} subscriptions.
|
||||
|
||||
### Supported clients and IDEs
|
||||
|
||||
|
|
@ -54,11 +44,19 @@ You can interact with your custom-built or installed extension in a {% data vari
|
|||
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} |
|
||||
| {% data variables.product.prodname_dotcom_the_website %} | {% octicon "check" aria-label="Supported" %} |
|
||||
| {% data variables.product.prodname_mobile %} | {% octicon "x" aria-label="Unsupported" %} |
|
||||
| JetBrains | {% octicon "x" aria-label="Unsupported" %} |
|
||||
| JetBrains IDEs | {% octicon "x" aria-label="Unsupported" %} |
|
||||
| Vim/Neovim | {% octicon "x" aria-label="Unsupported" %} |
|
||||
| CLI | {% octicon "x" aria-label="Unsupported" %} |
|
||||
| Xcode | {% octicon "x" aria-label="Unsupported" %} |
|
||||
|
||||
## Prerequisites
|
||||
|
||||
**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**:
|
||||
1. An organization owner or enterprise owner needs to enable the {% data variables.product.prodname_copilot_extensions_short %} policy for your organization or enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#setting-a-policy-for-github-copilot-extensions-in-your-organization)" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
1. 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:
|
||||
|
|
@ -91,10 +89,13 @@ You can interact with your custom-built or installed extension in a {% data vari
|
|||
For questions and issues related to {% data variables.product.prodname_copilot_extensions %}, please use the following resources:
|
||||
|
||||
* **General issues for users and builders**: Visit the [{% data variables.product.github %} Support Portal](https://support.github.com/).
|
||||
* **Feature requests or feedback**: Use the [{% data variables.product.github %} Community Discussion Thread](https://gh.io/community-feedback).
|
||||
* **Requests or feedback for {% data variables.product.github %}**: Use the [{% data variables.product.github %} Community Discussion Thread](https://gh.io/community-feedback).
|
||||
* **Requests or feedback for third-party extension publishers**: File an issue in the [User Feedback Repo](https://github.com/copilot-extensions/user-feedback) and add a label with the extension's slug name.
|
||||
* **{% data variables.product.github %} Technology Partners**: Email the partnerships team directly for assistance.
|
||||
* **{% data variables.product.prodname_vscode_shortname %} Chat Extensions builders and users**: See [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
* **{% data variables.product.prodname_copilot_extensions_vsc %}**: For more information on this type of {% data variables.product.prodname_copilot_extension_short %}, see [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
|
||||
> [!NOTE] {% data variables.product.github %} Support cannot answer questions regarding {% data variables.product.prodname_vscode_shortname %} Chat Extensibility, as this platform is owned and maintained by the {% data variables.product.prodname_vscode_shortname %} product team.
|
||||
> [!NOTE] {% data variables.product.github %} Support is not able to answer questions regarding {% data variables.product.prodname_copilot_extensions_vsc %}, as this implementation path is owned and maintained by the {% data variables.product.prodname_vscode_shortname %} team.
|
||||
|
||||
To learn more about building {% data variables.product.prodname_copilot_extensions_short %}, see "[AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions)."
|
||||
## Further reading
|
||||
|
||||
* "[AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions)"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions %} integrate the power of external tools into {% data variables.product.prodname_copilot_chat_short %}, helping you reduce context switching and receive responses with domain-specific context. You can install {% data variables.product.prodname_copilot_extensions %} from the {% data variables.product.prodname_marketplace %}, then type `@` in a chat window to see a list of your available extensions. To use an extension, select the extension from the list or type the full slug name, then type your prompt.
|
||||
|
||||
To learn more, see "[AUTOTITLE](/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat)."
|
||||
|
|
@ -279,6 +279,8 @@ prodname_copilot_extensions: 'GitHub Copilot Extensions'
|
|||
prodname_copilot_extension: 'GitHub Copilot Extension'
|
||||
prodname_copilot_extensions_short: 'Copilot Extensions'
|
||||
prodname_copilot_extension_short: 'Copilot Extension'
|
||||
prodname_copilot_extensions_vsc: 'Copilot-enabled Visual Studio Code extensions'
|
||||
prodname_copilot_extension_vsc: 'Copilot-enabled Visual Studio Code extension'
|
||||
prodname_copilot_agent: 'GitHub Copilot agent'
|
||||
prodname_copilot_agent_short: 'Copilot agent'
|
||||
prodname_copilot_agents: 'GitHub Copilot agents'
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче