Episodes API

const client = new NdxClient({
  apiKey: process.env.NEURADEX_API_KEY,
  projectId: 'your-project-id',
});

// Access Episodes API
const episodes = await client.episodes.list({ timeRange: 'today' });
await client.episodes.create({ ... });

interface EpisodeListResponse {
  data: Episode[];
  total: number;
  page: number;
  limit: number;
}

interface Episode {
  id: string;
  episodeType: string;
  content: string;
  actorType: string;
  actorId: string | null;
  actorName: string | null;
  scopeType: string;
  scopeId: string;
  channel: string | null;
  sessionId: string | null;
  parentEpisodeId: string | null;
  relatedKnowledgeIds: string[];
  changeReason: string | null;
  previousValue: object | null;
  occurredAt: string;
  createdAt: string;
}

// Today's episodes
const result = await client.episodes.list({ timeRange: 'today' });

// Episodes for a specific user
const result = await client.episodes.list({
  actorType: 'user',
  actorId: 'user-123',
  limit: 100,
});

// Get by date range
const result = await client.episodes.list({
  from: '2025-01-01T00:00:00Z',
  to: '2025-01-07T23:59:59Z',
});

// Question episodes only
const result = await client.episodes.list({
  episodeType: 'question',
});

const episode = await client.episodes.get('episode-123');

console.log(episode.content);
console.log(episode.actorName);
console.log(episode.occurredAt);

// Record user question
const question = await client.episodes.create({
  actorType: 'user',
  actorId: 'user-123',
  actorName: 'John Doe',
  episodeType: 'question',
  content: 'How do I reset my password?',
  scopeType: 'project',
  scopeId: 'project-abc',
  channel: 'widget',
  sessionId: 'session-xyz',
});

// Record agent answer
const answer = await client.episodes.create({
  actorType: 'agent',
  actorName: 'Support Bot',
  episodeType: 'answer',
  content: 'You can reset your password by clicking the "Forgot Password" link on the login screen.',
  scopeType: 'project',
  scopeId: 'project-abc',
  channel: 'widget',
  sessionId: 'session-xyz',
  parentEpisodeId: question.id,  // Link to question
  relatedKnowledgeIds: ['knowledge-1', 'knowledge-2'],
});

// Get answers to a question
const children = await client.episodes.getChildren('question-episode-id');

for (const child of children) {
  console.log(`Answer: ${child.content}`);
}

// Get conversation history
const result = await client.episodes.getBySession('session-123');

for (const episode of result.data) {
  const prefix = episode.episodeType === 'question' ? 'Q' : 'A';
  console.log(`${prefix}: ${episode.content}`);
}

// Recent 10
const result = await client.episodes.getRecent();

// Recent 50
const result = await client.episodes.getRecent(50);

// Today's episodes
const today = await client.episodes.getToday();

// This week's episodes
const thisWeek = await client.episodes.getThisWeek();

interface EpisodeSearchResponse {
  results: EpisodeSearchResult[];
  query: string;
}

interface EpisodeSearchResult {
  id: string;
  episodeType: string;
  content: string;
  actorType: string;
  actorName: string | null;
  occurredAt: string;
  channel: string | null;
  score: number;
}

// Search episodes
const result = await client.episodes.search('password reset');

for (const episode of result.results) {
  console.log(`${episode.actorName}: ${episode.content} (score: ${episode.score})`);
}

// Specify limit
const result = await client.episodes.search('deploy error', { limit: 5 });

async function recordConversation(
  sessionId: string,
  question: string,
  answer: string,
  userId: string,
) {
  // Record question
  const questionEpisode = await client.episodes.create({
    actorType: 'user',
    actorId: userId,
    episodeType: 'question',
    content: question,
    scopeType: 'project',
    scopeId: projectId,
    channel: 'api',
    sessionId,
  });

  // Record answer
  await client.episodes.create({
    actorType: 'agent',
    actorName: 'Assistant',
    episodeType: 'answer',
    content: answer,
    scopeType: 'project',
    scopeId: projectId,
    channel: 'api',
    sessionId,
    parentEpisodeId: questionEpisode.id,
  });
}

async function getActivityStats() {
  const today = await client.episodes.getToday();

  const stats = {
    questions: today.data.filter(e => e.episodeType === 'question').length,
    answers: today.data.filter(e => e.episodeType === 'answer').length,
    uniqueUsers: new Set(
      today.data
        .filter(e => e.actorType === 'user')
        .map(e => e.actorId)
    ).size,
  };

  console.log(`Today's questions: ${stats.questions}`);
  console.log(`Today's answers: ${stats.answers}`);
  console.log(`Unique users: ${stats.uniqueUsers}`);

  return stats;
}