Skip to content

Commit feafeee

Browse files
docs: add quota note for OpenAIChatGenerator in get-started guide (#10207)
* docs: add quota note for OpenAIChatGenerator in get-started guide * Apply suggestion from @davidsbatista * Apply suggestions from code review --------- Co-authored-by: David S. Batista <[email protected]>
1 parent 5441f68 commit feafeee

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs-website/docs/overview/get-started.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,15 @@ If you have any questions, please reach out to us on the [GitHub Discussion](htt
4141

4242
In the example below, we show how to set an API key using a Haystack [Secret](../concepts/secret-management.mdx). However, for easier use, you can also set an OpenAI key as an `OPENAI_API_KEY` environment variable.
4343

44+
:::note
45+
**Using OpenAIChatGenerator requires an OpenAI API key with sufficient quota.**
46+
New users on the free tier may immediately encounter a `429` ("insufficient_quota") error when running
47+
the example below.
48+
49+
If you do not have enough OpenAI credits, you may skip this example or use an alternative Generator such as
50+
`HuggingFaceAPIChatGenerator`.
51+
:::
52+
4453
```python
4554
# import necessary dependencies
4655
from haystack import Pipeline, Document

0 commit comments

Comments
 (0)