Skip to content

Commit 7f187d6

Browse files
nhu-doCopilotsubatoi
authored
Improving rate limit documentation (#60747)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent 7ade404 commit 7f187d6

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

content/copilot/concepts/rate-limits.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,18 @@ When you hit a rate limit, you may temporarily lose access to certain {% data va
2626
* **Fairness:** Rate limits ensure that all users have equitable access to {% data variables.product.prodname_copilot_short %}.
2727
* **Abuse mitigation:** Without rate limits, malicious actors could exploit {% data variables.product.prodname_copilot_short %}, leading to degraded service for everyone or even denial of service.
2828

29+
## Types of rate limits
30+
* **Limits for overall service reliability:** Temporary protections that {% data variables.product.github %} applies to keep {% data variables.product.prodname_copilot %} reliable and fair for everyone. You may see these represented as **global** or **weekly** rate limits.
31+
* **Limits for specific models or model family capacity:** Plan-based limits that reflect the {% data variables.product.prodname_copilot %} usage you've consumed for a particular model or model family.
32+
2933
## What to do if you are rate limited
3034

3135
If you receive a rate limit error when using {% data variables.product.prodname_copilot_short %}, you should:
3236

3337
* **Wait and try again.** Rate limits are temporary. Often, waiting a short period and trying again resolves the issue.
3438
* **Check your usage.** If you’re making frequent or automated requests (for example, rapid-fire completions or large-scale usage), consider adjusting your usage pattern.
35-
* **Change your model.** Preview models may have stricter rate limits due to limited capacity.
39+
* **Change your model.** Select models may have stricter rate limits due to limited capacity.
40+
* **Upgrade your plan.** If you are on an individual {% data variables.product.prodname_copilot_short %} plan, upgrading your plan will allow for additional usage.
3641
* **Contact Support.** If you’re repeatedly rate limited and believe it’s impacting legitimate use, contact {% data variables.contact.contact_support_page %} for assistance.
3742

38-
>[!NOTE] Service-level rate limits should not affect typical {% data variables.product.prodname_copilot_short %} usage. However, if you’re heavily using preview models, you may encounter rate limits more frequently.
43+
>[!NOTE] Service-level rate limits should not affect typical {% data variables.product.prodname_copilot_short %} usage. However, if you’re heavily using select models, you may encounter rate limits more frequently.

content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,17 @@ If you cannot connect to the server, you can create a discussion in our [discuss
6363

6464
This is a known issue and our team is working towards a fix. For more information, see this comment on a [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/40522#discussioncomment-4701470).
6565

66-
## Error: "Sorry, your request was rate-limited."
66+
## Error: You've hit a rate limit
6767

6868
This error suggests that you have exceeded the rate limit for {% data variables.product.prodname_copilot_short %} requests. {% data variables.product.github %} uses rate limits to ensure everyone has fair access to the {% data variables.product.prodname_copilot_short %} service and to protect against abuse.
6969

70-
Most people see rate limiting for preview models, due to limited capacity.
70+
Most people see rate limiting for select models, due to limited capacity.
7171

7272
Service-level request rate limits ensure high service quality for all {% data variables.product.prodname_copilot_short %} users and should not affect typical or even deeply engaged {% data variables.product.prodname_copilot_short %} usage. We are aware of some use cases that are affected by it. {% data variables.product.github %} is iterating on {% data variables.product.prodname_copilot_short %}’s rate-limiting heuristics to ensure it doesn’t block legitimate use cases.
7373

74-
In case you experience repeated rate-limiting in {% data variables.product.prodname_copilot_short %}, contact {% data variables.contact.contact_support_page %}.
74+
In the case you are rate limited, the error message will contain the suggested time to retry for a successful request. Consider [alternative actions](/copilot/concepts/rate-limits#what-to-do-if-you-are-rate-limited) to continue using {% data variables.product.prodname_copilot_short %} while your limit is reset.
75+
76+
In case you experience repeated rate limiting in {% data variables.product.prodname_copilot_short %} contact {% data variables.contact.contact_support_page %}.
7577

7678
## Can't find {% data variables.copilot.copilot_chat_short %} in my IDE
7779

0 commit comments

Comments
 (0)