For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDK JavaScript

Aprenda a usar o SDK JavaScript do AI Studio.

Oferecemos um SDK JavaScript para interagir perfeitamente com a API do Oxylabs AI Studio serviços, incluindo AI-Scraper, AI-Crawler, AI-Browser-Agent e outras ferramentas de extração de dados.

Instalação

Instale o SDK:

npm install oxylabs-ai-studio

Adicione OXYLABS_AI_STUDIO_API_URL e OXYLABS_AI_STUDIO_API_KEY valores ao .env arquivo, ou como variáveis de ambiente:

export OXYLABS_AI_STUDIO_API_KEY=your_api_key_here

Uso

AI-Scraper

import { 
  OxylabsAIStudioSDK
} from 'oxylabs-ai-studio';

const sdk = new OxylabsAIStudioSDK({
  apiKey: 'your_api_key_here',
  timeout: 120000,
  retryAttempts: 3,
});

async function testGenerateSchema() {
  try {
    console.log('Testando a geração de schema...');
    const schema = await sdk.aiScraper.generateSchema({
      user_prompt: 'Extraia o título da página'
    });
    console.log('Schema:', schema);
  } catch (error) {
    console.error('Erro na geração de schema:', error.message);
  }
}

testGenerateSchema();

Uso básico

Parâmetros de entrada

  • url (string): A URL de destino a ser processada.

  • user_prompt (string): Instruções sobre quais dados extrair. Isso é usado para gerar automaticamente o openapi_schema ao usar o método scrapeWithAutoSchema .

  • output_format (string): O formato desejado para a saída. Pode ser markdown ou json. O padrão é markdown.

  • render_html (boolean): Especifica se o JavaScript deve ser renderizado na página antes da extração. O padrão é false.

  • openapi_schema (Record<string, any>): Um objeto JSON Schema que define a estrutura dos dados de saída. Isso é necessário quando output_format está definido como json.

  • geo_location (string): Especifica a localização geográfica (formato ISO2) de onde a solicitação deve ser simulada.

AI-Crawler

Uso básico

Parâmetros de entrada

  • url (string): A URL inicial para o crawl.

  • crawl_prompt (string): Instruções que definem os tipos de páginas a encontrar e rastrear.

  • parse_prompt (string): Instruções sobre quais dados extrair das páginas rastreadas. Isso é usado para gerar automaticamente o openapi_schema ao usar o método crawlWithAutoSchema .

  • output_format (string): O formato desejado para a saída. Pode ser markdown ou json. O padrão é markdown.

  • max_pages (integer): O número máximo de páginas ou fontes a retornar. O padrão é 25.

  • render_html (boolean): Especifica se o JavaScript deve ser renderizado nas páginas antes da extração. O padrão é false.

  • openapi_schema (Record<string, any>): Um objeto JSON Schema que define a estrutura dos dados de saída. Isso é necessário quando output_format está definido como json.

  • geo_location (string): Especifica a localização geográfica (formato ISO2) de onde a solicitação deve ser simulada.

Browser-Agent

Uso básico

Parâmetros de entrada

  • url (string): A URL de destino em que o browser agent deve começar.

  • browse_prompt (string): Instruções que definem as ações que o browser agent deve executar.

  • parse_prompt (string): Instruções sobre quais dados extrair após executar as ações do navegador. Isso é usado para gerar automaticamente o openapi_schema ao usar o método browseWithAutoSchema .

  • output_format (string): O formato desejado para a saída. Pode ser markdown, html, json, ou screenshot. O padrão é markdown.

  • render_html (boolean): Especifica se o JavaScript deve ser renderizado na página. Embora seja um browser agent, essa flag pode influenciar certos comportamentos. O padrão é false.

  • openapi_schema (Record<string, any>): Um objeto JSON Schema que define a estrutura dos dados de saída. Isso é necessário quando output_format está definido como json.

  • geo_location (string): Especifica a localização geográfica (formato ISO2) de onde a solicitação deve ser simulada.

Uso básico

Parâmetros de entrada

  • query (string): A consulta de busca.

  • limit (integer): O número máximo de resultados de busca a retornar. Máximo: 50.

  • render_javascript (boolean): Se deve renderizar o JavaScript na página. O padrão é false.

  • return_content (boolean): Se deve retornar o conteúdo em Markdown de cada resultado de busca. O padrão é true.

  • geo_location (string): Especifica a localização geográfica (formato ISO2) de onde a solicitação deve ser simulada.

AI-Map

Uso básico

Parâmetros de entrada

  • url (string): A URL de destino para mapear e extrair dados.

  • user_prompt (string): Instruções sobre quais dados extrair das páginas mapeadas.

  • return_sources_limit (integer): O número máximo de fontes/páginas a retornar do processo de mapeamento.

  • geo_location (string): A localização geográfica a ser usada para a solicitação de mapeamento (por exemplo, 'US', 'UK').

  • render_javascript (boolean): Especifica se o JavaScript deve ser renderizado nas páginas antes do mapeamento. O padrão é false.

Exemplos de uso

Você pode encontrar mais exemplos de cada aplicação aqui:

Atualizado

Isto foi útil?