Skip to content

Ambiguity in config.json Configuration — OpenAI vs Azure #67

Open
@rayyush

Description

@rayyush

The config.json file example in the documentation shows both OpenAI and Azure keys simultaneously:

{
"OPENAI_API_KEY": "<OPENAI_API_KEY>",
"AZURE_API_KEY": "<AZURE_API_KEY>",
"AZURE_ENDPOINT": "https://yourendpoint.openai.azure.com/"
}
However, it's unclear:

Whether both keys are required at once.

Which key takes priority if both are provided.

If only one is used, whether the other should be left blank, omitted entirely, or set to null.

Steps to Reproduce:

Follow setup instructions and reach the config step.

Try to run the project using OPENAI_API_KEY only.

Uncertainty arises on whether Azure fields should be deleted or left as placeholders.

Expected Behavior:

The documentation should clearly state:

Whether you should use either OpenAI OR Azure, not both.

What a valid config.json should look like for each case individually.

How the system detects which provider to use.

Suggested Fix:

Add two example configs in the documentation:

For OpenAI only:

{
"OPENAI_API_KEY": "sk-...",
"AZURE_API_KEY": null,
"AZURE_ENDPOINT": null
}

For Azure only:
{
"OPENAI_API_KEY": null,
"AZURE_API_KEY": "abc123",
"AZURE_ENDPOINT": "https://xyz.openai.azure.com/"
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions