RagQueryRequest
RAG query request model
Properties
| Property | Type | Required | Description |
|---|---|---|---|
query | string | ✅ Yes | Question to ask the RAG system |
top_k | integer | ❌ No | Number of results |
include_citations | boolean | ❌ No | Include source citations |
Example
{
"query": "example",
"top_k": 1,
"include_citations": false
}Used In
Code Examples
TypeScript
interface RagQueryRequest {
query: string;
top_k?: number;
include_citations?: boolean;
}
// Usage example
const data: RagQueryRequest = {
"query": "example",
"top_k": 1,
"include_citations": false
};Python
from data_layer.schemas import RagQueryRequest
# Create instance
data = RagQueryRequest(
# Add your field values here
)cURL
curl -X POST "https://altsportsleagues-backend-2qcdjegnaa-uc.a.run.app/api/endpoint" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{ "query": "example", "top_k": 1, "include_citations": false }'Validation Rules
Required Fields: query
top_k: Minimum value 1
top_k: Maximum value 20
Additional Information
- Type: object
- Source: Generated from Pydantic models in
data_layer/schemas/ - Auto-validated: All fields are validated by FastAPI
This documentation is auto-generated from the OpenAPI specification.