Skip to content

AzureLLMUnit

Description: Azure LLM Unit. Requires model to be defined. See https://www.eidolonai.com/docs/howto/swap_llm for more details.

Authentication is handled oot with one of two mechanisms:

  • Static token defined with AZURE_OPENAI_API_KEY
  • Token provider defined by AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, and AZURE_TENANT_ID

To use an alternative authentication mechanism, provide a custom token provider.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ implementationNoconstNo-Implementation
+ modelNoReference[LLMModel]No-The model to use for the LLM. Since Azure deployments use custom names, no default is provided. See https://www.eidolonai.com/docs/howto/swap_llm for more details. on defining custom models.
- temperatureNonumberNo-Temperature
- force_jsonNobooleanNo-Force Json
- max_tokensNointegerNo-Max Tokens
- supports_system_messagesNobooleanNo-Supports System Messages
- can_streamNobooleanNo-Can Stream
+ azure_endpointNostringNo-Azure Endpoint
- azure_ad_token_providerNoobjectNoIn #/$defs/_Reference-
- token_provider_scopesNoarray of stringNo-Token Provider Scopes
- api_versionNostringNo-Api Version
- client_argsNoobjectNo-Client Args

1. Property implementation

Title: Implementation

Typeconst
RequiredYes

Specific value: "AzureLLMUnit"

2. Property model

TypeReference[LLMModel]
RequiredYes
Default{"implementation": "eidolon_ai_sdk.apu.llm_unit.LLMModel"}

Description: The model to use for the LLM. Since Azure deployments use custom names, no default is provided. See https://www.eidolonai.com/docs/howto/swap_llm for more details. on defining custom models.

3. Property temperature

Title: Temperature

Typenumber
RequiredNo
Default0.3

4. Property force_json

Title: Force Json

Typeboolean
RequiredNo
Defaulttrue

5. Property max_tokens

Title: Max Tokens

Typeinteger
RequiredNo
Defaultnull

6. Property supports_system_messages

Title: Supports System Messages

Typeboolean
RequiredNo
Defaulttrue

7. Property can_stream

Title: Can Stream

Typeboolean
RequiredNo
Defaulttrue

8. Property azure_endpoint

Title: Azure Endpoint

Typestring
RequiredYes

Description: The azure_endpoint for the Azure LLM API. ie, “https://eidolon-azure.openai.azure.com/

9. Property azure_ad_token_provider

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Defined in#/$defs/_Reference
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- implementationNostringNo-Implementation
- NoobjectNo--

9.1. Property implementation

Title: Implementation

Typestring
RequiredNo

10. Property token_provider_scopes

Title: Token Provider Scopes

Typearray of string
RequiredNo
Default["https://cognitiveservices.azure.com/.default"]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
token_provider_scopes items-

10.1. token_provider_scopes items

Typestring
RequiredNo

11. Property api_version

Title: Api Version

Typestring
RequiredNo
Default"2024-02-01"

12. Property client_args

Title: Client Args

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Default{}