SDK Python

Aprenda como usar o SDK Python do AI Studio.

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

Requisitos

• python 3.10 ou superior

• chave da API do AI Studio

Instalação

pip install oxylabs-ai-studio

Uso

Rastrear (AiCrawler.crawl)

from oxylabs_ai_studio.apps.ai_crawler import AiCrawler

crawler = AiCrawler(api_key="<API_KEY>")

url = "https://oxylabs.io"
result = crawler.crawl(
    url=url,
    user_prompt="Encontre todas as páginas com preços de produtos proxy",
    output_format="markdown",
    render_javascript=False,
    return_sources_limit=3,
    geo_location="US",
)
print("Resultados:")
for item in result.data:
    print(item, "\n")

Parâmetros de entrada

• url (str): URL inicial para rastrear (obrigatório)

• user_prompt (str): Prompt em linguagem natural para guiar a extração (obrigatório)

• output_format (Literal["json", "markdown"]): Formato de saída (padrão: "markdown")

• schema (dict | None): Esquema OpenAPI para extração estruturada (obrigatório se output_format for "json")

• render_javascript (bool): Renderizar JavaScript (padrão: False)

• return_sources_limit (int): Número máximo de fontes a retornar (padrão: 25)

• geo_location (str): localização do proxy em formato ISO2.

Raspar (AiScraper.scrape)

from oxylabs_ai_studio.apps.ai_scraper import AiScraper

scraper = AiScraper(api_key="<API_KEY>")

schema = scraper.generate_schema(prompt="quer parsear developer, platform, type, price game title, genre (array) and description")
print(f"Esquema gerado: {schema}")

url = "https://sandbox.oxylabs.io/products/3"
result = scraper.scrape(
    url=url,
    output_format="json",
    schema=schema,
    render_javascript=False,
)
print(result)

Parâmetros de entrada

• url (str): URL alvo para raspar (obrigatório)

• output_format (Literal["json", "markdown"]): Formato de saída (padrão: "markdown")

• schema (dict | None): Esquema OpenAPI para extração estruturada (obrigatório se output_format for "json")

• render_javascript (bool): Renderizar JavaScript (padrão: False)

• geo_location (str): localização do proxy em formato ISO2.

Agente de Navegador (BrowserAgent.run)

from oxylabs_ai_studio.apps.browser_agent import BrowserAgent

browser_agent = BrowserAgent(api_key="<API_KEY>")

schema = browser_agent.generate_schema(
    prompt="nome do jogo, plataforma, estrelas de avaliação e preço"
)
print("schema: ", schema)

prompt = "Verifique se existe o jogo 'super mario odyssey' na loja. Se existir, encontre o preço. Use a barra de busca para encontrar o jogo."
url = "https://sandbox.oxylabs.io/"
result = browser_agent.run(
    url=url,
    user_prompt=prompt,
    output_format="json",
    schema=schema,
)
print(result.data)

Parâmetros de entrada

• url (str): URL inicial para navegar (obrigatório)

• user_prompt (str): Prompt em linguagem natural para extração (obrigatório)

• output_format (Literal["json", "markdown", "html", "screenshot"]): Formato de saída (padrão: "markdown")

• schema (dict | None): Esquema OpenAPI para extração estruturada (obrigatório se output_format for "json")

• geo_location (str): localização do proxy em formato ISO2.

Pesquisar (AiSearch.search)

from oxylabs_ai_studio.apps.ai_search import AiSearch


search = AiSearch(api_key="<API_KEY>")

query = "receita de lasanha"
result = search.search(
    query=query,
    limit=5,
    render_javascript=False,
    return_content=True,
)
print(result.data)

Parâmetros de entrada

• query (str): O que buscar (obrigatório)

• limit (int): Número máximo de resultados a retornar (padrão: 10, máximo: 50)

• render_javascript (bool): Renderizar JavaScript (padrão: False)

• return_content (bool): Se deve retornar conteúdos em markdown nos resultados (padrão: True)

• geo_location (str): localização do proxy de busca em formato ISO2.

Mapa (AiMap.map)

from oxylabs_ai_studio.apps.ai_map import AiMap


ai_map = AiMap(api_key="<API_KEY>")
payload = {
    "url": "https://career.oxylabs.io",
    "user_prompt": "páginas de anúncios de emprego",
    "return_sources_limit": 10,
    "geo_location": None,
    "render_javascript": False,
}
result = ai_map.map(**payload)
print(result.data)

Parâmetros de entrada

• url (str): URL inicial para rastrear (obrigatório)

• user_prompt (str): Prompt em linguagem natural para guiar a extração (obrigatório)

• render_javascript (bool): Renderizar JavaScript (padrão: False)

• return_sources_limit (int): Número máximo de fontes a retornar (padrão: 25)

• geo_location (str): localização do proxy em formato ISO2.

Exemplos de uso

Veja o exemplos pasta para exemplos de uso de cada método.

Cada método tem uma versão assíncrona correspondente.