Skip to content

Commit be78264

Browse files
committed
Proper docstring for RAGs handlers
1 parent 2110351 commit be78264

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

src/app/endpoints/rags.py

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ async def rags_endpoint_handler(
7575
and `cause` when unable to connect to Llama Stack.
7676
7777
### Returns:
78-
- RAGListResponse: List of RAG identifiers.
78+
- RAGListResponse: List of RAG identifiers.
7979
"""
8080
# Used only by the middleware
8181
_ = auth
@@ -147,16 +147,23 @@ async def get_rag_endpoint_handler(
147147
vector_store_id. If a rag_id from config is provided, it is resolved
148148
to the underlying vector_store_id for the llama-stack lookup.
149149
150-
Returns:
151-
RAGInfoResponse: A single RAG's details.
152-
153-
Raises:
154-
HTTPException:
155-
- 401: Authentication failed
156-
- 403: Authorization failed
157-
- 404: RAG with the given ID not found
158-
- 500: Lightspeed Stack configuration not loaded
159-
- 503: Unable to connect to Llama Stack
150+
### Parameters:
151+
- request: The incoming HTTP request (used by middleware).
152+
- rag_id: rag_id or llama-stack vector_store_id
153+
- auth: Authentication tuple from the auth dependency (used by middleware).
154+
155+
### Raises:
156+
- HTTPException: with status 401 for unauthorized access.
157+
- HTTPException: with status 403 if permission is denied.
158+
- HTTPException: with status 404 if rag_id is not found.
159+
- HTTPException: with status 422 for incorrect request payload.
160+
- HTTPException: with status 500 and a detail object containing `response`
161+
and `cause` when service configuration is wrong or incomplete.
162+
- HTTPException: with status 503 and a detail object containing `response`
163+
and `cause` when unable to connect to Llama Stack.
164+
165+
### Returns:
166+
- RAGInfoResponse: A single RAG's details.
160167
"""
161168
# Used only by the middleware
162169
_ = auth

0 commit comments

Comments
 (0)