Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wazoo.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Vercel AI SDK is the TypeScript toolkit for building reliable AI applications with React, Svelte, and Vue. The Worlds Platform AI SDK provides tools for LLMs to interact with the Worlds Platform.

​
Installation

Install the Worlds AI SDK from JSR: 
deno add jsr:@wazoo/worlds-ai-sdk

​
Usage

The tools are designed to work with the Vercel AI SDK. 
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";
import { Worlds } from "@wazoo/worlds-sdk";
import { createTools } from "@wazoo/worlds-ai-sdk";

const worlds = new Worlds({
  apiKey: process.env.WORLDS_API_KEY,
});

// @wazoo/worlds-ai-sdk
const tools = createTools({
  worlds,
  sources: ["my-world-slug"],
});

const { text } = await generateText({
  model: openai("gpt-4o"),
  tools,
  prompt: "Find all people in the knowledge base and describe them.",
});

​
Tools

The createTools function returns a full toolset for use with LLM frameworks.

​
Individual tools

If you require granular control, you can import and initialize tools individually. Each tool factory requires the same configuration options. 
import { Worlds } from "@wazoo/worlds-sdk";
import {
  createDiscoverSchemaTool,
  createExecuteSparqlTool,
  createSearchEntitiesTool,
} from "@wazoo/worlds-ai-sdk";

const worlds = new Worlds({
  apiKey: process.env.WORLDS_API_KEY,
});

const sources = ["my-world-slug"];

const discoverSchema = createDiscoverSchemaTool({ worlds, sources });
const executeSparql = createExecuteSparqlTool({ worlds, sources });
const searchEntities = createSearchEntitiesTool({ worlds, sources });

const tools = {
  discoverSchema,
  executeSparql,
  searchEntities,
};

​
Tool reference

ToolDescription
discoverSchemaExplore the ontology and schema of a specific world.
executeSparqlDirect execution of SPARQL queries against a world.
searchEntitiesVector-based semantic search for entities within a world.
generateIriUtility for generating valid IRIs for new entities.
disambiguateEntitiesUtility for mapping natural language entities to existing IRIs.
validateRdfUtility for validating generated RDF against a world.