Merge pull request #17 from mharrisb1:release/0.2.x

chore(docs): add note about project scope
mharrisb1 · Apr 25, 2024 · c927bb9 · c927bb9
2 parents 498b169 + 5a8a22d
commit c927bb9
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,9 @@
 
 Pytest plugin for automatically mocking OpenAI requests. Simply decorate any test function that contains code that calls an OpenAI endpoint (either using the SDK or HTTPX).
 
+> [!IMPORTANT]
+> This project does not try to generate fake responses from the models. Any part of a response that would be generated by a model will need to be defined by the user or will fallback to a default value.
+
 ```python
 import openai_responses
 from openai import OpenAI