Add AI agents tutorial - #319
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
dantasse
left a comment
There was a problem hiding this comment.
(copying from slack)
it's a weird thing to write a doc about, right? like the thing we want users to really do is: type in "/lancedb do what I want"
... maybe we should? e.g. this is kind of another "lancedb end to end project", like I'm not sure how this particular example is about "using agents"
ooh ok, I have an idea: make this into two docs:
- "build with agents" - which is basically the top section of this doc; the part before "Tutorial: Use the LanceDB skill"
- "use branching and merging" - focuses on branching and merging
But, approving in case you disagree, I don't want to hold you up too much! like it wouldn't hurt anything to merge as is :)
|
|
||
| ### Skills support both OSS and Enterprise | ||
|
|
||
| Choose OSS or Enterprise based on how the work will run |
There was a problem hiding this comment.
missing punctuation at the end of the line
|
|
||
| ```text Agent prompt | ||
| # If using OSS | ||
| Use the lancedb skill to ingest the dataset in `data/` into a LanceDB |
There was a problem hiding this comment.
so I think on claude I would type:
/lancedb ingest the dataset in `data/` into a LanceDB OSS table
and on codex I would type:
$lancedb ingest the dataset in `data/` into a LanceDB OSS table
Should we recommend that kind of usage? It's more concise
Per review feedback on PR #319, split the single "Build with AI agents" page at the branching boundary: - build-with-ai-agents.mdx keeps the skill install, lockfile, and Camelot ingestion tutorial, plus the OSS/Enterprise takeaways. - agent-branch-experiments.mdx is a new page covering the branch-experiment workflow, applying a winner to main, and the "more experiments" table. It links to /tables/branching for merge/diff mechanics instead of duplicating the reference. - docs.json groups both pages in a collapsible folder (expanded by default). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Split the tutorial into two docs based on the review feedback, grouped under a collapsible sidebar folder. What changed
Notes
|
Summary
Adds a tutorial for building with AI agents and LanceDB. It shows how to install and update the LanceDB skill, explains the reviewable skill lockfile, and walks through a multimodal Camelot ingestion pipeline.
The tutorial asks readers to inspect the code an agent creates for strict Pydantic validation, batched writes, and the correct OSS maintenance step. It also demonstrates how to use branches for isolated embedding experiments and broadens that pattern to parser, retrieval, curation, and migration work.
Why this matters
Before this change, the documentation did not give coding-agent users a concrete LanceDB workflow or a way to evaluate agent-generated data changes safely. Readers could install a skill without a practical guide to validating the generated pipeline, selecting OSS or Enterprise, or keeping an experiment out of
main.The new guide makes those decisions explicit. It positions OSS for local and single-machine work where the application owns maintenance, and Enterprise for shared production infrastructure with distributed capacity and managed operations. It also frames a branch as an evaluation boundary: state a hypothesis, use a fixed test set, review the results, and promote only an approved change.
Validation