Models
Azure
Example
Azure Params
| Parameter | Type | Default | Description |
|---|---|---|---|
name | str | "AzureOpenAIChat" | The name of the Azure OpenAI Chat model. |
model | str | - | The specific model to use for Azure OpenAI Chat. |
api_key | str | - | The API key for Azure OpenAI. |
api_version | str | "2023-12-01-preview" | The API version to use for Azure OpenAI. |
azure_deployment | str | - | The Azure deployment name for the model. |
base_url | str | - | The base URL for the Azure OpenAI API. |
azure_ad_token | str | - | The Azure AD token for authentication. |
azure_ad_token_provider | str | - | The provider for Azure AD token. |
openai_client | AzureOpenAIClient | - | An instance of AzureOpenAIClient, if already created. |
LLM Params
Azure is a subclass of the LLM class and has access to the same params
| Parameter | Type | Default | Description |
|---|---|---|---|
model | str | - | ID of the model to use. |
name | str | - | Name for this LLM. Note: This is not sent to the LLM API. |
metrics | Dict[str, Any] | - | Metrics collected for this LLM. Note: This is not sent to the LLM API. |
response_format | Any | - | Format of the response. |
tools | List[Union[Tool, Dict]] | - | A list of tools provided to the LLM. Tools are functions the model may generate JSON inputs for. If you provide a dict, it is not called by the model. Always add tools using the add_tool() method. |
tool_choice | Union[str, Dict[str, Any]] | - | Controls which (if any) function is called by the model. "none" means the model will not call a function and instead generates a message. "auto" means the model can pick between generating a message or calling a function. Specifying a particular function via {"type": "function", "function": {"name": "my_function"}} forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. |
run_tools | bool | True | If True, runs tools. |
show_tool_calls | bool | - | If True, shows tool calls in the response. |
functions | Dict[str, Function] | - | Functions extracted from the tools. Note: These are not sent to the LLM API and are only used for execution. |
function_call_limit | int | 20 | Maximum number of function calls allowed. |
function_call_stack | List[FunctionCall] | - | Stack of function calls. |
system_prompt | str | - | System prompt provided to the LLM. |
instructions | str | - | Instructions provided to the LLM. |