feat(client): support callable api_key

[johanste]

• I understand that this repository is auto-generated and my pull request may not be merged

Changes being requested

Make the api_key parameter accept a typing. Callable[[], str] (or typing.Callable[[], typing.Awaitable[str]] for the async client) to allow for dynamic token refresh.

Additional context & links

This is what the python_ad.py example would look like when using the base OpenAI clients + the bearer token provider.

import asyncio

from openai.lib.azure import OpenAI, AsyncOpenAI, AzureADTokenProvider, AsyncAzureADTokenProvider

scopes = "https://cognitiveservices.azure.com/.default"

# https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource
endpoint = "https://<your-custom-endpoint>.openai.azure.com/openai/v1"

deployment_name = "gpt-4o"  # e.g. gpt-35-instant


def sync_main() -> None:
    from azure.identity import DefaultAzureCredential, get_bearer_token_provider

    token_provider: AzureADTokenProvider = get_bearer_token_provider(DefaultAzureCredential(), scopes)

    client = OpenAI(
        base_url = endpoint,
        api_key = token_provider,
    )

    completion = client.chat.completions.create(
        model=deployment_name,
        messages=[
            {
                "role": "user",
                "content": "How do I output all files in a directory using Python?",
            }
        ],
    )

    print(completion.to_json())


async def async_main() -> None:
    from azure.identity.aio import DefaultAzureCredential, get_bearer_token_provider

    token_provider: AsyncAzureADTokenProvider = get_bearer_token_provider(DefaultAzureCredential(), scopes)

    client = AsyncOpenAI(
        api_key=token_provider,
        base_url=endpoint,
    )

    completion = await client.chat.completions.create(
        model=deployment_name,
        messages=[
            {
                "role": "user",
                "content": "How do I output all files in a directory using Python?",
            }
        ],
    )
    print(completion.to_json())


sync_main()

asyncio.run(async_main())

[RobertCraigie]

Look great!

[RobertCraigie]

This feels like it could be brittle and cause some weird behaviour if we access self.api_key in multiple places for the same request.

My gut is that we could just not support callable api keys for the module client?

[kristapratico]

Discussed with @johanste offline and agreed we can remove callable api keys for the module level client.

[RobertCraigie]

Looks great thank you!