mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-12 14:52:26 +00:00
Move the public website pages into `docs/web` beside the SDK, with
shared navigation and executable example sources in `docs/web-tests`.
The combined website is assembled by
[lancedb/docs#355](https://github.com/lancedb/docs/pull/355), with six
Enterprise replacements from
[lancedb/sophon#7681](https://github.com/lancedb/sophon/pull/7681).
This includes Function guidance, runnable Quickstarts, regenerated
snippets, production contact/demo fixes, the legacy SQL route, and the
LeRobot redirect. LeRobot remains attributed to Geneva; all 34 Geneva
pages remain in the docs repository until Function officially launches.
Materialized-view guidance follows the full rebuild refresh introduced
by #4373: local refresh writes the complete result, has no `full`
argument, supports `source_version`, and no longer requires stable row
IDs. Deployment SQL refresh options and stable-ID setup are qualified by
version/configuration. Function input guidance distinguishes ordinary
stored columns from computed inputs supported by newer deployments.
**Validation:** independently accepted local checks include 95 Python
tests (real Enterprise excluded), eight TypeScript tests, Rust
Quickstart, snippet parity, typos, deterministic assembly, Mint
validation and links/anchors/redirects. The combined baseline retains
all 181 production routes and 17 legacy redirects. Examples ran locally
against source-built Python SDK 0.40.0b13; existing GitHub workflows do
not run `docs/web-tests`. New main at `069b2f7d` is 0.41.0b0 and adds
computed Function inputs; that SDK was not exercised by the accepted
tests. Latest prose corrections receive focused site validation.
**Merge/rollout:** merge this and #7681 before #355's combined CI, which
reads producer `main`. This is migration infrastructure: section
overlays, source-owned skills and automatic versioned paired releases
remain follow-ups. The current manual publisher is transitional. Hosted
validation, a supported SDK/Enterprise release pair and a real
Enterprise walkthrough remain pending.
Production Mintlify watches `lancedb/docs:deploy-freeze`, directory
`docs`; preserve that source through review. The separate SDK GitHub
Pages reference workflow rebuilds on main merges.
**Updated-head CI (9a50f8db):**
[Typos](https://github.com/lancedb/lancedb/actions/runs/37654185443/job/112904990558),
[PR
title](https://github.com/lancedb/lancedb/actions/runs/37654179507/job/112904974595)
and
[Aikido](https://app.aikido.dev/featurebranch/scan/215386145?groupId=74229)
pass. Critical findings in the example lockfiles were patched: all Sharp
copies use 0.35.5, protobufjs 7.6.6, tar 7.5.22, quinn-proto 0.11.19,
zerovec 0.11.8 and zerovec-derive 0.11.6. The SDK's product dependencies
are unchanged. The revised lockfiles pass eight TypeScript examples,
HuggingFace decode/resize/crop/rescale/normalize plus AVIF roundtrip,
and Rust Quickstart. Aikido passing does not mean every advisory is
cleared; npm still reports 29 high and five moderate advisories in the
example dependency graph. No scanner bypass or suppression was added.
The Function prose correction passes combined/standalone Mint,
deterministic assembly, routes and assets. The revised 325-file site
checksum is
`175bec06864abb400dd292e667ba93448c0479b8359fd7bf6146afabf9040647`. This
PR remains open for independent review; further merges are on hold.
---------
Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
135 lines
3.7 KiB
TypeScript
135 lines
3.7 KiB
TypeScript
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
|
|
|
// --8<-- [start:frameworks_genkit_usage]
|
|
import { lancedbIndexerRef, lancedb, lancedbRetrieverRef, WriteMode } from "genkitx-lancedb";
|
|
import { textEmbedding004, vertexAI } from "@genkit-ai/vertexai";
|
|
import { gemini } from "@genkit-ai/vertexai";
|
|
import { z, genkit } from "genkit";
|
|
import { Document } from "genkit/retriever";
|
|
import { chunk } from "llm-chunk";
|
|
import { readFile } from "fs/promises";
|
|
import path from "path";
|
|
import pdf from "pdf-parse/lib/pdf-parse";
|
|
|
|
const ai = genkit({
|
|
plugins: [
|
|
// vertexAI provides the textEmbedding004 embedder
|
|
vertexAI(),
|
|
|
|
// the local vector store requires an embedder to translate from text to vector
|
|
lancedb([
|
|
{
|
|
dbUri: ".db", // optional lancedb uri, default to .db
|
|
tableName: "table", // optional table name, default to table
|
|
embedder: textEmbedding004,
|
|
},
|
|
]),
|
|
],
|
|
});
|
|
// --8<-- [end:frameworks_genkit_usage]
|
|
|
|
// --8<-- [start:frameworks_genkit_custom_indexer]
|
|
export const menuPdfIndexer = lancedbIndexerRef({
|
|
// Using all defaults, for dbUri, tableName, and embedder, etc
|
|
});
|
|
|
|
const chunkingConfig = {
|
|
minLength: 1000,
|
|
maxLength: 2000,
|
|
splitter: "sentence",
|
|
overlap: 100,
|
|
delimiters: "",
|
|
} as any;
|
|
|
|
async function extractTextFromPdf(filePath: string) {
|
|
const pdfFile = path.resolve(filePath);
|
|
const dataBuffer = await readFile(pdfFile);
|
|
const data = await pdf(dataBuffer);
|
|
return data.text;
|
|
}
|
|
|
|
export const indexMenu = ai.defineFlow(
|
|
{
|
|
name: "indexMenu",
|
|
inputSchema: z.string().describe("PDF file path"),
|
|
outputSchema: z.void(),
|
|
},
|
|
async (filePath: string) => {
|
|
filePath = path.resolve(filePath);
|
|
|
|
// Read the pdf.
|
|
const pdfTxt = await ai.run("extract-text", () => extractTextFromPdf(filePath));
|
|
|
|
// Divide the pdf text into segments.
|
|
const chunks = await ai.run("chunk-it", async () => chunk(pdfTxt, chunkingConfig));
|
|
|
|
// Convert chunks of text into documents to store in the index.
|
|
const documents = chunks.map((text) => {
|
|
return Document.fromText(text, { filePath });
|
|
});
|
|
|
|
// Add documents to the index.
|
|
await ai.index({
|
|
indexer: menuPdfIndexer,
|
|
documents,
|
|
options: {
|
|
writeMode: WriteMode.Overwrite,
|
|
} as any,
|
|
});
|
|
},
|
|
);
|
|
// --8<-- [end:frameworks_genkit_custom_indexer]
|
|
|
|
// --8<-- [start:frameworks_genkit_custom_retriever]
|
|
export const menuRetriever = lancedbRetrieverRef({
|
|
tableName: "table", // Use the same table name as the indexer.
|
|
displayName: "Menu", // Use a custom display name.
|
|
});
|
|
|
|
export const menuQAFlow = ai.defineFlow(
|
|
{ name: "Menu", inputSchema: z.string(), outputSchema: z.string() },
|
|
async (input: string) => {
|
|
// retrieve relevant documents
|
|
const docs = await ai.retrieve({
|
|
retriever: menuRetriever,
|
|
query: input,
|
|
options: {
|
|
k: 3,
|
|
},
|
|
});
|
|
|
|
const extractedContent = docs.map((doc) => {
|
|
if (doc.content && Array.isArray(doc.content) && doc.content.length > 0) {
|
|
if (doc.content[0].media && doc.content[0].media.url) {
|
|
return doc.content[0].media.url;
|
|
}
|
|
}
|
|
return "No content found";
|
|
});
|
|
|
|
console.log("Extracted content:", extractedContent);
|
|
|
|
const { text } = await ai.generate({
|
|
model: gemini("gemini-2.0-flash"),
|
|
prompt: `
|
|
You are acting as a helpful AI assistant that can answer
|
|
questions about the food available on the menu at Genkit Grub Pub.
|
|
|
|
Use only the context provided to answer the question.
|
|
If you don't know, do not make up an answer.
|
|
Do not add or change items on the menu.
|
|
|
|
Context:
|
|
${extractedContent.join("\n\n")}
|
|
|
|
Question: ${input}`,
|
|
docs,
|
|
});
|
|
|
|
return text;
|
|
},
|
|
);
|
|
// --8<-- [end:frameworks_genkit_custom_retriever]
|
|
|