simonw / simonw/llm

Python API documentation for Response objects

Open
#643 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation python-api
Dominant language
Python
Stars
12.5k
Forks
991
Avg merge
3d 13h
Merged PRs (30d)
10

Description

Split from:

  • #642

Add a section to the Python API docs that explains the Response object - in particular the methods like .text() and .duration_ms() and suchlike, which may need await for the AsyncResponse.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing Python API documentation and the Response and AsyncResponse APIs described in the issue. Document methods such as .text() and .duration_ms(), including when asynchronous methods require await; done means the section clearly explains these objects and their usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.