Vai al contenuto principale
Pacchetto NPM: olostep

​
Iniziare

npm install olostep

import Olostep from 'olostep';

const client = new Olostep({apiKey: process.env.OLOSTEP_API_KEY});

// Esempio minimo di scraping
const result = await client.scrapes.create('https://example.com');
console.log(result.id, result.html_content);
L’SDK NodeJS accetta sia camelCase che snake_case per tutti i parametri. Usa snake_case se stai sviluppando per agenti AI, corrisponde ai nomi dei campi nativi dell’API.

​
Utilizzo

​
Scraping

Esegui lo scraping di un singolo URL con varie opzioni: 
import Olostep, {Format} from 'olostep';

const client = new Olostep({apiKey: 'your_api_key'});

// Scraping semplice
const scrape = await client.scrapes.create('https://example.com');

// Con più formati
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: [Format.HTML, Format.MARKDOWN, Format.TEXT],
  waitBeforeScraping: 1000,
  removeImages: true
});

// Accedi al contenuto
console.log(scrape.html_content);
console.log(scrape.markdown_content);

// Ottieni scraping per ID
const fetched = await client.scrapes.get(scrape.id);

​
Elaborazione in batch

Elabora più URL in un unico batch: 
// Utilizzando stringhe URL (ID personalizzati generati automaticamente)
const batch = await client.batches.create([
  'https://example.com',
  'https://example.org',
  'https://example.net'
]);

// Oppure con ID personalizzati espliciti
const batch = await client.batches.create([
  {url: 'https://example.com', customId: 'site-1'},
  {url: 'https://example.org', customId: 'site-2'}
]);

console.log(`Batch ${batch.id} creato con ${batch.total_urls} URL`);

// Attendi il completamento
await batch.waitTillDone({
  checkEveryNSecs: 5,
  timeoutSeconds: 120
});

// Ottieni informazioni sul batch
const info = await batch.info();
console.log(info);

// Stream dei risultati individuali
for await (const item of batch.items()) {
  console.log(item.custom_id);
}

​
Crawling

Esegui il crawling di un intero sito web: 
const crawl = await client.crawls.create({
  url: 'https://example.com',
  maxPages: 100,
  maxDepth: 3,
  includeUrls: ['*/blog/*'],
  excludeUrls: ['*/admin/*']
});

console.log(`Crawl ${crawl.id} avviato`);

// Attendi il completamento
await crawl.waitTillDone({
  checkEveryNSecs: 10,
  timeoutSeconds: 300
});

// Ottieni informazioni sul crawl
const info = await crawl.info();
console.log(`Crawled ${info.pages_crawled} pagine`);

// Stream delle pagine esaminate
for await (const page of crawl.pages()) {
  console.log(page.url, page.status_code);
}

​
Mappatura del sito

Genera una sitemap degli URL da un sito web: 
const map = await client.maps.create({
  url: 'https://example.com',
  topN: 100,
  includeSubdomain: true,
  searchQuery: 'blog posts'
});

console.log(`Mappa ${map.id} creata`);

// Stream degli URL
for await (const url of map.urls()) {
  console.log(url);
}

// Ottieni informazioni sulla mappa
const info = await map.info();

​
Risposte potenziate dall’AI

Ottieni risposte dalle pagine web utilizzando l’AI: 
import Olostep from 'olostep';

const client = new Olostep({apiKey: 'your_api_key'});

// Compito semplice: passa una stringa direttamente
const answer = await client.answers.create(
  'Qual è l'argomento principale di https://example.com?'
);
console.log(answer.answer);
console.log(answer.sources);

// Con output JSON strutturato
const structured = await client.answers.create({
  task: 'Estrai tutti i nomi dei prodotti e i prezzi da https://example.com',
  jsonFormat: {
    products: [{name: '', price: ''}]
  }
});
console.log(structured.json_content);

// Recupera una risposta precedentemente creata tramite ID
const fetched = await client.answers.get(answer.id);
console.log(fetched.answer);

​
Recupero del contenuto

Recupera il contenuto precedentemente estratto: 
// Ottieni contenuto in formato specifico
const content = await client.retrieve(retrieveId, Format.MARKDOWN);
console.log(content.markdown_content);

// Più formati
const content = await client.retrieve(retrieveId, [
  Format.HTML,
  Format.MARKDOWN
]);

​
Opzioni avanzate

​
Azioni personalizzate

Esegui azioni del browser prima dello scraping: 
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  actions: [
    {type: 'wait', milliseconds: 2000},
    {type: 'click', selector: '#load-more'},
    {type: 'scroll', distance: 1000},
    {type: 'fill_input', selector: '#search', value: 'query'}
  ]
});

​
Posizione geografica

Esegui lo scraping da diversi paesi utilizzando codici paese predefiniti o qualsiasi stringa di codice paese valida: 
import Olostep, {Country} from 'olostep';

const client = new Olostep({apiKey: 'your_api_key'});

// Utilizzando valori enum predefiniti (US, DE, FR, GB, SG)
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  country: Country.DE  // Germania
});

// Oppure usa qualsiasi codice paese valido come stringa
const scrape2 = await client.scrapes.create({
  url: 'https://example.com',
  country: 'jp'  // Giappone
});

​
Estrazione LLM

Estrai dati strutturati utilizzando LLM: 
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  llmExtract: {
    schema: {
      title: 'string',
      price: 'number',
      description: 'string'
    },
    prompt: 'Estrai informazioni sui prodotti da questa pagina'
  }
});

​
Configurazione del client

import Olostep from 'olostep';

const client = new Olostep({
  apiKey: 'your_api_key',
  apiBaseUrl: 'https://api.olostep.com/v1',  // opzionale
  timeoutMs: 150000,  // 150 secondi (opzionale)
  retry: {
    maxRetries: 3,
    initialDelayMs: 1000
  },
  userAgent: 'MyApp/1.0'  // opzionale
});

​
Caratteristiche principali

  • Client asincrono con supporto completo per TypeScript.
  • Input sicuri grazie a enum e interfacce TypeScript (Formati, Paesi, Azioni, ecc.).
  • Namespace delle risorse ricchi con chiamate abbreviate (client.scrapes.create()) e metodi espliciti (client.scrapes.get()).
  • Livello di trasporto condiviso con retry, timeout e decodifica JSON.
  • Gerarchia completa degli errori