Improved docs for extra-openai-models.yaml (#957)

- Mention mandatory model_name field 
- Document support_schema option
This commit is contained in:
Rahim Nathwani 2025-05-04 10:30:37 -07:00 committed by GitHub
parent 0b37123a38
commit 07ccfbcee5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -137,12 +137,15 @@ Let's say OpenAI have just released the `gpt-3.5-turbo-0613` model and you want
```yaml
- model_id: gpt-3.5-turbo-0613
model_name: gpt-3.5-turbo-0613
aliases: ["0613"]
```
The `model_id` is the identifier that will be recorded in the LLM logs. You can use this to specify the model, or you can optionally include a list of aliases for that model.
If the model is a completion model (such as `gpt-3.5-turbo-instruct`) add `completion: true` to the configuration.
If the model supports structured extraction using json_schema, add `supports_schema: true` to the configuration.
For reasoning models like `o1` or `o3-mini` add `reasoning: true`.
With this configuration in place, the following command should run a prompt against the new model: