@takoviz/ai-sdk 1.0.0

package/PUBLISH.md

@@ -0,0 +1,45 @@
+# Publishing to npm
+
+## Steps to Publish
+
+1. **Login to npm** (if not already logged in):
+   ```bash
+   npm login
+   ```
+
+2. **Build the package**:
+   ```bash
+   npm run build
+   ```
+   This compiles TypeScript to JavaScript in the `dist/` folder.
+
+3. **Publish to npm**:
+   ```bash
+   npm publish --access public
+   ```
+
+   The package will be published as `@takoviz/ai-sdk` version `1.0.0`.
+
+4. **Verify publication**:
+   - Check at: https://www.npmjs.com/package/@takoviz/ai-sdk
+   - Test installation: `npm install @takoviz/ai-sdk`
+
+---
+
+## Updating Version
+
+To publish a new version:
+
+1. Update version in `package.json`:
+   ```bash
+   npm version patch  # For bug fixes (1.0.0 -> 1.0.1)
+   npm version minor  # For new features (1.0.0 -> 1.1.0)
+   npm version major  # For breaking changes (1.0.0 -> 2.0.0)
+   ```
+
+2. Build and publish:
+   ```bash
+   npm run build
+   npm publish --access public
+   git push && git push --tags
+   ```

package/README.md

