Usage tokens no longer automatically show

[handrew]

I updated from 0.0.9 to 0.0.11 and my tokens logging broke. I fixed it by explicitly setting model_settings=ModelSettings(include_usage=True) in my agent definition.

Docs say that include_usage defaults to true. However, I don't think this is true unless the model is OpenAI.

Cursory glance suggests this is the line that causes the issue:

openai-agents-python/src/agents/models/chatcmpl_helpers.py

Line 30 in 5639606

default_include_usage = True if cls.is_openai(client) else None

[rm-openai]

Oops sorry yeah, had to change this because some model providers don't support this. I think changing the docs is probably the best option? Or else we could turn it on by default and people who run into errors are responsible for turning it off. What do you think?

[handrew]

Changing docs makes sense. I think it’d be helpful to also include an example or pointer to ModelSettings as the solution here, as I had to do some digging to figure out how to turn it back on.