Chat

import StudyfetchSDK from '@studyfetch/sdk';

const client = new StudyfetchSDK({
  apiKey: 'your-api-key',
  baseURL: 'https://studyfetchapi.com',
});

const chatComponent = await client.v1.components.create({
  name: 'Biology Study Assistant',
  type: 'chat',
  config: {
    materials: ['mat-123', 'mat-456'],
    folders: ['folder-789'],
    model: 'gpt-4o-mini-2024-07-18',
    systemPrompt: 'You are a helpful biology tutor. Answer questions based on the provided materials.',
    temperature: 0.7,
    maxTokens: 2048,
    enableWebSearch: true,
    enableRAGSearch: true,
    maxSteps: 5,
    enableHistory: false,
    enableVoice: false,
    enableFollowUps: false,
    enableComponentCreation: false,
    enableMessageGrading: false,
    enableReferenceMode: false,
    enableFeedback: true,
    // UI Customization (optional)
    hideTitle: false,
    hideEmptyState: false,
    emptyStateHTML: '<div style="text-align: center; padding: 2rem;"><h3>Welcome to Biology Assistant!</h3><p>Ask me anything about your course materials.</p></div>'
  }
});

console.log('Chat component created:', chatComponent._id);

const chatWithGuardrails = await client.v1.components.create({
  name: 'Math Tutor with Guardrails',
  type: 'chat',
  config: {
    materials: ['mat-789'],
    model: 'gpt-4o-mini-2024-07-18',
    enableFeedback: true,
    enableGuardrails: true,
    guardrailRules: [
      {
        id: 'no-direct-answers',
        action: 'modify',
        condition: 'Response provides direct answers to homework problems without explanation',
        description: 'Guide students to solve problems themselves',
        message: 'Modified to provide guidance instead of direct answers'
      },
      {
        id: 'academic-honesty',
        action: 'warn',
        condition: 'User asks for test or exam answers',
        description: 'Warn about academic integrity',
        message: 'Remember: This tool is for learning, not for completing graded assignments'
      }
    ]
  }
});

const safeChat = await client.v1.components.create({
  name: 'K-12 Science Assistant',
  type: 'chat',
  config: {
    materials: ['mat-science-k12'],
    enableFeedback: true,
    enableGuardrails: true,
    guardrailRules: [
      {
        id: 'no-medical-advice',
        action: 'block',
        condition: 'Response contains medical diagnosis or treatment advice',
        description: 'Prevent medical advice',
        message: 'I cannot provide medical advice. Please consult a healthcare professional.'
      },
      {
        id: 'age-appropriate',
        action: 'modify',
        condition: 'Response contains content not suitable for K-12 students',
        description: 'Ensure age-appropriate content',
        message: 'Content adjusted for educational purposes'
      },
      {
        id: 'no-dangerous-experiments',
        action: 'block',
        condition: 'Response describes dangerous chemical reactions or experiments',
        description: 'Prevent dangerous activities',
        message: 'For safety reasons, I cannot provide instructions for this type of experiment.'
      }
    ]
  }
});

const embedResponse = await client.v1.components.generateEmbed(chatComponent._id, {
  // User tracking
  userId: 'user-456',
  studentName: 'Jane Smith',  // Student name for display
  groupIds: ['class-101', 'class-102'],
  sessionId: 'session-789',
  
  // Chat-specific features
  features: {
    enableWebSearch: true,
    enableHistory: true,
    enableVoice: true,
    enableFollowUps: true,
    enableComponentCreation: false,
    placeholderText: 'Ask me anything about biology...',
    enableWebSearchSources: true,
    enableImageSources: true,
    enableBadWordsFilter: true,
    enablePromptingScore: true,
    enableResponsibilityScore: true,
    enableReferenceMode: false,
    enableGuardrails: true,
    enableOutline: false,
    enableTranscript: false
  },
  
  // Dimensions
  width: '100%',
  height: '600px',
  
  // Token expiry
  expiryHours: 24
});

// AI SDK format with messages array
const streamResponse = await client.v1.chat.stream({
  componentId: 'comp_123abc',
  sessionId: 'session-789',
  userId: 'user-456',
  groupIds: ['class-101', 'class-102'],
  messages: [
    { role: 'system', content: 'You are a helpful biology tutor.' },
    { role: 'user', content: 'Explain photosynthesis in simple terms' }
  ]
});

// Process the stream
for await (const chunk of streamResponse) {
  console.log(chunk.content);
}

