> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Ask user

> Responde a las preguntas del agente lanzadas vía la herramienta ask_user mediante el handler onUserInputRequest de Laravel Copilot SDK.

## Solicitud de entrada del usuario

Si configuras el handler `onUserInputRequest`, el agente podrá hacer preguntas al usuario mediante la herramienta `ask_user`.

```php theme={null}
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Types\UserInputRequest;
use Revolution\Copilot\Types\UserInputResponse;

Copilot::start(function (CopilotSession $session) {
    $response = $session->sendAndWait(prompt: 'ユーザーに好きな言語を聞いて');
    dump($response->content());
}, config: [
    'model' => 'gpt-5',
    'onUserInputRequest' => function (UserInputRequest $request): UserInputResponse {
        // $request->question - contenido de la pregunta
        // $request->choices - array de opciones múltiples (opcional)
        // $request->allowFreeform - si se permite entrada libre (por defecto: true)

        dump("Question from agent: {$request->question}");
        if ($request->choices) {
            dump('Choices: '.implode(', ', $request->choices));
        }

        // Devuelve la respuesta del usuario
        return new UserInputResponse(
            answer: 'PHP',
            wasFreeform: true, // si la respuesta fue libre en lugar de elegida de las opciones
        );
    },
]);
```

## Clase UserInputRequest

Solicitud de entrada del usuario procedente del agente.

| Propiedad       | Tipo     | Descripción                                         |
| --------------- | -------- | --------------------------------------------------- |
| `question`      | `string` | La pregunta que se le hace al usuario               |
| `choices`       | `?array` | Opciones cuando es una elección múltiple (opcional) |
| `allowFreeform` | `?bool`  | Si se permite entrada libre (por defecto: `true`)   |

## Clase UserInputResponse

Respuesta a una solicitud de entrada del usuario.

| Propiedad     | Tipo     | Descripción                                                                      |
| ------------- | -------- | -------------------------------------------------------------------------------- |
| `answer`      | `string` | Respuesta del usuario                                                            |
| `wasFreeform` | `bool`   | Si la respuesta fue en formato libre (`true` cuando no proviene de las opciones) |

## Ejemplo práctico

Uso dentro de un comando interactivo:

```php theme={null}
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Types\UserInputRequest;
use Revolution\Copilot\Types\UserInputResponse;

// Dentro de un comando de Artisan
Copilot::start(function (CopilotSession $session) use ($command) {
    $response = $session->sendAndWait(prompt: 'プロジェクトの設定を行います');
    $command->info($response->content());
}, config: [
    'onUserInputRequest' => function (UserInputRequest $request) use ($command): UserInputResponse {
        if ($request->choices) {
            // Si hay opciones, usa el método choice
            $answer = $command->choice(
                $request->question,
                $request->choices,
                $request->choices[0] ?? null
            );

            return new UserInputResponse(answer: $answer, wasFreeform: false);
        }

        // Entrada libre
        $answer = $command->ask($request->question);

        return new UserInputResponse(answer: $answer, wasFreeform: true);
    },
]);
```

<Info>
  Consulta la información más reciente en el [repositorio de GitHub](https://github.com/invokable/laravel-copilot-sdk).
</Info>


## Related topics

- [Laravel Prompts](/es/prompts.md)
- [Hooks de sesión](/es/packages/laravel-copilot-sdk/hooks.md)
- [Consola Artisan](/es/artisan.md)
- [Add User Dict Word](/es/packages/laravel-voicevox/engine-api/user-dictionary/add-user-dict-word.md)
- [Import User Dict Words](/es/packages/laravel-voicevox/engine-api/user-dictionary/import-user-dict-words.md)
