# Gerando instruções de parsing via API

Você pode gerar conjuntos de instruções de parsing via API fornecendo URLs e descrevendo quais pontos de dados você gostaria de fazer parse. Ao receber as instruções de parsing geradas, você pode salvá-las como um [preset do parser](/products/pt-br/web-scraper-api/features/custom-parser/parser-presets.md) ou simplesmente enviar as instruções com sua solicitação de scraping.

Você também pode gerar instruções de parsing via [OxyCopilot](/products/pt-br/web-scraper-api/web-scraper-api-playground/oxycopilot.md) em nosso Playground do Web Scraper API.

## Gerar instruções a partir de prompt

Você pode gerar instruções de parsing inserindo uma descrição em texto livre dos pontos de dados que você gostaria de fazer parse e nos fornecendo algumas URLs que pertençam ao mesmo tipo de página. A API responderá com um conjunto de instruções de parsing.

* **Endpoint**: `https://data.oxylabs.io/v1/parsers/generate-instructions/prompt`
* **Método**: `POST`
* **Autenticação**: `Básico`
* **Cabeçalhos da solicitação**: `Content-Type: application/json`

### Payload de exemplo

```json
{ 
  "prompt_text": "Faça o parse do título do produto, preço principal, nome do desenvolvedor e nome da plataforma.",
  "urls": [
    "https://sandbox.oxylabs.io/products/1",
    "https://sandbox.oxylabs.io/products/2",
    "https://sandbox.oxylabs.io/products/4"
  ],
  "render": false
}
```

<table><thead><tr><th width="177.1328125">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><mark style="color:padrão;background-color:green;"><strong><code>prompt_text</code></strong></mark></td><td>Descrição em texto livre dos pontos de dados a serem extraídos.</td></tr><tr><td><mark style="color:padrão;background-color:green;"><strong><code>urls</code></strong></mark></td><td>Lista de URLs que exemplificam o tipo de página para o qual você gostaria de obter instruções de parsing. Recomendamos fornecer de 3 a 5 URLs para ajudar o parser a se adaptar a diferentes layouts e melhorar a precisão do parsing.</td></tr><tr><td><code>render</code></td><td>Se a renderização de JS deve ou não ser usada para buscar o conteúdo necessário. </td></tr></tbody></table>

&#x20;    \- parâmetro obrigatório

### Resposta de exemplo

```json
{
    "parsing_instructions": {
        "developer_name": {
            "_fns": [
                {
                    "_args": [
                        "//div[contains(@class, 'brand-wrapper')]//span[@class='brand developer']"
                    ],
                    "_fn": "xpath"
                },
                {
                    "_args": [
                        "normalize-space(.)"
                    ],
                    "_fn": "xpath"
                },
                {
                    "_args": " ",
                    "_fn": "join"
                }
            ]
        },
        "main_price": {
            "_fns": [
                {
                    "_args": [
                        "//div[contains(@class, 'product-info-wrapper')]//div[contains(@class, 'price')]/text()"
                    ],
                    "_fn": "xpath_one"
                },
                {
                    "_fn": "amount_from_string"
                }
            ]
        },
        "title": {
            "_fns": [
                {
                    "_args": [
                        "//div[contains(@class, 'product-info-wrapper')]//h2/text()"
                    ],
                    "_fn": "xpath_one"
                },
                {
                    "_args": [
                        "^\\s*(.[\\s\\S]*?)\\s*$",
                        1
                    ],
                    "_fn": "regex_search"
                }
            ]
        }
    },
    "prompt_schema": {
        "properties": {
            "developer_name": {
                "description": "Nome do desenvolvedor.",
                "title": "Nome do Desenvolvedor",
                "type": "string"
            },
            "main_price": {
                "description": "Preço principal do produto.",
                "title": "Preço Principal",
                "type": "number"
            },
            "platform_name": {
                "description": "Nome da plataforma.",
                "title": "Nome da Plataforma",
                "type": "string"
            },
            "title": {
                "description": "Título do produto.",
                "title": "Título",
                "type": "string"
            }
        },
        "required": [
            "title",
            "main_price",
            "developer_name",
            "platform_name"
        ],
        "title": "Campos",
        "type": "object"
    }
}
```

## Gerar instruções a partir de schema JSON

Há casos em que você quer obter dados extraídos em um schema JSON específico. Você pode usar este endpoint para obter instruções de parsing que sigam estritamente o schema que você fornecer.

* **Endpoint**:  `https://data.oxylabs.io/v1/parsers/generate-instructions/schema`
* **Método**: `POST`
* **Autenticação**: `Básico`
* **Cabeçalhos da solicitação**: `Content-Type: application/json`

### Payload de exemplo

```json
{
  "urls": [
    "https://oxylabs.io",
    "https://example.com",
    "https://bbc.co.uk"
  ],
  "prompt_schema": {
    "properties": {
      "links": {
        "description": "Um array de strings de URL",
        "type": "array",
        "items": {
          "type": "string",
          "description": "Uma URL"
        }
      }
    },
    "required": [
      "links"
    ]
  },
  "render": false
}
```

<table><thead><tr><th width="177.1328125">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><mark style="color:padrão;background-color:green;"><strong><code>prompt_schema</code></strong></mark></td><td><a href="https://json-schema.org/">schema JSON</a> descrevendo a saída necessária do parser.</td></tr><tr><td><mark style="color:padrão;background-color:green;"><strong><code>urls</code></strong></mark></td><td>Lista de URLs que exemplificam o tipo de página para o qual você gostaria de obter instruções de parsing.</td></tr><tr><td><code>render</code></td><td>Se a renderização de JS deve ou não ser usada para buscar o conteúdo necessário. </td></tr></tbody></table>

&#x20;    \- parâmetro obrigatório

### Resposta de exemplo

```json
{
    "parsing_instructions": {
            "links": {
                "_fns": [
                    {
                        "_args": [
                            "//a[@href and normalize-space(@href) != '']/@href"
                        ],
                        "_fn": "xpath"
                    }
                ]
            }
        }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.oxylabs.io/products/pt-br/web-scraper-api/features/custom-parser/generating-parsing-instructions-via-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.