OpenAI.jl icon indicating copy to clipboard operation
OpenAI.jl copied to clipboard

Add examples in the docs

Open svilupp opened this issue 2 years ago • 3 comments

It would be excellent to add some examples in the docs.

I suspect it is hard for newcomers to use the various endpoints and also debug the common error. There is a lot of knowledge how we use these endpoints that is not captured anywhere yet.

Ideas:

  • How to call chat endpoint with the new modes (function call/ tools call, json mode, logit bias classifier)
  • HTTP debugging and tips (errors when calling wrong model-endpoint combination, dropped calls, timeouts, async challenges (Pool vs Threads))
  • Common problems (truncated output for vision models, etc)
  • Some practical example to build easy templates with structs?

WDYT? We could probably start small.

svilupp avatar Nov 19 '23 12:11 svilupp

Agreed - I'm going to start drafting something up while adding the new features.

roryl23 avatar Nov 19 '23 16:11 roryl23