Narrative Agent

async generateNarrative(
  params: GenerateNarrativeParams,
  onProgress?: (event: ProgressEvent) => void,
  signal?: AbortSignal
): Promise<GenerateNarrativeResponse>

async generateNarrativeStream(
  params: GenerateNarrativeParams,
  signal?: AbortSignal
): Promise<AsyncIterableIterator<SSEEvent<GenerateNarrativeResponse>>>

interface GenerateNarrativeParams {
  config: GraphConfig;
  userPrompt: string;
  metadata?: Metadata;
}

interface GenerateNarrativeResponse {
  response: {
    message: string;
  };
  config: GraphConfig;
}

import { GraphyAiSdk } from '@graphysdk/agents-sdk';
import type { GraphConfig } from '@graphysdk/core';

const ai = new GraphyAiSdk({
  apiKey: process.env.GRAPHY_API_KEY,
  baseUrl: 'https://agents.graphy.dev',
});

const config: GraphConfig = {
  type: 'line',
  data: {
    columns: [
      { key: 'month', label: 'Month' },
      { key: 'users', label: 'Active Users' },
    ],
    rows: [
      { month: 'Jan', users: 1200 },
      { month: 'Feb', users: 1800 },
      { month: 'Mar', users: 3100 },
    ],
  },
};

const result = await ai.generateNarrative({
  config,
  userPrompt: 'Write a punchy title and a one-line caption',
});

// Narrative is embedded in the config content as TipTap JSON
console.log(result.config.content?.title);
console.log(result.config.content?.caption);

const result = await ai.generateNarrative(
  {
    config,
    userPrompt: 'Make the title more specific and lead with the headline number',
  },
  (progress) => {
    console.log(progress.message);
  }
);

import { isProgressEvent, isCompleteEvent, isErrorEvent } from '@graphysdk/agents-sdk';

const stream = await ai.generateNarrativeStream({
  config,
  userPrompt: 'Write a title, subtitle, and caption',
});

for await (const event of stream) {
  if (isProgressEvent(event)) {
    console.log(event.message);
  }

  if (isCompleteEvent(event)) {
    console.log('Result:', event.data.config);
  }

  if (isErrorEvent(event)) {
    console.error('Error:', event.error);
  }
}

import { isGraphyApiError } from '@graphysdk/agents-sdk';

try {
  const result = await ai.generateNarrative({
    config,
    userPrompt: 'Write a title for this chart',
  });
} catch (error) {
  if (isGraphyApiError(error)) {
    console.error('API error:', error.message);
  }
}