JuliaML / JuliaML/OpenAI.jl

Add examples in the docs

Open
#54 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Julia
Stars
119
Forks
25
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.