// Custom format with single message
const customStream = await client.v1.chat.stream({
  componentId: 'comp_123abc',
  sessionId: 'session-789',
  userId: 'user-456',
  message: {
    text: 'What is cellular respiration?',
    images: [
      {
        url: 'https://example.com/cell-diagram.png',
        caption: 'Cell structure diagram',
        mimeType: 'image/png'
      }
    ]
  }
});

// React example with streaming
function ChatInterface({ componentId }) {
  const [messages, setMessages] = useState([]);
  const [streaming, setStreaming] = useState(false);

  const sendMessage = async (text) => {
    setStreaming(true);
    const userMessage = { role: 'user', content: text };
    setMessages(prev => [...prev, userMessage]);

    const assistantMessage = { role: 'assistant', content: '' };
    setMessages(prev => [...prev, assistantMessage]);

    try {
      const stream = await client.v1.chat.stream({
        componentId,
        sessionId: sessionStorage.getItem('chatSession'),
        messages: [...messages, userMessage]
      });

      for await (const chunk of stream) {
        if (chunk.type === 'content') {
          setMessages(prev => {
            const updated = [...prev];
            updated[updated.length - 1].content += chunk.content;
            return updated;
          });
        }
      }
    } finally {
      setStreaming(false);
    }
  };

  return (
    <div>
      {messages.map((msg, i) => (
        <div key={i} className={msg.role}>
          {msg.content}
        </div>
      ))}
      <input 
        onSubmit={(e) => sendMessage(e.target.value)}
        disabled={streaming}
      />
    </div>
  );
}

import StudyfetchSDK from '@studyfetch/sdk';

const client = new StudyfetchSDK({
  apiKey: 'your-api-key',
  baseURL: 'https://studyfetchapi.com',
});

// Push context to a specific embed
await client.v1.embed.context.push({
  token: 'embed-token-123',
  context: 'The user is now on Question 2 which discusses cellular respiration and the Krebs cycle.'
});

// Retrieve current context
const currentContext = await client.v1.embed.context.retrieve({
  token: 'embed-token-123'
});

console.log('Current context:', currentContext);

// Clear all context
await client.v1.embed.context.clear({
  token: 'embed-token-123'
});

class PracticeTestChat {
  constructor(client, embedToken) {
    this.client = client;
    this.embedToken = embedToken;
    this.currentQuestion = 0;
  }

  async navigateToQuestion(questionNumber, questionData) {
    // Clear previous context
    await this.client.v1.embed.context.clear({
      token: this.embedToken
    });

    // Push new context for current question
    const contextText = `The user is now on Question ${questionNumber}: ${questionData.title}. 
Topic: ${questionData.topic}
Content: ${questionData.content}`;

    await this.client.v1.embed.context.push({
      token: this.embedToken,
      context: contextText
    });

    this.currentQuestion = questionNumber;
  }

  async addSupplementalContext(additionalInfo) {
    // Add more context without clearing previous
    await this.client.v1.embed.context.push({
      token: this.embedToken,
      context: `Additional information: ${additionalInfo}`
    });
  }
}

// Usage
const chat = new PracticeTestChat(client, 'embed-token-123');

// User navigates to question 1
await chat.navigateToQuestion(1, {
  title: 'Photosynthesis Process',
  topic: 'Biology - Cellular Processes',
  content: 'Explain the light-dependent reactions of photosynthesis...'
});

// User moves to question 2
await chat.navigateToQuestion(2, {
  title: 'Cellular Respiration',
  topic: 'Biology - Cellular Processes',
  content: 'Describe the steps of the Krebs cycle...'
});

import StudyfetchSDK from '@studyfetch/sdk';

const client = new StudyfetchSDK({
  apiKey: 'your-api-key',
  baseURL: 'https://studyfetchapi.com',
});

// Retrieve all feedback
await client.v1.chat.retrieveFeedback();

// Filter feedback by component
await client.v1.chat.retrieveFeedback({
  componentId: 'comp_123abc',
  startDate: '2025-01-01T00:00:00Z',
  endDate: '2025-12-31T23:59:59Z',
  feedbackType: 'thumbsUp',
  limit: '100',
  skip: '0'
});

import StudyfetchSDK from '@studyfetch/sdk';

const client = new StudyfetchSDK({
  apiKey: 'your-api-key',
  baseURL: 'https://studyfetchapi.com',
});

// Retrieve feedback context for a specific feedback ID
await client.v1.chat.retrieveFeedbackContext({
  feedbackId: 'feedback_123abc'
});