@@ -0,0 +1,125 @@
+# Tako AI SDK
+
+Add powerful knowledge search with data visualizations to your AI applications using Tako's knowledge base.
+
+## Installation
+
+```bash
+npm install @takoviz/ai-sdk ai
+```
+
+## Setup
+
+Get your API key from the [Tako Dashboard](https://trytako.com) and set it as an environment variable:
+
+```bash
+export TAKO_API_KEY=your_api_key_here
+```
+
+## Quick Start
+
+```typescript
+import { takoSearch } from '@takoviz/ai-sdk';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: 'openai/gpt-4o-mini',
+  prompt: 'What is the stock price of Nvidia?',
+  tools: {
+    takoSearch: takoSearch(),
+  },
+  maxSteps: 5,
+});
+
+console.log(text);
+```
+
+## Configuration Options
+
+You can customize the search behavior by passing a configuration object:
+
+```typescript
+const { text } = await generateText({
+  model: 'openai/gpt-4o-mini',
+  prompt: 'What is the GDP of major economies?',
+  tools: {
+    takoSearch: takoSearch({
+      apiKey: 'your_api_key', // Optional: override environment variable
+      sourceIndexes: ['tako', 'web'], // Default: ['tako', 'web']
+      searchEffort: 'deep', // Options: 'fast', 'deep', 'auto'. Default: 'fast'
+      countryCode: 'US', // Default: 'US'
+      locale: 'en-US', // Default: 'en-US'
+      outputSettings: {
+        knowledgeCardSettings: {
+          imageDarkMode: true, // Default: false
+        },
+      },
+    }),
+  },
+  maxSteps: 5,
+});
+```
+
+## API Reference
+
+### `takoSearch(config?: TakoSearchConfig)`
+
+Creates a Tako knowledge search tool for use with Vercel AI SDK.
+
+#### Parameters
+
+- `config.apiKey` (optional): Tako API key. Defaults to `TAKO_API_KEY` environment variable.
+- `config.sourceIndexes` (optional): Array of index sources to search. Options: `'tako'`, `'web'`, `'connected_data'`. Default: `['tako', 'web']`.
+- `config.searchEffort` (optional): Search depth. Options: `'fast'`, `'deep'`, `'auto'`. Default: `'fast'`.
+- `config.countryCode` (optional): ISO3166-1 alpha-2 country code. Default: `'US'`.
+- `config.locale` (optional): Language/region identifier. Default: `'en-US'`.
+- `config.outputSettings` (optional): Output customization options.
+
+#### Returns
+
+A Vercel AI SDK tool that accepts a natural language query and returns Tako knowledge cards with visualizations, data, and sources.
+
+## Response Format
+
+The tool returns a `TakoSearchResponse` object:
+
+```typescript
+{
+  outputs: {
+    knowledge_cards: [
+      {
+        card_id: string;
+        title: string;
+        description: string;
+        webpage_url: string;
+        image_url: string;
+        sources: Array<{ source_name: string; url: string }>;
+        visualization_data: {
+          data: any[];
+          viz_config: Record<string, any>;
+        };
+      }
+    ];
+    answer: string;
+  };
+  request_id: string;
+}
+```
+
+## TypeScript
+
+This package includes full TypeScript type definitions. Import types as needed:
+
+```typescript
+import type { TakoSearchConfig, TakoSearchResponse, TakoKnowledgeCard } from '@takodata/ai-sdk';
+```
+
+## License
+
+MIT
+
+## Links
+
+- [Tako Documentation](https://docs.tako.com)
+- [Vercel AI SDK Documentation](https://sdk.vercel.ai/docs)
+- [GitHub Repository](https://github.com/TakoData/ai-sdk)

package/VERCEL_REGISTRY.md

@@ -0,0 +1,104 @@
+# Adding Tako to Vercel AI Registry
+
+After publishing to npm, follow these steps to add Tako to the official Vercel AI tools registry.
+
+## Prerequisites
+
+- ✅ Package published to npm at `@takoviz/ai-sdk`
+- ✅ README with clear documentation
+- ✅ Working code example tested
+- ✅ API key instructions in README
+
+## Steps
+
+### 1. Fork and Clone Vercel AI Repository
+
+```bash
+git clone https://github.com/vercel/ai.git
+cd ai
+pnpm install
+```
+
+### 2. Create Feature Branch
+
+```bash
+git checkout -b feat/add-tool-tako-search
+```
+
+### 3. Add Tool Entry
+
+Edit `content/tools-registry/registry.ts` and add this entry to the tools array:
+
+```typescript
+{
+  slug: 'tako-search',
+  name: 'Tako Search',
+  description: 'Search Tako\'s knowledge base for data visualizations, insights, and well-sourced information with charts and analytics.',
+  packageName: '@takoviz/ai-sdk',
+  installCommand: {
+    pnpm: 'pnpm add @takoviz/ai-sdk',
+    npm: 'npm install @takoviz/ai-sdk',
+    yarn: 'yarn add @takoviz/ai-sdk',
+    bun: 'bun add @takoviz/ai-sdk',
+  },
+  codeExample: `import { takoSearch } from '@takoviz/ai-sdk';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: 'openai/gpt-4o-mini',
+  prompt: 'What is the stock price of Nvidia?',
+  tools: {
+    takoSearch: takoSearch(),
+  },
+  maxSteps: 5,
+});
+
+console.log(text);`,
+  docsUrl: 'https://github.com/TakoData/ai-sdk#readme',
+  npmUrl: 'https://www.npmjs.com/package/@takoviz/ai-sdk',
+  websiteUrl: 'https://tako.com',
+  apiKeyEnvName: 'TAKO_API_KEY',
+  apiKeyUrl: 'https://trytako.com',
+  tags: ['search', 'data', 'visualization', 'analytics'],
+},
+```
+
+### 4. Test Locally
+
+```bash
+pnpm dev
+```
+
+Navigate to the tools registry page and verify your tool appears correctly.
+
+### 5. Create Pull Request
+
+```bash
+git add content/tools-registry/registry.ts
+git commit -m "feat(tools-registry): add tako-search"
+git push origin feat/add-tool-tako-search
+```
+
+Then:
+1. Go to https://github.com/vercel/ai
+2. Click "New Pull Request"
+3. Use title: `feat(tools-registry): add tako-search`
+4. Description:
+   ```
+   Adds Tako Search tool to the registry.
+
+   Tako Search provides access to Tako's knowledge base with data visualizations,
+   charts, and well-sourced analytics for AI applications.
+
+   - Package: @takoviz/ai-sdk
+   - Docs: https://github.com/TakoData/ai-sdk
+   - Website: https://tako.com
+   ```
+
+### 6. Wait for Review
+
+The Vercel team will review and merge your PR. Once merged, Tako will appear in the official AI SDK tools registry at https://sdk.vercel.ai/docs/ai-sdk-ui/tools-registry!
+
+## Reference
+
+Official guide: https://github.com/vercel/ai/blob/main/contributing/add-new-tool-to-registry.md

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { TakoSearchConfig, TakoSearchResponse } from "./types";
+export declare function takoSearch(config?: TakoSearchConfig): import("@ai-sdk/provider-utils").Tool<{
+    query: string;
+}, TakoSearchResponse>;
+export type { TakoSearchConfig, TakoSearchResponse, TakoKnowledgeCard, TakoSource, TakoVisualizationData, } from "./types";

package/dist/index.js

@@ -0,0 +1,58 @@
+import { tool } from "@ai-sdk/provider-utils";
+import { z } from "zod";
+export function takoSearch(config = {}) {
+    const { apiKey = process.env.TAKO_API_KEY || process.env.TAKO_API_TOKEN, sourceIndexes = ["tako", "web"], searchEffort = "fast", outputSettings, countryCode = "US", locale = "en-US", } = config;
+    return tool({
+        description: "Search Tako's knowledge base for visualized data, insights, and information. Use this to find knowledge cards with charts, data visualizations, and well-sourced answers to questions.",
+        inputSchema: z.object({
+            query: z
+                .string()
+                .min(1)
+                .max(500)
+                .describe("The search query - use natural language to describe what you're looking for"),
+        }),
+        execute: async ({ query }) => {
+            if (!apiKey) {
+                throw new Error("TAKO_API_KEY is required. Set it in environment variables or pass it in config.");
+            }
+            const requestBody = {
+                inputs: {
+                    text: query,
+                },
+                source_indexes: sourceIndexes,
+                search_effort: searchEffort,
+                country_code: countryCode,
+                locale: locale,
+            };
+            if (outputSettings) {
+                requestBody.output_settings = {
+                    knowledge_card_settings: {
+                        image_dark_mode: outputSettings.knowledgeCardSettings?.imageDarkMode,
+                    },
+                };
+            }
+            try {
+                const response = await fetch("https://trytako.com/api/v1/knowledge_search", {
+                    method: "POST",
+                    headers: {
+                        "Content-Type": "application/json",
+                        "X-API-Key": apiKey,
+                    },
+                    body: JSON.stringify(requestBody),
+                });
+                if (!response.ok) {
+                    const errorText = await response.text();
+                    throw new Error(`Tako API error: ${response.status} - ${errorText}`);
+                }
+                const data = await response.json();
+                return data;
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    throw new Error(`Failed to search with Tako: ${error.message}`);
+                }
+                throw error;
+            }
+        },
+    });
+}

package/dist/types.d.ts

@@ -0,0 +1,36 @@
+export interface TakoSearchConfig {
+    apiKey?: string;
+    sourceIndexes?: ("tako" | "web" | "connected_data")[];
+    searchEffort?: "fast" | "deep" | "auto";
+    outputSettings?: {
+        knowledgeCardSettings?: {
+            imageDarkMode?: boolean;
+        };
+    };
+    countryCode?: string;
+    locale?: string;
+}
+export interface TakoSource {
+    source_name: string;
+    url: string;
+}
+export interface TakoVisualizationData {
+    data: any[];
+    viz_config: Record<string, any>;
+}
+export interface TakoKnowledgeCard {
+    card_id: string;
+    title: string;
+    description: string;
+    webpage_url: string;
+    image_url: string;
+    sources: TakoSource[];
+    visualization_data: TakoVisualizationData;
+}
+export interface TakoSearchResponse {
+    outputs: {
+        knowledge_cards: TakoKnowledgeCard[];
+        answer: string;
+    };
+    request_id: string;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@takoviz/ai-sdk",
+  "version": "1.0.0",
+  "description": "Tako knowledge search tool for Vercel AI SDK",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "tsx test.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "tako",
+    "knowledge-search",
+    "ai-sdk",
+    "vercel",
+    "data-visualization",
+    "ai",
+    "tools"
+  ],
+  "author": "Tako",
+  "license": "MIT",
+  "homepage": "https://tako.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TakoData/ai-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/TakoData/ai-sdk/issues"
+  },
+  "peerDependencies": {
+    "ai": "^6.0.18"
+  },
+  "dependencies": {
+    "@ai-sdk/anthropic": "^3.0.8",
+    "@ai-sdk/gateway": "^3.0.9",
+    "@ai-sdk/openai": "^3.0.7",
+    "@ai-sdk/provider-utils": "^4.0.4",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.0.0"
+  }
+}

package/test.ts

@@ -0,0 +1,22 @@
+import { takoSearch } from './src/index.js';
+import { generateText } from 'ai';
+import { openai } from '@ai-sdk/openai';
+
+async function test() {
+  const result = await generateText({
+    model: openai('gpt-4o-mini'),
+    prompt: 'What is the stock price of Nvidia?',
+    tools: {
+      takoSearch: takoSearch(),
+    },
+    maxSteps: 5,
+  });
+
+  console.log('Result text:', result.text);
+  console.log('\nTool calls:', JSON.stringify(result.toolCalls, null, 2));
+  console.log('\nTool results:', JSON.stringify(result.toolResults, null, 2));
+  console.log('\nSteps:', result.steps.length);
+  console.log('\nWarnings:', result.warnings);
+}
+
+test().catch(console.error);