-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Feature: Add feature: Support Cloudflare API model
- Loading branch information
Showing
6 changed files
with
139 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ | |
| <a href="https://t.me/uni_api"> | ||
| <img src="https://img.shields.io/badge/Join Telegram Group-blue?&logo=telegram"> | ||
| </a> | ||
| <a href="https://hub.docker.com/repository/docker/yym68686/uni-api"> | ||
| <a href="https://hub.docker.com/repository/docker/yym68686/uni-api"> | ||
| <img src="https://img.shields.io/docker/pulls/yym68686/uni-api?color=blue" alt="docker pull"> | ||
| </a> | ||
| </p> | ||
|
|
@@ -13,60 +13,60 @@ | |
|
|
||
| ## Introduction | ||
|
|
||
| If used personally, one/new-api is too complex and has many commercial features that individuals do not need. If you don't want a complicated frontend interface and want to support more models, you can try uni-api. This is a project that manages large model APIs uniformly. It allows you to call multiple backend services through a unified API interface, converting them uniformly to OpenAI format and supporting load balancing. The currently supported backend services include: OpenAI, Anthropic, Gemini, Vertex, DeepBricks, OpenRouter, etc. | ||
| If used personally, one/new-api is overly complex, with many commercial features that individuals do not need. If you do not want a complex front-end interface and want to support more models, you can try uni-api. This is a project for unified management of large model APIs, allowing you to call multiple backend services through a unified API interface, uniformly converting them to OpenAI format and supporting load balancing. The currently supported backend services include: OpenAI, Anthropic, Gemini, Vertex, Cloudflare, DeepBricks, OpenRouter, etc. | ||
|
|
||
| ## Features | ||
|
|
||
| - No front-end, purely configuration file to set up API channels. You can run your own API site just by writing a file. The documentation has detailed configuration guidelines, friendly for beginners. | ||
| - Unified management of multiple backend services, supporting OpenAI, Deepseek, DeepBricks, OpenRouter, and other API providers in the OpenAI format. Supports OpenAI Dalle-3 image generation. | ||
| - Supports Anthropic, Gemini, Vertex API simultaneously. Vertex supports both Claude and Gemini API. | ||
| - Support native tool use function calls for OpenAI, Anthropic, Gemini, Vertex. | ||
| - No front-end, pure configuration file setup for API channels. You can run your own API site just by writing a single file, and the documentation includes a detailed configuration guide, beginner-friendly. | ||
| - Unified management of multiple backend services, supporting providers such as OpenAI, Deepseek, DeepBricks, OpenRouter, and other APIs in OpenAI format. Supports OpenAI Dalle-3 image generation. | ||
| - Supports Anthropic, Gemini, Vertex API, and Cloudflare simultaneously. Vertex supports both Claude and Gemini API. | ||
| - Support for OpenAI, Anthropic, Gemini, Vertex native tool use function calls. | ||
| - Supports OpenAI, Anthropic, Gemini, Vertex native image recognition API. | ||
| - Supports four types of load balancing. | ||
| 1. Supports channel-level weighted load balancing, which can allocate requests based on different channel weights. By default, it is not enabled and requires channel weight configuration. | ||
| 2. Supports Vertex region-level load balancing, supports Vertex high concurrency, and can increase Gemini and Claude concurrency by up to (number of APIs * number of regions) times. Automatically enabled without additional configuration. | ||
| 1. Supports channel-level weighted load balancing, which can allocate requests based on different channel weights. Disabled by default, channel weights need to be configured. | ||
| 2. Supports Vertex regional load balancing, supports Vertex high concurrency, and can increase Gemini and Claude concurrency up to (API quantity * regional quantity) times. Automatically enabled without additional configuration. | ||
| 3. Except for Vertex region-level load balancing, all APIs support channel-level sequential load balancing, enhancing the immersive translation experience. Automatically enabled without additional configuration. | ||
| 4. Support automatic API key-level polling load balancing for multiple API Keys in a single channel. | ||
| - Supports automatic retry. When an API channel response fails, automatically retry the next API channel. | ||
| - Supports fine-grained access control. Supports using wildcards to set specific models available for API key channels. | ||
| - Supports rate limiting, can set the maximum number of requests per minute, can be set as an integer, such as 2/min, 2 times per minute, 5/hour, 5 times per hour, 10/day, 10 times per day, 10/month, 10 times per month, 10/year, 10 times per year. Default is 60/min. | ||
| 4. Support automatic API key-level round-robin load balancing for multiple API keys in a single channel. | ||
| - Supports automatic retry, when an API channel response fails, automatically retry the next API channel. | ||
| - Supports fine-grained permission control. Supports using wildcards to set specific models available for API key channels. | ||
| - Supports rate limiting, allowing you to set the maximum number of requests per minute. It can be set as an integer, such as 2/min (2 times per minute), 5/hour (5 times per hour), 10/day (10 times per day), 10/month (10 times per month), 10/year (10 times per year). The default is 60/min. | ||
|
|
||
| ## Configuration | ||
|
|
||
| Using the api.yaml configuration file, you can configure multiple models, and each model can configure multiple backend services, supporting load balancing. Below is an example of the api.yaml configuration file: | ||
|
|
||
| ```yaml | ||
| providers: | ||
| - provider: provider_name # Service provider name, such as openai, anthropic, gemini, openrouter, deepbricks, arbitrary name, required | ||
| - provider: provider_name # Service provider name, such as openai, anthropic, gemini, openrouter, deepbricks, any name, required | ||
| base_url: https://api.your.com/v1/chat/completions # Backend service API address, required | ||
| api: sk-YgS6GTi0b4bEabc4C # Provider's API Key, required | ||
| model: # At least one model | ||
| model: # At least one model is required | ||
| - gpt-4o # Usable model name, required | ||
| - claude-3-5-sonnet-20240620: claude-3-5-sonnet # Rename model, claude-3-5-sonnet-20240620 is the provider's model name, claude-3-5-sonnet is the renamed name, can use a short name instead of the original complex name, optional | ||
| - claude-3-5-sonnet-20240620: claude-3-5-sonnet # Rename model, claude-3-5-sonnet-20240620 is the provider's model name, claude-3-5-sonnet is the renamed name, you can use a simpler name instead of the original complex name, optional | ||
| - dall-e-3 | ||
|
|
||
| - provider: anthropic | ||
| base_url: https://api.anthropic.com/v1/messages | ||
| api: # Supports multiple API Keys, multiple keys automatically enable polling load balancing, at least one key, required | ||
| api: # Supports multiple API Keys, multiple keys automatically enable round-robin load balancing, at least one key, required | ||
| - sk-ant-api03-bNnAOJyA-xQw_twAA | ||
| - sk-ant-api02-bNnxxxx | ||
| model: | ||
| - claude-3-5-sonnet-20240620: claude-3-5-sonnet # Rename model, claude-3-5-sonnet-20240620 is the provider's model name, claude-3-5-sonnet is the renamed name, can use a short name instead of the original complex name, optional | ||
| - claude-3-5-sonnet-20240620: claude-3-5-sonnet # Rename model, claude-3-5-sonnet-20240620 is the provider's model name, claude-3-5-sonnet is the renamed name, you can use a simpler name instead of the original complex name, optional | ||
| tools: true # Whether to support tools, such as generating code, generating documents, etc., default is true, optional | ||
|
|
||
| - provider: gemini | ||
| base_url: https://generativelanguage.googleapis.com/v1beta # base_url supports v1beta/v1, only for Gemini models, required | ||
| api: AIzaSyAN2k6IRdgw | ||
| model: | ||
| - gemini-1.5-pro | ||
| - gemini-1.5-flash-exp-0827: gemini-1.5-flash # After renaming, the original model name gemini-1.5-flash-exp-0827 cannot be used, if you want to use the original name, you can add the original name in the model, just add the following line to use the original name | ||
| - gemini-1.5-flash-exp-0827: gemini-1.5-flash # After renaming, the original model name gemini-1.5-flash-exp-0827 cannot be used. If you want to use the original name, you can add the original name in the model, just add the line below to use the original name. | ||
| - gemini-1.5-flash-exp-0827 # Add this line, both gemini-1.5-flash-exp-0827 and gemini-1.5-flash can be requested | ||
| tools: true | ||
|
|
||
| - provider: vertex | ||
| project_id: gen-lang-client-xxxxxxxxxxxxxx # Description: Your Google Cloud project ID. Format: String, usually composed of lowercase letters, numbers, and hyphens. How to obtain: You can find your project ID in the project selector of the Google Cloud Console. | ||
| private_key: "-----BEGIN PRIVATE KEY-----\nxxxxx\n-----END PRIVATE" # Description: The private key of the Google Cloud Vertex AI service account. Format: A JSON formatted string containing the private key information of the service account. How to obtain: Create a service account in the Google Cloud Console, generate a JSON formatted key file, and then set its content as the value of this environment variable. | ||
| client_email: [email protected] # Description: The email address of the Google Cloud Vertex AI service account. Format: Usually a string like "[email protected]". How to obtain: Generated when creating the service account, you can also view the service account details in the "IAM & Admin" section of the Google Cloud Console. | ||
| project_id: gen-lang-client-xxxxxxxxxxxxxx # Description: Your Google Cloud project ID. Format: String, usually consists of lowercase letters, numbers, and hyphens. How to get: You can find your project ID in the project selector of the Google Cloud Console. | ||
| private_key: "-----BEGIN PRIVATE KEY-----\nxxxxx\n-----END PRIVATE" # Description: Private key of Google Cloud Vertex AI service account. Format: A JSON formatted string containing the private key information of the service account. How to get: Create a service account in the Google Cloud Console, generate a JSON formatted key file, and set its content as the value of this environment variable. | ||
| client_email: [email protected] # Description: Email address of the Google Cloud Vertex AI service account. Format: Usually a string like "[email protected]". How to get: Generated when creating the service account, or you can view the service account details in the "IAM & Admin" section of the Google Cloud Console. | ||
| model: | ||
| - gemini-1.5-pro | ||
| - gemini-1.5-flash | ||
|
|
@@ -75,7 +75,14 @@ providers: | |
| - claude-3-sonnet@20240229: claude-3-sonnet | ||
| - claude-3-haiku@20240307: claude-3-haiku | ||
| tools: true | ||
| notes: https://xxxxx.com/ # Can put the provider's website, notes, official documentation, optional | ||
| notes: https://xxxxx.com/ # You can put the provider's website, notes, official documentation, optional | ||
|
|
||
| - provider: cloudflare | ||
| api: f42b3xxxxxxxxxxq4aoGAh # Cloudflare API Key, required | ||
| cf_account_id: 8ec0xxxxxxxxxxxxe721 # Cloudflare Account ID, required | ||
| model: | ||
| - '@cf/meta/llama-3.1-8b-instruct': llama-3.1-8b # Rename model, @cf/meta/llama-3.1-8b-instruct is the provider's original model name, must be enclosed in quotes otherwise YAML syntax error, llama-3.1-8b is the renamed name, you can use a simpler name instead of the original complex name, optional | ||
| - '@cf/meta/llama-3.1-8b-instruct' # Must be enclosed in quotes otherwise YAML syntax error | ||
|
|
||
| - provider: other-provider | ||
| base_url: https://api.xxx.com/v1/messages | ||
|
|
@@ -95,28 +102,28 @@ api_keys: | |
|
|
||
| - api: sk-pkhf60Yf0JGyJygRmXqFQyTgWUd9GZnmi3KlvowmRWpWqrhy | ||
| model: | ||
| - anthropic/claude-3-5-sonnet # Usable model name, can only use the claude-3-5-sonnet model provided by the provider named anthropic. Models of other providers' claude-3-5-sonnet cannot be used. | ||
| - anthropic/claude-3-5-sonnet # Usable model name, can only use the claude-3-5-sonnet model provided by the provider named anthropic. Models with the same name from other providers cannot be used. | ||
| preferences: | ||
| USE_ROUND_ROBIN: true # Whether to use polling load balancing, true to use, false to not use, default is true. When polling is enabled, each request model is requested in the order configured in the model. It is not related to the original channel order in providers. Therefore, you can set different request sequences for each API key. | ||
| USE_ROUND_ROBIN: true # Whether to use round-robin load balancing, true to use, false to not use, default is true. When enabled, each request to the model is made in the order configured in the model. This is independent of the original channel order in providers. Therefore, you can set different request orders for each API key. | ||
| AUTO_RETRY: true # Whether to automatically retry, automatically retry the next provider, true to automatically retry, false to not automatically retry, default is true | ||
| RATE_LIMIT: 2/min # Supports rate limiting, maximum number of requests per minute, can be set to an integer, such as 2/min, 2 times per minute, 5/hour, 5 times per hour, 10/day, 10 times per day, 10/month, 10 times per month, 10/year, 10 times per year. Default is 60/min, optional | ||
|
|
||
| # Channel-level weighted load balancing configuration example | ||
| - api: sk-KjjI60Yf0JFWtxxxxxxxxxxxxxxwmRWpWpQRo | ||
| model: | ||
| - gcp1/*: 5 # The number after the colon is the weight, weights only support positive integers. | ||
| - gcp2/*: 3 # The larger the number, the greater the probability of being requested. | ||
| - gcp3/*: 2 # In this example, there are a total of 10 weights for all channels, and 5 out of 10 requests will request the gcp1/* model, 2 requests will request the gcp2/* model, and 3 requests will request the gcp3/* model. | ||
| - gcp1/*: 5 # The number after the colon is the weight, only positive integers are supported. | ||
| - gcp2/*: 3 # The larger the number, the higher the probability of the request. | ||
| - gcp3/*: 2 # In this example, there are a total of 10 weights for all channels, and out of 10 requests, 5 requests will request the gcp1/* model, 2 requests will request the gcp2/* model, and 3 requests will request the gcp3/* model. | ||
|
|
||
| preferences: | ||
| USE_ROUND_ROBIN: true # When USE_ROUND_ROBIN must be true and there is no weight after the channels above, it will request in the original channel order, if there is weight, it will request in the weighted order. | ||
| USE_ROUND_ROBIN: true # When USE_ROUND_ROBIN must be true and there is no weight after the above channels, requests will be made in the original channel order. If there are weights, requests will be made in the weighted order. | ||
| AUTO_RETRY: true | ||
| ``` | ||
| ## Environment variables | ||
| ## Environment Variables | ||
| - CONFIG_URL: The download address of the configuration file, it can be a local file or a remote file, optional | ||
| - TIMEOUT: Request timeout, default is 20 seconds. The timeout can control the time needed to switch to the next channel when a channel does not respond. Optional | ||
| - TIMEOUT: Request timeout, default is 20 seconds, the timeout can control the time needed to switch to the next channel when a channel does not respond. Optional | ||
| ## Docker Local Deployment | ||
|
|
@@ -143,7 +150,7 @@ services: | |
| - ./api.yaml:/home/api.yaml | ||
| ``` | ||
| CONFIG_URL is a direct link that can automatically download remote configuration files. For example, if you find it inconvenient to modify configuration files on a certain platform, you can upload the configuration file to a hosting service and provide a direct link for uni-api to download. CONFIG_URL is this direct link. | ||
| CONFIG_URL is a direct link that can automatically download remote configuration files. For instance, if you find it inconvenient to modify configuration files on a certain platform, you can upload the configuration files to a hosting service that provides a direct link for uni-api to download. CONFIG_URL is this direct link. | ||
| Run Docker Compose container in the background | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.