> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/api-targets/es/search-engines/bing/search.md).

# Búsqueda

Extrae resultados de Bing Search con datos analizados para anuncios pagados y listados orgánicos, con soporte para segmentación por geolocalización, localización por dominio y paginación.

La `bing_search` la fuente está diseñada para recuperar páginas de resultados de Bing Search (SERPs).

{% hint style="info" %}
Para extraer **resultados de búsqueda generados por IA** de Bing, use el `render` parámetro.
{% endhint %}

## Ejemplos de solicitud

En el ejemplo siguiente, hacemos una solicitud para recuperar resultados de búsqueda de Bing para el término de búsqueda `adidas`. La búsqueda comenzará en la página 11 y recuperará 10 páginas de resultados, que se entregarán en un formato estructurado.

{% tabs %}
{% tab title="cURL" %}

```shell
curl 'https://realtime.oxylabs.io/v1/queries' \\
--user 'USERNAME:PASSWORD' \\
-H 'Content-Type: application/json' \\
-d '{
        "source": "bing_search",
        "domain": "com",
        "query": "adidas",
        "start_page": 11,
        "pages": 10,
        "callback_url": "https://your.callback.url",
        "parse": true
    }'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
from pprint import pprint

# Estructura del payload.
payload = {
    'source': 'bing_search',
    'domain': 'com',
    'query': 'adidas',
    'start_page': 11,
    'pages': 10,
    'callback_url': 'https://your.callback.url',
    'parse': True
}

# Obtener respuesta.
response = requests.request(
    'POST',
    'https://realtime.oxylabs.io/v1/queries',
    auth=('USERNAME', 'PASSWORD'),
    json=payload,
)

# Print prettified response to stdout.
pprint(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const https = require("https");

const username = "USERNAME";
const password = "PASSWORD";
const body = {
    source: "bing_search",
    domain: "com",
    query: "adidas",
    start_page: 11,
    pages: 10,
    callback_url: "https://your.callback.url",
    parse: true,
};

const options = {
    hostname: "realtime.oxylabs.io",
    path: "/v1/queries",
    method: "POST",
    headers: {
        "Content-Type": "application/json",
        Authorization:
            "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
    },
};

const request = https.request(options, (response) => {
    let data = "";

    response.on("data", (chunk) => {
        data += chunk;
    });

    response.on("end", () => {
        const responseData = JSON.parse(data);
        console.log(JSON.stringify(responseData, null, 2));
    });
});

request.on("error", (error) => {
    console.error("Error:", error);
});

request.write(JSON.stringify(body));
request.end();
```

{% endtab %}

{% tab title="HTTP" %}

```http
https://realtime.oxylabs.io/v1/queries?source=bing_search&domain=com&query=adidas&start_page=11&pages=10&parse=true&access_token=12345abcdep
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$params = array(
    'source' => 'bing_search',
    'domain' => 'com',
    'query' => 'adidas',
    'start_page' => 11,
    'pages' => 10,
    'callback_url' => 'https://your.callback.url',
    'parse' => true
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD");

$headers = array();
$headers[] = "Content-Type: application/json";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
echo $result;

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);
```

{% endtab %}

{% tab title="Golang" %}

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	const Username = "USERNAME"
	const Password = "PASSWORD"

	payload := map[string]interface{}{
		"source":       "bing_search",
		"domain":       "com",
		"query":        "adidas",
		"start_page":   11,
		"pages":        10,
		"callback_url": "https://your.callback.url",
		"parse":        true,
	}

	jsonValue, _ := json.Marshal(payload)

	client := &http.Client{}
	request, _ := http.NewRequest("POST",
		"https://realtime.oxylabs.io/v1/queries",
		bytes.NewBuffer(jsonValue),
	)

	request.SetBasicAuth(Username, Password)
	response, _ := client.Do(request)

	responseText, _ := ioutil.ReadAll(response.Body)
	fmt.Println(string(responseText))
}
```

{% endtab %}

{% tab title="C#" %}

```csharp
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using System.Threading.Tasks;

namespace OxyApi
{
    class Program
    {
        static async Task Main()
        {
            const string Username = "USERNAME";
            const string Password = "PASSWORD";

            var parameters = new {
                source = "bing_search",
                domain = "com",
                query = "adidas",
                start_page = 11,
                pages = 10,
                callback_url = "https://your.callback.url",
                parse = true
            };

            var client = new HttpClient();

            Uri baseUri = new Uri("https://realtime.oxylabs.io");
            client.BaseAddress = baseUri;

            var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries");
            requestMessage.Content = JsonContent.Create(parameters);

            var authenticationString = $"{Username}:{Password}";
            var base64EncodedAuthenticationString = Convert.ToBase64String(System.Text.ASCIIEncoding.UTF8.GetBytes(authenticationString));
            requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString);

