Add blueprint generation API endpoint#377
Merged
Merged
Conversation
📝 WalkthroughWalkthroughThis PR adds a new FastAPI endpoint ChangesBlueprint Dataset Generation API
Sequence DiagramsequenceDiagram
participant Client
participant FastAPI as POST /datasets/blueprints/generate
participant BlueprintPipeline
participant DatasetStore
Client->>FastAPI: BlueprintGenerationRequest (target_count)
FastAPI->>FastAPI: Validate target_count ≤ max_api_generation_count
FastAPI->>FastAPI: Generate blueprint-ds-{uuid}
FastAPI->>BlueprintPipeline: generate(request, DatasetStore)
BlueprintPipeline->>DatasetStore: Persist results
BlueprintPipeline-->>FastAPI: BlueprintPipelineResult
FastAPI->>FastAPI: Truncate blueprints to max_api_returned_records
FastAPI-->>Client: { dataset_id, plan, blueprints }
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/casecrawler/api/routes/datasets.py`:
- Around line 213-225: The response currently returns result.dataset_id which
may diverge from the route-generated dataset_id; update the handler so that
after calling BlueprintPipeline().generate(...) you always use the locally
created dataset_id variable in the response (e.g., replace uses of
result.dataset_id with dataset_id) while keeping the pipeline call and error
handling intact—ensure BlueprintPipeline.generate(...) and any references to
returned_blueprints remain unchanged except for switching the response's
dataset_id to the route-generated dataset_id.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 4d9f7510-9f4c-44f2-ace6-8c4f2d93b30f
📒 Files selected for processing (2)
src/casecrawler/api/routes/datasets.pytests/test_api_datasets.py
Comment on lines
+213
to
+225
| dataset_id = f"blueprint-ds-{uuid4()}" | ||
| store = DatasetStore.shared() | ||
| try: | ||
| result = await BlueprintPipeline().generate( | ||
| req, | ||
| dataset_id=dataset_id, | ||
| store=store, | ||
| ) | ||
| except ValueError as err: | ||
| raise HTTPException(status_code=422, detail=str(err)) from err | ||
| returned_blueprints = result.blueprints[:max_returned] | ||
| return { | ||
| "dataset_id": result.dataset_id, |
There was a problem hiding this comment.
Return the route-generated dataset ID, not the pipeline-reported one.
This handler creates dataset_id on Line 213 and uses that ID for pipeline/store side effects, but the response on Line 225 trusts result.dataset_id. If those ever diverge, clients get an ID that does not match the persisted dataset and follow-up reads will break.
Suggested fix
dataset_id = f"blueprint-ds-{uuid4()}"
store = DatasetStore.shared()
try:
result = await BlueprintPipeline().generate(
req,
dataset_id=dataset_id,
store=store,
)
except ValueError as err:
raise HTTPException(status_code=422, detail=str(err)) from err
+ if result.dataset_id != dataset_id:
+ raise HTTPException(
+ status_code=500,
+ detail="blueprint pipeline returned a mismatched dataset_id",
+ )
returned_blueprints = result.blueprints[:max_returned]
return {
- "dataset_id": result.dataset_id,
+ "dataset_id": dataset_id,
"generated": result.generated_count,
"total_blueprints": len(result.blueprints),
"plan": result.plan.model_dump(),
"blueprints": [blueprint.model_dump() for blueprint in returned_blueprints],
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| dataset_id = f"blueprint-ds-{uuid4()}" | |
| store = DatasetStore.shared() | |
| try: | |
| result = await BlueprintPipeline().generate( | |
| req, | |
| dataset_id=dataset_id, | |
| store=store, | |
| ) | |
| except ValueError as err: | |
| raise HTTPException(status_code=422, detail=str(err)) from err | |
| returned_blueprints = result.blueprints[:max_returned] | |
| return { | |
| "dataset_id": result.dataset_id, | |
| dataset_id = f"blueprint-ds-{uuid4()}" | |
| store = DatasetStore.shared() | |
| try: | |
| result = await BlueprintPipeline().generate( | |
| req, | |
| dataset_id=dataset_id, | |
| store=store, | |
| ) | |
| except ValueError as err: | |
| raise HTTPException(status_code=422, detail=str(err)) from err | |
| if result.dataset_id != dataset_id: | |
| raise HTTPException( | |
| status_code=500, | |
| detail="blueprint pipeline returned a mismatched dataset_id", | |
| ) | |
| returned_blueprints = result.blueprints[:max_returned] | |
| return { | |
| "dataset_id": dataset_id, |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/casecrawler/api/routes/datasets.py` around lines 213 - 225, The response
currently returns result.dataset_id which may diverge from the route-generated
dataset_id; update the handler so that after calling
BlueprintPipeline().generate(...) you always use the locally created dataset_id
variable in the response (e.g., replace uses of result.dataset_id with
dataset_id) while keeping the pipeline call and error handling intact—ensure
BlueprintPipeline.generate(...) and any references to returned_blueprints remain
unchanged except for switching the response's dataset_id to the route-generated
dataset_id.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Tests
Summary by CodeRabbit
New Features
Tests