llama-stack-mirror/llama_stack/apis
Alexey Rybak 224c99560c
docs: update docstrings for better formatting (#3838)
# What does this PR do?
Updates docstrings for Conversations and Eval APIs to render better in
the docs nav sidebar.

Before: 
<img width="363" height="233" alt="Screenshot 2025-10-17 at 9 52 17 AM"
src="https://github.com/user-attachments/assets/3a77f9e3-3b03-43ae-8584-a21d1f44d54d"
/>

After:
<img width="410" height="206" alt="Screenshot 2025-10-17 at 9 52 11 AM"
src="https://github.com/user-attachments/assets/fa5d428d-2bde-4453-84fd-9aceebe712e8"
/>


## Test Plan
* Manual testing
2025-10-17 10:41:50 -07:00
..
agents feat: Add responses and safety impl extra_body (#3781) 2025-10-15 15:01:37 -07:00
batches chore!: add double routes for v1/openai/v1 (#3636) 2025-10-02 16:11:05 +02:00
benchmarks feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00
common feat: Add support for Conversations in Responses API (#3743) 2025-10-10 11:57:40 -07:00
conversations docs: update docstrings for better formatting (#3838) 2025-10-17 10:41:50 -07:00
datasetio feat(api): implement v1beta leveling, and additional alpha (#3594) 2025-10-01 09:18:11 -07:00
datasets feat(api): implement v1beta leveling, and additional alpha (#3594) 2025-10-01 09:18:11 -07:00
eval docs: update docstrings for better formatting (#3838) 2025-10-17 10:41:50 -07:00
files docs: API docstrings cleanup for better documentation rendering (#3661) 2025-10-06 10:46:33 -07:00
inference feat(api)!: support extra_body to embeddings and vector_stores APIs (#3794) 2025-10-12 19:01:52 -07:00
inspect fix(auth): allow unauthenticated access to health and version endpoints (#3736) 2025-10-10 13:41:43 -07:00
models docs: API docstrings cleanup for better documentation rendering (#3661) 2025-10-06 10:46:33 -07:00
post_training feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00
prompts docs: API docstrings cleanup for better documentation rendering (#3661) 2025-10-06 10:46:33 -07:00
providers docs: API docstrings cleanup for better documentation rendering (#3661) 2025-10-06 10:46:33 -07:00
safety chore!: Safety api refactoring to use OpenAIMessageParam (#3796) 2025-10-12 08:01:00 -07:00
scoring feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00
scoring_functions feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00
shields feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00
synthetic_data_generation feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00
telemetry chore!: BREAKING CHANGE: remove sqlite from telemetry config (#3808) 2025-10-15 14:24:45 -07:00
tools feat(tools)!: substantial clean up of "Tool" related datatypes (#3627) 2025-10-02 15:12:03 -07:00
vector_dbs chore!: BREAKING CHANGE removing VectorDB APIs (#3774) 2025-10-11 14:07:08 -07:00
vector_io fix(vector-io): handle missing document_id in insert_chunks (#3521) 2025-10-15 11:02:48 -07:00
__init__.py API Updates (#73) 2024-09-17 19:51:35 -07:00
datatypes.py chore!: BREAKING CHANGE removing VectorDB APIs (#3774) 2025-10-11 14:07:08 -07:00
resource.py feat: Adding OpenAI Prompts API (#3319) 2025-09-08 11:05:13 -04:00
version.py feat: introduce API leveling, post_training, eval to v1alpha (#3449) 2025-09-26 16:18:07 +02:00