mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 06:08:15 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
236 lines
7.3 KiB
Plaintext
236 lines
7.3 KiB
Plaintext
---
|
|
title: Oxylabs Scrapers
|
|
description: >
|
|
Os Scrapers da Oxylabs permitem acessar facilmente informações de fontes específicas. Veja abaixo a lista de fontes disponíveis:
|
|
- `Amazon Product`
|
|
- `Amazon Search`
|
|
- `Google Seach`
|
|
- `Universal`
|
|
icon: globe
|
|
mode: "wide"
|
|
---
|
|
|
|
## Instalação
|
|
|
|
Obtenha as credenciais criando uma conta na Oxylabs [aqui](https://oxylabs.io).
|
|
```shell
|
|
pip install 'crewai[tools]' oxylabs
|
|
```
|
|
Confira a [Documentação da Oxylabs](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/targets) para mais informações sobre os parâmetros da API.
|
|
|
|
# `OxylabsAmazonProductScraperTool`
|
|
|
|
### Exemplo
|
|
|
|
```python
|
|
from crewai_tools import OxylabsAmazonProductScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsAmazonProductScraperTool()
|
|
|
|
result = tool.run(query="AAAAABBBBCC")
|
|
|
|
print(result)
|
|
```
|
|
|
|
### Parâmetros
|
|
|
|
- `query` - código ASIN de 10 caracteres.
|
|
- `domain` - domínio de localização da Amazon.
|
|
- `geo_location` - local de entrega (_Deliver to_).
|
|
- `user_agent_type` - tipo de dispositivo e navegador.
|
|
- `render` - ativa o renderizador JavaScript ao definir como `html`.
|
|
- `callback_url` - URL do seu endpoint de callback.
|
|
- `context` - Configurações avançadas adicionais e controles para requisitos especializados.
|
|
- `parse` - retorna os dados já processados quando definido como true.
|
|
- `parsing_instructions` - defina sua própria lógica de parsing e transformação de dados que será executada no resultado de scraping HTML.
|
|
|
|
### Exemplo avançado
|
|
|
|
```python
|
|
from crewai_tools import OxylabsAmazonProductScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsAmazonProductScraperTool(
|
|
config={
|
|
"domain": "com",
|
|
"parse": True,
|
|
"context": [
|
|
{
|
|
"key": "autoselect_variant",
|
|
"value": True
|
|
}
|
|
]
|
|
}
|
|
)
|
|
|
|
result = tool.run(query="AAAAABBBBCC")
|
|
|
|
print(result)
|
|
```
|
|
|
|
# `OxylabsAmazonSearchScraperTool`
|
|
|
|
### Exemplo
|
|
|
|
```python
|
|
from crewai_tools import OxylabsAmazonSearchScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsAmazonSearchScraperTool()
|
|
|
|
result = tool.run(query="headsets")
|
|
|
|
print(result)
|
|
```
|
|
|
|
### Parâmetros
|
|
|
|
- `query` - termo de busca da Amazon.
|
|
- `domain` - Domínio de localização para Bestbuy.
|
|
- `start_page` - número da página inicial.
|
|
- `pages` - quantidade de páginas a ser recuperada.
|
|
- `geo_location` - local de entrega (_Deliver to_).
|
|
- `user_agent_type` - tipo de dispositivo e navegador.
|
|
- `render` - ativa o renderizador JavaScript ao definir como `html`.
|
|
- `callback_url` - URL do seu endpoint de callback.
|
|
- `context` - Configurações avançadas adicionais e controles para requisitos especializados.
|
|
- `parse` - retorna os dados já processados quando definido como true.
|
|
- `parsing_instructions` - defina sua própria lógica de parsing e transformação de dados que será executada no resultado de scraping HTML.
|
|
|
|
### Exemplo avançado
|
|
|
|
```python
|
|
from crewai_tools import OxylabsAmazonSearchScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsAmazonSearchScraperTool(
|
|
config={
|
|
"domain": 'nl',
|
|
"start_page": 2,
|
|
"pages": 2,
|
|
"parse": True,
|
|
"context": [
|
|
{'key': 'category_id', 'value': 16391693031}
|
|
],
|
|
}
|
|
)
|
|
|
|
result = tool.run(query='nirvana tshirt')
|
|
|
|
print(result)
|
|
```
|
|
|
|
# `OxylabsGoogleSearchScraperTool`
|
|
|
|
### Exemplo
|
|
|
|
```python
|
|
from crewai_tools import OxylabsGoogleSearchScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsGoogleSearchScraperTool()
|
|
|
|
result = tool.run(query="iPhone 16")
|
|
|
|
print(result)
|
|
```
|
|
|
|
### Parâmetros
|
|
|
|
- `query` - palavra-chave de busca.
|
|
- `domain` - domínio de localização do Google.
|
|
- `start_page` - número da página inicial.
|
|
- `pages` - número de páginas a ser recuperado.
|
|
- `limit` - quantidade de resultados a ser recuperada em cada página.
|
|
- `locale` - valor do header `Accept-Language`, que altera o idioma da interface da página de pesquisa do Google.
|
|
- `geo_location` - a localização geográfica para a qual o resultado deve ser adaptado. Usar este parâmetro corretamente é extremamente importante para obter os dados corretos.
|
|
- `user_agent_type` - tipo de dispositivo e navegador.
|
|
- `render` - ativa o renderizador JavaScript ao definir como `html`.
|
|
- `callback_url` - URL do seu endpoint de callback.
|
|
- `context` - Configurações avançadas adicionais e controles para requisitos especializados.
|
|
- `parse` - retorna os dados já processados quando definido como true.
|
|
- `parsing_instructions` - defina sua própria lógica de parsing e transformação de dados que será executada no resultado de scraping HTML.
|
|
|
|
### Exemplo avançado
|
|
|
|
```python
|
|
from crewai_tools import OxylabsGoogleSearchScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsGoogleSearchScraperTool(
|
|
config={
|
|
"parse": True,
|
|
"geo_location": "Paris, France",
|
|
"user_agent_type": "tablet",
|
|
}
|
|
)
|
|
|
|
result = tool.run(query="iPhone 16")
|
|
|
|
print(result)
|
|
```
|
|
|
|
# `OxylabsUniversalScraperTool`
|
|
|
|
### Exemplo
|
|
|
|
```python
|
|
from crewai_tools import OxylabsUniversalScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsUniversalScraperTool()
|
|
|
|
result = tool.run(url="https://ip.oxylabs.io")
|
|
|
|
print(result)
|
|
```
|
|
|
|
### Parâmetros
|
|
|
|
- `url` - URL do site a ser raspada.
|
|
- `user_agent_type` - tipo de dispositivo e navegador.
|
|
- `geo_location` - define a geolocalização do proxy para coletar os dados.
|
|
- `render` - ativa o renderizador JavaScript ao definir como `html`.
|
|
- `callback_url` - URL do seu endpoint de callback.
|
|
- `context` - Configurações avançadas adicionais e controles para requisitos especializados.
|
|
- `parse` - retorna os dados já processados quando definido como `true`, desde que exista um parser dedicado para o tipo de página da URL fornecida.
|
|
- `parsing_instructions` - defina sua própria lógica de parsing e transformação de dados que será executada no resultado de scraping HTML.
|
|
|
|
### Exemplo avançado
|
|
|
|
```python
|
|
from crewai_tools import OxylabsUniversalScraperTool
|
|
|
|
# certifique-se de que as variáveis OXYLABS_USERNAME e OXYLABS_PASSWORD estejam definidas
|
|
tool = OxylabsUniversalScraperTool(
|
|
config={
|
|
"render": "html",
|
|
"user_agent_type": "mobile",
|
|
"context": [
|
|
{"key": "force_headers", "value": True},
|
|
{"key": "force_cookies", "value": True},
|
|
{
|
|
"key": "headers",
|
|
"value": {
|
|
"Custom-Header-Name": "custom header content",
|
|
},
|
|
},
|
|
{
|
|
"key": "cookies",
|
|
"value": [
|
|
{"key": "NID", "value": "1234567890"},
|
|
{"key": "1P JAR", "value": "0987654321"},
|
|
],
|
|
},
|
|
{"key": "http_method", "value": "get"},
|
|
{"key": "follow_redirects", "value": True},
|
|
{"key": "successful_status_codes", "value": [808, 909]},
|
|
],
|
|
}
|
|
)
|
|
|
|
result = tool.run(url="https://ip.oxylabs.io")
|
|
|
|
print(result)
|
|
``` |