# get_config_list ## ``autogen.get_config_list`` ``` get_config_list(api_keys, base_urls=None, api_type=None, api_version=None) ``` Get a list of configs for OpenAI API client. | PARAMETER | DESCRIPTION | |-------------|-------------| | `api_keys` | The api keys for openai api calls.
**TYPE:**`list` | | `base_urls` | The api bases for openai api calls. If provided, should match the length of api_keys.
**TYPE:**`list`**DEFAULT:**`None` | | `api_type` | The api type for openai api calls.
**TYPE:**`str`**DEFAULT:**`None` | | `api_version` | The api version for openai api calls.
**TYPE:**`str`**DEFAULT:**`None` | | RETURNS | DESCRIPTION | |---------|-------------| | `list` | A list of configs for OpenAI API calls.
**TYPE:**`list[dict[str, Any]]` | Example: ``` # Define a list of API keys api_keys = ["key1", "key2", "key3"] # Optionally, define a list of base URLs corresponding to each API key base_urls = ["https://api.service1.com", "https://api.service2.com", "https://api.service3.com"] # Optionally, define the API type and version if they are common for all keys api_type = "azure" api_version = "2024-02-01" # Call the get_config_list function to get a list of configuration dictionaries config_list = get_config_list(api_keys, base_urls, api_type, api_version) ``` Source code in `autogen/oai/openai_utils.py` | | | |-----|-----| | ```
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
``` | ````
@export_module("autogen")
def get_config_list(
api_keys: list[str],
base_urls: list[str] | None = None,
api_type: str | None = None,
api_version: str | None = None,
) -> list[dict[str, Any]]:
"""Get a list of configs for OpenAI API client.
Args:
api_keys (list): The api keys for openai api calls.
base_urls (list, optional): The api bases for openai api calls. If provided, should match the length of api_keys.
api_type (str, optional): The api type for openai api calls.
api_version (str, optional): The api version for openai api calls.
Returns:
list: A list of configs for OpenAI API calls.
Example:
```python
# Define a list of API keys
api_keys = ["key1", "key2", "key3"]
# Optionally, define a list of base URLs corresponding to each API key
base_urls = ["https://api.service1.com", "https://api.service2.com", "https://api.service3.com"]
# Optionally, define the API type and version if they are common for all keys
api_type = "azure"
api_version = "2024-02-01"
# Call the get_config_list function to get a list of configuration dictionaries
config_list = get_config_list(api_keys, base_urls, api_type, api_version)
```
"""
if base_urls is not None:
assert len(api_keys) == len(base_urls), "The length of api_keys must match the length of base_urls"
config_list = []
for i, api_key in enumerate(api_keys):
if not api_key.strip():
continue
config = {"api_key": api_key}
if base_urls:
config["base_url"] = base_urls[i]
if api_type:
config["api_type"] = api_type
if api_version:
config["api_version"] = api_version
config_list.append(config)
return config_list
```` |