Code Examples & Best Practices

import { HyperleapClient } from '@hyperleapai/sdk';

const client = new HyperleapClient({
  apiKey: process.env.HYPERLEAP_API_KEY
});

// Run a prompt with dynamic replacements
const result = await client.runPrompt({
  promptId: 'prompt_email_writer',
  promptVersionId: 'version_latest',
  replacements: {
    tone: 'professional',
    topic: 'quarterly performance review',
    audience: 'executive team'
  }
});

console.log('Generated email:', result.message);

// Collect feedback on the result
await client.setPromptRunScore(result.promptRunId, {
  score: 5,
  feedback: 'Clear and concise',
  labels: ['accurate', 'professional']
});

from hyperleap import Hyperleap
import os

client = Hyperleap(api_key=os.environ["HYPERLEAP_API_KEY"])

# Upload a PDF knowledge source
with open("product_catalog.pdf", "rb") as f:
    source = client.sources.create(
        file=f,
        name="Product Catalog 2025",
        description="Complete product documentation",
        metadata={
            "version": "2.0",
            "department": "sales",
            "last_updated": "2025-01-15"
        }
    )

print(f"Source ID: {source.id}")
print(f"Processing status: {source.status}")
print(f"Chunks created: {source.chunk_count}")

# Wait for processing
while source.status == "processing":
    time.sleep(2)
    source = client.sources.get(source.id)

# Attach to agent
agent = client.agents.update(
    agent_id="agent_abc123",
    sources=[source.id, "doc_existing_faq"]
)

print("Knowledge source attached successfully!")

import { HyperleapClient } from '@hyperleapai/sdk';

const client = new HyperleapClient({
  apiKey: process.env.HYPERLEAP_API_KEY
});

async function chatWithPersona() {
  // Create a persona conversation
  const conversation = await client.createPersonaConversation({
    personaId: 'persona_support_agent',
    personaVersionId: 'version_v1',
    replacements: {
      company_name: 'Acme Inc',
      support_tier: 'premium'
    }
  });

  console.log('Conversation started:', conversation.id);

  // Send a message
  const response = await client.continueConversation(conversation.id, {
    message: 'I need help resetting my password'
  });

  console.log('AI Response:', response.message);

  // Continue the conversation with context
  const followUp = await client.continueConversation(conversation.id, {
    message: 'What email should I use?'
  });

  console.log('Follow-up:', followUp.message);

  // Score the conversation quality
  await client.setConversationScore(conversation.id, {
    score: 5,
    feedback: 'Very helpful and clear',
    labels: ['helpful', 'professional']
  });
}

chatWithPersona();

from hyperleap import Hyperleap
import os

client = Hyperleap(api_key=os.environ["HYPERLEAP_API_KEY"])

# Set up automation workflow
workflow = client.workflows.create(
    name="Lead Capture & Scoring",
    trigger="conversation.lead_captured",
    actions=[
        {
            "type": "data.process_lead",
            "config": {
                "format": "json",
                "validate_phone": True
            },
            "field_mapping": {
                "firstname": "{{lead.first_name}}",
                "lastname": "{{lead.last_name}}",
                "email": "{{lead.email}}",
                "phone": "{{lead.phone}}",
                "lead_source": "Hyperleap Chatbot",
                "lead_score": "{{lead.qualification_score}}",
                "notes": "{{conversation.summary}}"
            }
        },
        {
            "type": "notification.email",
            "to": "sales-team@company.com",
            "subject": "Hot Lead: {{lead.name}} (Score: {{lead.qualification_score}})",
            "template": "new_lead_notification",
            "conditions": {
                "if": "{{lead.qualification_score}} > 70"
            }
        }
    ]
)

print(f"Workflow created: {workflow.id}")

import { HyperleapClient } from '@hyperleapai/sdk';

const client = new HyperleapClient({
  apiKey: process.env.HYPERLEAP_API_KEY
});

async function streamPrompt() {
  // Stream a long-form prompt response
  await client.runPromptSSE(
    {
      promptId: 'prompt_article_writer',
      promptVersionId: 'version_002',
      replacements: {
        topic: 'The Future of AI in Healthcare',
        word_count: '500',
        style: 'informative and accessible'
      }
    },
    (event) => {
      if (event.type === 'chunk') {
        // Display content in real-time
        process.stdout.write(event.content);
      } else if (event.type === 'done') {
        console.log('\n✓ Article complete!');
      } else if (event.type === 'error') {
        console.error('Error:', event.error);
      }
    }
  );
}

streamPrompt();

import { HyperleapClient } from '@hyperleapai/sdk';

const client = new HyperleapClient({
  apiKey: process.env.HYPERLEAP_API_KEY
});

async function streamConversation() {
  // Create persona conversation
  const conversation = await client.createPersonaConversation({
    personaId: 'persona_creative_writer',
    personaVersionId: 'version_001',
    replacements: {
      genre: 'science fiction',
      style: 'descriptive and immersive'
    }
  });

  console.log('Conversation ID:', conversation.id);

  // Stream the persona's response
  await client.continueConversationSSE(
    conversation.id,
    {
      message: 'Write the opening paragraph about first contact with aliens'
    },
    (event) => {
      if (event.type === 'chunk') {
        process.stdout.write(event.content);
      } else if (event.type === 'done') {
        console.log('\n✓ Response complete!');
      }
    }
  );

  // Score the message quality
  await client.setMessageScore({
    conversationId: conversation.id,
    messageId: event.messageId,
    score: 5,
    feedback: 'Very creative and engaging'
  });
}

streamConversation();