Ivy.Exa 1.0.3

Ivy.Exa

A .NET SDK for the Exa.ai API - search, research, and web content retrieval.

Created by the team at Ivy - The ultimate framework for creating internal business app in pure C#.

Installation

dotnet add package Ivy.Exa

Quick Start

using Ivy.Exa;
using Ivy.Exa.Models;

// Initialize the client
var client = new ExaClient("your-api-key");

// Or use environment variable EXA_API_KEY
var client = new ExaClient();

// Perform a search
var results = await client.SearchAsync("artificial intelligence companies");

foreach (var result in results.Results)
{
    Console.WriteLine($"{result.Title}: {result.Url}");
}

Features

Search Operations

// Basic search
var searchResults = await client.SearchAsync("machine learning");

// Advanced search with options
var advancedResults = await client.SearchAsync("AI startups", new SearchOptions
{
    NumResults = 20,
    IncludeDomains = new List<string> { "techcrunch.com", "venturebeat.com" },
    Category = "company",
    UserLocation = "US"
});

// Find similar pages
var similarResults = await client.FindSimilarAsync("https://openai.com");

// Get content for specific URLs
var content = await client.GetContentsAsync(
    new List<string> { "https://example.com" },
    new ContentsOptions
    {
        Text = new TextContentsOptions { MaxCharacters = 1000 },
        Summary = new SummaryContentsOptions()
    });

Research Operations

// Create a research task
var taskId = await client.Research.CreateTaskAsync(
    "Research the latest developments in quantum computing");

// Poll for completion
var completedTask = await client.Research.PollTaskAsync(taskId.Id);

// Get task status
var task = await client.Research.GetTaskAsync(taskId.Id);

Console.WriteLine($"Status: {task.Status}");
if (task.Result != null)
{
    Console.WriteLine($"Research Result: {task.Result}");
}

Websets Operations

// Create a webset
var webset = await client.Websets.CreateWebsetAsync(
    "AI Companies",
    "Collection of AI company websites",
    new List<string> { "https://openai.com", "https://anthropic.com" });

// List websets
var websets = await client.Websets.ListWebsetsAsync();

// Get webset details
var websetInfo = await client.Websets.GetWebsetAsync(webset.Id);

// Update webset
var updatedWebset = await client.Websets.UpdateWebsetAsync(
    webset.Id,
    "Updated AI Companies",
    "Updated description");

// Delete webset
await client.Websets.DeleteWebsetAsync(webset.Id);

Configuration

API Key

Set your API key in one of these ways:

1. Constructor parameter:

var client = new ExaClient("your-api-key");

2. Environment variable:

export EXA_API_KEY=your-api-key

var client = new ExaClient(); // Automatically uses EXA_API_KEY

Custom Configuration

var httpClient = new HttpClient();
var client = new ExaClient(
    apiKey: "your-api-key",
    baseUrl: "https://api.exa.ai",
    httpClient: httpClient,
    userAgent: "MyApp/1.0.0");

Models

Search Options

var options = new SearchOptions
{
    Query = "search term",
    NumResults = 10,
    IncludeDomains = new List<string> { "example.com" },
    ExcludeDomains = new List<string> { "spam.com" },
    StartCrawlDate = "2023-01-01",
    EndCrawlDate = "2023-12-31",
    UserLocation = "US",
    Type = "neural", // neural, keyword, hybrid, fast, auto
    Category = "company", // company, research paper, news, etc.
    UseAutoprompt = true,
    Moderation = true
};

Content Options

var contentOptions = new ContentsOptions
{
    Text = new TextContentsOptions 
    { 
        MaxCharacters = 2000,
        IncludeHtml = false 
    },
    Highlights = new HighlightsContentsOptions 
    { 
        NumSentences = 3,
        Threshold = 0.5 
    },
    Summary = new SummaryContentsOptions 
    { 
        Query = "What are the key points?" 
    },
    Livecrawl = LivecrawlOptions.Auto,
    LivecrawlTimeout = 5000
};

Error Handling

try
{
    var results = await client.SearchAsync("test query");
}
catch (HttpRequestException ex)
{
    Console.WriteLine($"API request failed: {ex.Message}");
}
catch (ArgumentException ex)
{
    Console.WriteLine($"Invalid parameters: {ex.Message}");
}

Async and Sync Support

The library provides both async and sync methods:

// Async (recommended)
var results = await client.SearchAsync("query");

// Sync
var results = client.Search("query");

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

License

MIT License. See LICENSE file for details.

Links

• Exa API Documentation
• GitHub Repository
• NuGet Package