            var response = await client.SendAsync(requestMessage);
            var contents = await response.Content.ReadAsStringAsync();

            Console.WriteLine(contents);
        }
    }
}
```

{% endtab %}

{% tab title="Java" %}

```java
package org.example;

import okhttp3.*;
import org.json.JSONObject;
import java.util.concurrent.TimeUnit;

public class Main implements Runnable {
    private static final String AUTHORIZATION_HEADER = "Authorization";
    public static final String USERNAME = "USERNAME";
    public static final String PASSWORD = "PASSWORD";

    public void run() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "bing_search");
        jsonObject.put("domain", "com");
        jsonObject.put("query", "adidas");
        jsonObject.put("start_page", 11);
        jsonObject.put("pages", 10);
        jsonObject.put("callback_url", "https://your.callback.url");
        jsonObject.put("parse", true);

        Authenticator authenticator = (route, response) -> {
            String credential = Credentials.basic(USERNAME, PASSWORD);
            return response
                    .request()
                    .newBuilder()
                    .header(AUTHORIZATION_HEADER, credential)
                    .build();
        };

        var client = new OkHttpClient.Builder()
                .authenticator(authenticator)
                .readTimeout(180, TimeUnit.SECONDS)
                .build();

        var mediaType = MediaType.parse("application/json; charset=utf-8");
        var body = RequestBody.create(jsonObject.toString(), mediaType);
        var request = new Request.Builder()
                .url("https://realtime.oxylabs.io/v1/queries")
                .post(body)
                .build();

        try (var response = client.newCall(request).execute()) {
            if (response.body() != null) {
                try (var responseBody = response.body()) {
                    System.out.println(responseBody.string());
                }
            }
        } catch (Exception exception) {
            System.out.println("Error: " + exception.getMessage());
        }

        System.exit(0);
    }

    public static void main(String[] args) {
        new Thread(new Main()).start();
    }
}
```

{% endtab %}

{% tab title="JSON" %}

```json
{
    "source": "bing_search",
    "domain": "com",
    "query": "adidas",
    "start_page": 11,
    "pages": 10,
    "callback_url": "https://your.callback.url",
    "parse": true
}
```

{% endtab %}
{% endtabs %}

Usamos integración síncrona [**Realtime**](/products/es/web-scraper-api/integration-methods/realtime.md) método de integración en nuestros ejemplos. Si deseas usar [**Proxy Endpoint**](/products/es/web-scraper-api/integration-methods/proxy-endpoint.md) o una integración asíncrona [**Push-Pull**](/products/es/web-scraper-api/integration-methods/push-pull.md) integración, consulta la [**métodos de integración**](/products/es/web-scraper-api/integration-methods.md) sección.

En el siguiente ejemplo, enviamos una solicitud para recuperar resultados de búsqueda de Bing generados por IA para el término de búsqueda `best seo tools`.

```json
{
    "source": "bing_search", 
    "query": "best seo tools", 
    "render": "html"
}
```

## Valores de los parámetros de solicitud

### Genérico

Configuración básica y opciones de personalización para el scraping de búsqueda de Bing.

<table><thead><tr><th width="222">Parámetro</th><th width="350.3333333333333">Descripción</th><th>Valor predeterminado</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><strong>source</strong></mark></td><td>Configura el scraper.</td><td><code>bing_search</code></td></tr><tr><td><mark style="background-color:green;"><strong>consulta</strong></mark></td><td>La palabra clave o frase que se buscará.</td><td>-</td></tr><tr><td><code>render</code></td><td>Habilita el renderizado de JavaScript cuando se establece en <code>html</code>. <a href="/products/es/web-scraper-api/features/js-rendering-and-browser-control.md#javascript-rendering"><strong>Más información</strong></a><strong>.</strong></td><td>-</td></tr><tr><td><code>parse</code></td><td>Devuelve datos analizados cuando se establece en <code>true</code>. Explorar la salida <a href="#output-data-dictionary"><strong>diccionario de datos</strong></a>.</td><td><code>false</code></td></tr><tr><td><code>callback_url</code></td><td>URL para tu endpoint de callback. <a href="/products/es/web-scraper-api/integration-methods/push-pull.md"><strong>Más información</strong></a></td><td>-</td></tr><tr><td><code>user_agent_type</code></td><td>Tipo de dispositivo y navegador. La lista completa se puede encontrar <a href="/products/es/web-scraper-api/features/http-context-and-job-management/user-agent-type.md"><strong>aquí</strong></a>.</td><td><code>desktop</code></td></tr></tbody></table>

\- parámetro obligatorio

### Localización

Adapte los resultados de búsqueda a ubicaciones geográficas, dominios e idiomas específicos.

<table><thead><tr><th width="222">Parámetro</th><th width="350.3333333333333">Descripción</th><th>Valor predeterminado</th></tr></thead><tbody><tr><td><code>geo_location</code></td><td>Especifica la ubicación de los resultados de búsqueda. Admite formatos de ciudad, estado, país o coordenadas. <a href="/products/es/web-scraper-api/features/localization.md"><strong>Leer más</strong></a><strong>.</strong></td><td>-</td></tr><tr><td><code>domain</code></td><td>Localice los resultados para un determinado país. Valores válidos: <code>com</code>, <code>ru</code>, <code>ua</code>, <code>by</code>, <code>kz</code>, <code>tr</code>.</td><td><code>com</code></td></tr><tr><td><code>locale</code></td><td><code>Accept-Language</code> valor del encabezado que cambia el idioma de la interfaz web de su página de búsqueda de Bing. <a href="/products/es/web-scraper-api/features/localization/domain-locale.md#bing"><strong>Más información</strong></a>.</td><td>-</td></tr></tbody></table>

### Paginación

Controles para gestionar la paginación y la recuperación de resultados de búsqueda.

<table><thead><tr><th width="222">Parámetro</th><th width="350.3333333333333">Descripción</th><th width="167">Valor predeterminado</th></tr></thead><tbody><tr><td><code>start_page</code></td><td>Número de página inicial.</td><td><code>1</code></td></tr><tr><td><code>pages</code></td><td>Número de páginas a recuperar.</td><td><code>1</code></td></tr><tr><td><code>limit</code></td><td>Número de resultados a recuperar en cada página.</td><td><code>10</code></td></tr></tbody></table>

## Datos estructurados

SERP Scraper API es capaz de extraer un objeto HTML o JSON que contiene resultados de búsqueda de Bing, ofreciendo datos estructurados sobre varios elementos de la página de resultados.

{% file src="/files/fa1dc706e168f0d9a1aa9eeaa983c9627385d53d" %}

## Diccionario de datos de salida

#### **Ejemplo en HTML**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXek9v-EPIfkuBe9agDrGzoz2gQspI2bjipHUUGSl2Y7sW1NB1ZBUSTdAlG-VzFcG0m-Anei0qj3E4b4h_N-RgJhrHSaqFDF8WvVIXaJLOodVj_mxmnRtIh9e9ViRaxZrQhhL3Ntd9dARaGg-px-j0xQVYU?key=NG4r24r-hbhCkjE_d7r1ZQ" alt="" width="563"><figcaption></figcaption></figure>

#### Estructura JSON

La tabla a continuación presenta una lista detallada de cada elemento SERP que analizamos, junto con su descripción y tipo de dato. La tabla también incluye algunos metadatos.

<table><thead><tr><th width="233">Clave</th><th width="366">Descripción</th><th>Tipo</th></tr></thead><tbody><tr><td><code>url</code></td><td>La URL de la página de búsqueda de Bing.</td><td>cadena</td></tr><tr><td><code>page</code></td><td>El número de página actual.</td><td>entero</td></tr><tr><td><code>results</code></td><td>Un diccionario que contiene los resultados de la búsqueda.</td><td>objeto</td></tr><tr><td><code>paid</code> (opcional)</td><td>Una lista de resultados patrocinados con sus respectivos detalles.</td><td>arreglo</td></tr><tr><td><code>organic</code></td><td>Una lista de resultados orgánicos con sus respectivos detalles.</td><td>arreglo</td></tr><tr><td><code>parse_status_code</code></td><td>El código de estado del trabajo de análisis. Puedes ver los códigos de estado del parser descritos <a href="https://github.com/oxylabs/gitbook-public-english/blob/master/scraping-solutions/web-scraper-api/targets/bing/broken-reference/README.md"><strong>aquí</strong></a>.</td><td>entero</td></tr><tr><td><code>creado_en</code></td><td>La marca de tiempo en que se creó el trabajo de scraping.</td><td>marca_de_tiempo</td></tr><tr><td><code>actualizado_en</code></td><td>La marca de tiempo en que terminó el trabajo de scraping.</td><td>marca_de_tiempo</td></tr><tr><td><code>código_de_estado</code></td><td>El código de estado del trabajo de scraping. Puedes ver los códigos de estado del scraper descritos <a href="https://github.com/oxylabs/gitbook-public-english/blob/master/scraping-solutions/web-scraper-api/targets/bing/broken-reference/README.md"><strong>aquí</strong></a>.</td><td>entero</td></tr><tr><td><code>id_del_trabajo</code></td><td>El ID del trabajo asociado con el trabajo de scraping.</td><td>cadena</td></tr></tbody></table>

{% hint style="info" %}
En las siguientes secciones, los fragmentos de código JSON analizados se acortan cuando hay más de un elemento disponible para el tipo de resultado.
{% endhint %}

### Pagado

<figure><img src="https://197269033-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBaJCXoqO1zdFnaMnCKrg%2Fuploads%2Fgit-blob-a26f130fc02d2cbbd7d7e2abdd24bf5a103016a8%2Fbing_search.png?alt=media" alt=""><figcaption></figcaption></figure>

```json
...
  "paid": [
    {
        "pos": 1,
        "url": "https://www.bing.com/aclick?ld=e8TB2-TOVbuwbSri4984NcRjVUCUyQghxnzejHV59xXn6r9lgz7ciPH0EL82ftdUCMBGEyAqiFGOiPXPkAOfdD7Y-Xpb6_pZlMPNZ2x6tTn4WAr8KA0oPNQYW031wP0d8g-pQsdx7BmXEN9ZojHVTY7Jznw7BafmzDSQCtL-MgYN9BRUmeBp74Eo3wYCJfbPIT_cWI2g&u=aHR0cCUzYSUyZiUyZnd3dy5yZW1pc2VzZW5saWduZS5mciUyZmJhc2tldC1uaWtlLWpvcmRhbiUzZnRhcmdldGlkJTNka3dkLTg1MTQ0NzUwMTM5NzExJTI2bWF0Y2h0eXBlJTNkcCUyNmRldmljZSUzZGMlMjZjYW1wYWlnbmlkJTNkNTMxMzY2ODQ3JTI2Y3JlYXRpdmUlM2QlMjZhZGdyb3VwaWQlM2QxMzYyMjk3NDM4ODkzNDg1JTI2ZmVlZGl0ZW1pZCUzZCUyNmxvY19waHlzaWNhbF9tcyUzZDE0MzAyNyUyNmxvY19pbnRlcmVzdF9tcyUzZCUyNm5ldHdvcmslM2RvJTI2ZGV2aWNlbW9kZWwlM2QlMjZwbGFjZW1lbnQlM2QlMjZrZXl3b3JkJTNkJTI0YmFza2V0JTI1MjBuaWtlJTI1MjBqb3JkYW4lMjZ0YXJnZXQlM2QlMjZhZHBvc2l0aW9uJTNkJTI2dHJhY2tpZCUzZGZyX2FsbF9kZWFsc18yX2JpbmclMjZtSWQlM2RIMTQ5MDAzQ1FOJTI2bXNjbGtpZCUzZDc5NjY4ODI4MDQ0ODE2NjVjNTJmZWU0MTc4Yjk1NWJm&rlid=7966882804481665c52fee4178b955bf",
        "desc": "Nuevos lanzamientos, clásicos retro e iconos atemporales. Descubre Air Jordan en Nike. Domina el juego y redescubre la tradición con Air Jordan de Nike.",
        "title": "Sitio web oficial de Air Jordan | Compra productos Jumpman de Nike",
        "url_shown": "www.nike.com/air/jordan",
        "pos_overall": 11
    },
    {
        "pos": 2,
        "url": "https://www.bing.com/aclick?ld=e8OBM60EyxdN2Qxvp-arD9JzVUCUwier4bXHLFD_dsME5lB1Pg9YnfVggGJSi3ORhgEF-Gwzqx3PiuxHd6fxx0MXN6JKmkwjaGnD2ROEo6W3eTA9fAn8bfi9vpeZ8xEeTyyq8sKhHcKj58HK6h9JnOT7G7zLTYg6MFHaWaGo06uKP4G58bRvFt98DUBKhWj8fd_L867A&u=aHR0cHMlM2ElMmYlMmZ3d3cuYW1hem9uLmNvbSUyZnMlMmYlM2ZpZSUzZFVURjglMjZrZXl3b3JkcyUzZHdvbWVuJTI1MjdzJTJiYWlyJTJiam9yZGFuJTJicmV0cm8lMmIxJTJiZWxldmF0ZSUyYmxvdyUyYmNhc3VhbCUyYnNob2VzJTI2aW5kZXglM2RhcHMlMjZ0YWclM2RtaDBiLTIwJTI2cmVmJTNkcGRfc2xfM2ltOXJscjRkb19iJTI2YWRncnBpZCUzZDEzMzkyMDc1NjMwMTkxMTIlMjZodmFkaWQlM2Q4MzcwMDczNjAyNTQ5NiUyNmh2bmV0dyUzZG8lMjZodnFtdCUzZGIlMjZodmJtdCUzZGJiJTI2aHZkZXYlM2RjJTI2aHZsb2NpbnQlM2QlMjZodmxvY3BoeSUzZDE0MzAyNyUyNmh2dGFyZ2lkJTNka3dkLTgzNzAxNTIzNzAwNjc0JTI2aHlkYWRjciUzZDgwNDJfMTM0Njc2MjQlMjZtc2Nsa2lkJTNkMTg4YzJhMmJhNzg0MWE2MWExY2M0YzQyZGI3NWJhMTU&rlid=188c2a2ba7841a61a1cc4c42db75ba15",
        "desc": "Zapatillas y más en Foot Locker Online. ¡Colecciones premium y ropa!",
        "title": "Jordan - Foot Locker Alemania | Foot Locker Alemania",
        "url_shown": "www.footlocker.de",
        "pos_overall": 12
    }
],
...
```

<table><thead><tr><th width="169">Clave (de pago)</th><th width="387">Descripción</th><th>Tipo</th></tr></thead><tbody><tr><td><code>pos</code></td><td>La posición del anuncio dentro de la lista de anuncios de pago.</td><td>entero</td></tr><tr><td><code>url</code></td><td>La URL completa del anuncio de pago.</td><td>cadena</td></tr><tr><td><code>desc</code></td><td>Una breve descripción o resumen del contenido del anuncio.</td><td>cadena</td></tr><tr><td><code>title</code></td><td>El encabezado o título principal del anuncio.</td><td>cadena</td></tr><tr><td><code>url_shown</code></td><td>La URL simplificada mostrada a los usuarios.</td><td>cadena</td></tr><tr><td><code>pos_overall</code></td><td>La clasificación del anuncio entre todos los resultados de búsqueda, incluidas las listas de pago y orgánicas.</td><td>entero</td></tr></tbody></table>

### Orgánico

<figure><img src="https://197269033-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBaJCXoqO1zdFnaMnCKrg%2Fuploads%2Fgit-blob-556033fe6c50b5d1cab248330b08f3e39b3b138f%2FScreenshot%202024-06-17%20at%2012.16.42.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

```json
...
"organic": [
    {
        "pos": 1,
        "url": "https://www.bing.com/ck/a?!&&p=dfe8ec2f6aa2c9deJmltdHM9MTcxODU4MjQwMCZpZ3VpZD0wNzdiZTI5My05ZWM4LTZkNWYtMDE0Ni1mNjMyOWZmMzZjMDEmaW5zaWQ9NTIwOA&ptn=3&ver=2&hsh=3&fclid=077be293-9ec8-6d5f-0146-f6329ff36c01&psq=nike+jordan+shoes&u=a1aHR0cHM6Ly93d3cubmlrZS5jb20vcGgvdy9qb3JkYW4tc2hvZXMtMzdlZWZ6eTdvaz9tc29ja2lkPTA3N2JlMjkzOWVjODZkNWYwMTQ2ZjYzMjlmZjM2YzAx&ntb=1",
        "desc": "WEBEncuentra Jordan Shoes en Nike.com. Entrega y devoluciones gratis en pedidos seleccionados.",
        "title": "Zapatillas Jordan. Nike PH",
        "url_shown": "https://www.nike.com/ph/w/jordan-shoes-37eefzy7ok",
        "pos_overall": 1
    },
...
```

<table><thead><tr><th width="209">Clave (organic)</th><th width="384">Descripción</th><th>Tipo</th></tr></thead><tbody><tr><td><code>pos</code></td><td>La clasificación del resultado orgánico dentro de la lista de resultados de búsqueda orgánicos.</td><td>entero</td></tr><tr><td><code>url</code></td><td>La URL completa del resultado de búsqueda orgánico.</td><td>cadena</td></tr><tr><td><code>desc</code></td><td>Una breve descripción o resumen del contenido del resultado de búsqueda orgánico.</td><td>cadena</td></tr><tr><td><code>title</code></td><td>El encabezado o título principal del resultado de búsqueda orgánico.</td><td>cadena</td></tr><tr><td><code>url_shown</code></td><td>La URL simplificada mostrada a los usuarios.</td><td>cadena</td></tr><tr><td><code>pos_overall</code></td><td>La clasificación del resultado orgánico entre todos los resultados de búsqueda, incluidas las listas de pago y orgánicas.</td><td>entero</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://developers.oxylabs.io/api-targets/es/search-engines/bing/search.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.