Suggestions Agent

async generateSuggestions(
  params: GenerateGraphSuggestionsParams,
  onProgress?: (event: ProgressEvent) => void,
  signal?: AbortSignal
): Promise<GenerateGraphSuggestionsResponse>

async generateSuggestionsStream(
  params: GenerateGraphSuggestionsParams,
  signal?: AbortSignal
): Promise<AsyncIterableIterator<SSEEvent<GenerateGraphSuggestionsResponse>>>

interface GenerateGraphSuggestionsParams {
  config: GraphConfig;
  userPrompt?: string;
  metadata?: Metadata;
  maxSuggestionCount?: 1 | 2 | 3 | 4;
}

interface GenerateGraphSuggestionsResponse {
  suggestions: Suggestion[];
}

interface Suggestion {
  dataPrepPrompt: string;
  chartType: AiChartType;
  summary: string;
}

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: 'column',
  data: {
    columns: [
      { key: 'month', label: 'Month' },
      { key: 'sales', label: 'Sales' },
      { key: 'region', label: 'Region' },
    ],
    rows: [
      { month: 'Jan', sales: 100, region: 'North' },
      { month: 'Feb', sales: 120, region: 'South' },
      { month: 'Mar', sales: 115, region: 'North' },
    ],
  },
};

const result = await ai.generateSuggestions({
  config,
  userPrompt: 'Show me interesting trends',
});

for (const suggestion of result.suggestions) {
  console.log(`${suggestion.chartType}: ${suggestion.summary}`);
}

const result = await ai.generateSuggestions(
  {
    config,
    userPrompt: 'What charts would best show this data?',
  },
  (progress) => {
    console.log(progress.message);
  }
);

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

const stream = await ai.generateSuggestionsStream({
  config,
  userPrompt: 'Suggest charts for sales analysis',
});

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

  if (isCompleteEvent(event)) {
    console.log('Suggestions:', event.data.suggestions);
  }

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

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

try {
  const result = await ai.generateSuggestions({
    config,
    userPrompt: 'Suggest charts',
  });
} catch (error) {
  if (isGraphyApiError(error)) {
    console.error('API error:', error.message);
  }
}