From 9def1aa71f5c0340967297a94b7742c8d7c7fd8d Mon Sep 17 00:00:00 2001 From: kqlio67 <166700875+kqlio67@users.noreply.github.com> Date: Fri, 24 Jan 2025 02:47:57 +0000 Subject: Update model configurations, provider implementations, and documentation (#2577) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update model configurations, provider implementations, and documentation - Updated model names and aliases for Qwen QVQ 72B and Qwen 2 72B (@TheFirstNoob) - Revised HuggingSpace class configuration, added default_image_model - Added llama-3.2-70b alias for Llama 3.2 70B model in AutonomousAI - Removed BlackboxCreateAgent class - Added gpt-4o alias for Copilot model - Moved api_key to Mhystical class attribute - Added models property with default_model value for Free2GPT - Simplified Jmuz class implementation - Improved image generation and model handling in DeepInfra - Standardized default models and removed aliases in Gemini - Replaced model aliases with direct model list in GlhfChat (@TheFirstNoob) - Removed trailing slash from image generation URL in PollinationsAI (https://github.com/xtekky/gpt4free/issues/2571) - Updated llama and qwen model configurations - Enhanced provider documentation and model details * Removed from (g4f/models.py) 'Yqcloud' provider from Default due to error 'ResponseStatusError: Response 429: 文字过长，请删减后重试。' * Update docs/providers-and-models.md * refactor(g4f/Provider/DDG.py): Add error handling and rate limiting to DDG provider - Add custom exception classes for rate limits, timeouts, and conversation limits - Implement rate limiting with sleep between requests (0.75s minimum delay) - Add model validation method to check supported models - Add proper error handling for API responses with custom exceptions - Improve session cookie handling for conversation persistence - Clean up User-Agent string and remove redundant code - Add proper error propagation through async generator Breaking changes: - New custom exceptions may require updates to error handling code - Rate limiting affects request timing and throughput - Model validation is now stricter Related: - Adds error handling similar to standard API clients - Improves reliability and robustness of chat interactions * Update g4f/models.py g4f/Provider/PollinationsAI.py * Update g4f/models.py * Restored provider which was not working and was disabled (g4f/Provider/DeepInfraChat.py) * Fixing a bug with Streaming Completions * Update g4f/Provider/PollinationsAI.py * Update g4f/Provider/Blackbox.py g4f/Provider/DDG.py * Added another model for generating images 'ImageGeneration2' to the 'Blackbox' provider * Update docs/providers-and-models.md * Update g4f/models.py g4f/Provider/Blackbox.py * Added a new OIVSCode provider from the Text Models and Vision (Image Upload) model * Update docs/providers-and-models.md * docs: add Conversation Memory class with context handling requested by @TheFirstNoob * Simplified README.md documentation added new docs/configuration.md documentation * Update add README.md docs/configuration.md * Update README.md * Update docs/providers-and-models.md g4f/models.py g4f/Provider/PollinationsAI.py * Added new model deepseek-r1 to Blackbox provider. @TheFirstNoob * Fixed bugs and updated docs/providers-and-models.md etc/unittest/client.py g4f/models.py g4f/Provider/. --------- Co-authored-by: kqlio67 <> Co-authored-by: H Lohaus --- docs/configuration.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 docs/configuration.md (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 00000000..72bfb9bd --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,95 @@ + +### G4F - Configuration + + +## Table of Contents +- [Authentication](#authentication) +- [Cookies Configuration](#cookies-configuration) +- [HAR and Cookie Files](#har-and-cookie-files) +- [Debug Mode](#debug-mode) +- [Proxy Configuration](#proxy-configuration) + + +#### Authentication + +Refer to the [G4F Authentication Setup Guide](authentication.md) for detailed instructions on setting up authentication. + +### Cookies Configuration +Cookies are essential for using Meta AI and Microsoft Designer to create images. +Additionally, cookies are required for the Google Gemini and WhiteRabbitNeo Provider. +From Bing, ensure you have the "\_U" cookie, and from Google, all cookies starting with "\_\_Secure-1PSID" are needed. + +**You can pass these cookies directly to the create function or set them using the `set_cookies` method before running G4F:** +```python +from g4f.cookies import set_cookies + +set_cookies(".bing.com", { + "_U": "cookie value" +}) + +set_cookies(".google.com", { + "__Secure-1PSID": "cookie value" +}) +``` +--- +### HAR and Cookie Files +**Using .har and Cookie Files** +You can place `.har` and cookie files `.json` in the default `./har_and_cookies` directory. To export a cookie file, use the [EditThisCookie Extension](https://chromewebstore.google.com/detail/editthiscookie/fngmhnnpilhplaeedifhccceomclgfbg) available on the Chrome Web Store. + +**Creating .har Files to Capture Cookies** +To capture cookies, you can also create `.har` files. For more details, refer to the next section. + +### Changing the Cookies Directory and Loading Cookie Files in Python +**You can change the cookies directory and load cookie files in your Python environment. To set the cookies directory relative to your Python file, use the following code:** +```python +import os.path +from g4f.cookies import set_cookies_dir, read_cookie_files + +import g4f.debug +g4f.debug.logging = True + +cookies_dir = os.path.join(os.path.dirname(__file__), "har_and_cookies") +set_cookies_dir(cookies_dir) +read_cookie_files(cookies_dir) +``` + +### Debug Mode +**If you enable debug mode, you will see logs similar to the following:** + +``` +Read .har file: ./har_and_cookies/you.com.har +Cookies added: 10 from .you.com +Read cookie file: ./har_and_cookies/google.json +Cookies added: 16 from .google.com +``` + +#### .HAR File for OpenaiChat Provider + +##### Generating a .HAR File + +**To utilize the OpenaiChat provider, a .har file is required from https://chatgpt.com/. Follow the steps below to create a valid .har file:** +1. Navigate to https://chatgpt.com/ using your preferred web browser and log in with your credentials. +2. Access the Developer Tools in your browser. This can typically be done by right-clicking the page and selecting "Inspect," or by pressing F12 or Ctrl+Shift+I (Cmd+Option+I on a Mac). +3. With the Developer Tools open, switch to the "Network" tab. +4. Reload the website to capture the loading process within the Network tab. +5. Initiate an action in the chat which can be captured in the .har file. +6. Right-click any of the network activities listed and select "Save all as HAR with content" to export the .har file. + +##### Storing the .HAR File + +- Place the exported .har file in the `./har_and_cookies` directory if you are using Docker. Alternatively, if you are using Python from a terminal, you can store it in a `./har_and_cookies` directory within your current working directory. + +> **Note:** Ensure that your .har file is stored securely, as it may contain sensitive information. + +### Proxy Configuration +**If you want to hide or change your IP address for the providers, you can set a proxy globally via an environment variable:** + +**- On macOS and Linux:** +```bash +export G4F_PROXY="http://host:port" +``` + +**- On Windows:** +```bash +set G4F_PROXY=http://host:port +``` -- cgit v1.2.3