{"meta":{"title":"Ganchos de ciclo de vida de sessão","intro":"Os ganchos de ciclo de vida da sessão permitem que você responda aos eventos de início e término da sessão. Use-os para:","product":"GitHub Copilot","breadcrumbs":[{"href":"/pt/copilot","title":"GitHub Copilot"},{"href":"/pt/copilot/how-tos","title":"Instruções"},{"href":"/pt/copilot/how-tos/copilot-sdk","title":"SDK do Copilot"},{"href":"/pt/copilot/how-tos/copilot-sdk/hooks","title":"Usar ganchos"},{"href":"/pt/copilot/how-tos/copilot-sdk/hooks/session-lifecycle","title":"Ciclo de vida da sessão"}],"documentType":"article"},"body":"# Ganchos de ciclo de vida de sessão\n\nOs ganchos de ciclo de vida da sessão permitem que você responda aos eventos de início e término da sessão. Use-os para:\n\n\n\n\n\n* Inicialize o contexto quando as sessões começarem\n* Limpar recursos quando as sessões terminarem\n* Acompanhar as métricas e análises da sessão\n* Configurar o comportamento da sessão dinamicamente\n\n## Gancho de início da sessão {#session-start}\n\nO `onSessionStart` gancho é chamado quando uma sessão é iniciada (nova ou retomada).\n\n### Assinatura de Hook\n\n
\n
TypeScript
\n\n```typescript\ntype SessionStartHandler = (\n input: SessionStartHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
Python
\n\n```python\nSessionStartHandler = Callable[\n [SessionStartHookInput, dict[str, str]],\n Awaitable[SessionStartHookOutput | None]\n]\n```\n\n
\n\n
Go
\n\n```golang\ntype SessionStartHandler func(\n input SessionStartHookInput,\n invocation HookInvocation,\n) (*SessionStartHookOutput, error)\n```\n\n
\n\n
.NET
\n\n```csharp\npublic delegate Task SessionStartHandler(\n SessionStartHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
Java
\n\n```java\n@FunctionalInterface\npublic interface SessionStartHandler {\n CompletableFuture handle(\n SessionStartHookInput input,\n HookInvocation invocation);\n}\n```\n\n
\n\n
\n\n### Entrada\n\n| Campo | Tipo | Descrição |\n| -------------------------- | ---------------------------------- | ------------------------------------------------------------- |\n| `timestamp` | number | Carimbo de data/hora Unix de quando o gancho foi desencadeado |\n| `cwd` | cadeia | Diretório de trabalho atual |\n| `source` | | |\n| `\"startup\"` | | |\n| \\| | | |\n| `\"resume\"` | | |\n| \\| | | |\n| `\"new\"` | | |\n| Como a sessão foi iniciada | | |\n| `initialPrompt` | cadeia de caracteres \\| indefinida | O prompt inicial, se fornecido |\n\n### Saída\n\n| Campo | Tipo | Descrição |\n| ------------------- | ------ | --------------------------------------------- |\n| `additionalContext` | cadeia | Contexto a ser adicionado no início da sessão |\n| `modifiedConfig` | objeto | Sobrepor configuração de sessão |\n\n### Exemplos\n\n#### Adicionar contexto de projeto no início\n\n
\n
TypeScript
\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n console.log(`Session ${invocation.sessionId} started (${input.source})`);\n \n const projectInfo = await detectProjectType(input.cwd);\n \n return {\n additionalContext: `\nThis is a ${projectInfo.type} project.\nMain language: ${projectInfo.language}\nPackage manager: ${projectInfo.packageManager}\n `.trim(),\n };\n },\n },\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_session_start(input_data, invocation):\n print(f\"Session {invocation['session_id']} started ({input_data['source']})\")\n \n project_info = await detect_project_type(input_data[\"cwd\"])\n \n return {\n \"additionalContext\": f\"\"\"\nThis is a {project_info['type']} project.\nMain language: {project_info['language']}\nPackage manager: {project_info['packageManager']}\n \"\"\".strip()\n }\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_session_start\": on_session_start})\n```\n\n
\n\n
\n\n#### Lidar com a retomada de sessão\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n if (input.source === \"resume\") {\n // Load previous session state\n const previousState = await loadSessionState(invocation.sessionId);\n \n return {\n additionalContext: `\nSession resumed. Previous context:\n- Last topic: ${previousState.lastTopic}\n- Open files: ${previousState.openFiles.join(\", \")}\n `.trim(),\n };\n }\n return null;\n },\n },\n});\n```\n\n#### Carregar preferências do usuário\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async () => {\n const preferences = await loadUserPreferences();\n \n const contextParts = [];\n \n if (preferences.language) {\n contextParts.push(`Preferred language: ${preferences.language}`);\n }\n if (preferences.codeStyle) {\n contextParts.push(`Code style: ${preferences.codeStyle}`);\n }\n if (preferences.verbosity === \"concise\") {\n contextParts.push(\"Keep responses brief and to the point.\");\n }\n \n return {\n additionalContext: contextParts.join(\"\\n\"),\n };\n },\n },\n});\n```\n\n## Gancho de fim de sessão {#session-end}\n\nO `onSessionEnd` gancho é invocado quando uma sessão termina.\n\n### Assinatura de Hook\n\n
\n
TypeScript
\n\n```typescript\ntype SessionEndHandler = (\n input: SessionEndHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
Python
\n\n```python\nSessionEndHandler = Callable[\n [SessionEndHookInput, dict[str, str]],\n Awaitable[SessionEndHookOutput | None]\n]\n```\n\n
\n\n
Go
\n\n```golang\ntype SessionEndHandler func(\n input SessionEndHookInput,\n invocation HookInvocation,\n) (*SessionEndHookOutput, error)\n```\n\n
\n\n
.NET
\n\n```csharp\npublic delegate Task SessionEndHandler(\n SessionEndHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
Java
\n\n```java\n@FunctionalInterface\npublic interface SessionEndHandler {\n CompletableFuture handle(\n SessionEndHookInput input,\n HookInvocation invocation);\n}\n```\n\n
\n\n
\n\n### Entrada\n\n| Campo | Tipo | Descrição |\n| -------------- | ---------------------------------- | ------------------------------------------------------------- |\n| `timestamp` | number | Carimbo de data/hora Unix de quando o gancho foi desencadeado |\n| `cwd` | cadeia | Diretório de trabalho atual |\n| `reason` | cadeia | Por que a sessão terminou (veja abaixo) |\n| `finalMessage` | cadeia de caracteres \\| indefinida | A última mensagem da sessão |\n| `error` | cadeia de caracteres \\| indefinida | Mensagem de erro se a sessão terminou devido a um erro |\n\n#### Motivos finais\n\n| Reason | Descrição |\n| ------------- | -------------------------------------------------- |\n| `\"complete\"` | Sessão concluída normalmente |\n| `\"error\"` | Sessão encerrada devido a um erro |\n| `\"abort\"` | A sessão foi abortada pelo usuário ou pelo código. |\n| `\"timeout\"` | Sessão expirada |\n| `\"user_exit\"` | O usuário encerrou explicitamente a sessão |\n\n### Saída\n\n| Campo | Tipo | Descrição |\n| ---------------- | --------- | ----------------------------------------------- |\n| `suppressOutput` | boolean | Suprimir a saída final da sessão |\n| `cleanupActions` | string\\[] | Lista de ações de limpeza a serem executadas |\n| `sessionSummary` | cadeia | Resumo da sessão para registro/análise de dados |\n\n### Exemplos\n\n#### Acompanhar métricas de sessão\n\n
\n
TypeScript
\n\n```typescript\nconst sessionStartTimes = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionStartTimes.set(invocation.sessionId, input.timestamp);\n return null;\n },\n onSessionEnd: async (input, invocation) => {\n const startTime = sessionStartTimes.get(invocation.sessionId);\n const duration = startTime ? input.timestamp - startTime : 0;\n \n await recordMetrics({\n sessionId: invocation.sessionId,\n duration,\n endReason: input.reason,\n });\n \n sessionStartTimes.delete(invocation.sessionId);\n return null;\n },\n },\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot.session import PermissionHandler\n\nsession_start_times = {}\n\nasync def on_session_start(input_data, invocation):\n session_start_times[invocation[\"session_id\"]] = input_data[\"timestamp\"]\n return None\n\nasync def on_session_end(input_data, invocation):\n start_time = session_start_times.get(invocation[\"session_id\"])\n duration = input_data[\"timestamp\"] - start_time if start_time else 0\n \n await record_metrics({\n \"session_id\": invocation[\"session_id\"],\n \"duration\": duration,\n \"end_reason\": input_data[\"reason\"],\n })\n \n session_start_times.pop(invocation[\"session_id\"], None)\n return None\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\n \"on_session_start\": on_session_start,\n \"on_session_end\": on_session_end,\n })\n```\n\n
\n\n
\n\n#### Limpar os recursos\n\n```typescript\nconst sessionResources = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionResources.set(invocation.sessionId, { tempFiles: [] });\n return null;\n },\n onSessionEnd: async (input, invocation) => {\n const resources = sessionResources.get(invocation.sessionId);\n \n if (resources) {\n // Clean up temp files\n for (const file of resources.tempFiles) {\n await fs.unlink(file).catch(() => {});\n }\n sessionResources.delete(invocation.sessionId);\n }\n \n console.log(`Session ${invocation.sessionId} ended: ${input.reason}`);\n return null;\n },\n },\n});\n```\n\n#### Salvar o estado da sessão para retomar\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionEnd: async (input, invocation) => {\n if (input.reason !== \"error\") {\n // Save state for potential resume\n await saveSessionState(invocation.sessionId, {\n endTime: input.timestamp,\n cwd: input.cwd,\n reason: input.reason,\n });\n }\n return null;\n },\n },\n});\n```\n\n#### Resumo da sessão de log\n\n```typescript\nconst sessionData: Record = {};\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionData[invocation.sessionId] = { \n prompts: 0, \n tools: 0, \n startTime: input.timestamp \n };\n return null;\n },\n onUserPromptSubmitted: async (_, invocation) => {\n sessionData[invocation.sessionId].prompts++;\n return null;\n },\n onPreToolUse: async (_, invocation) => {\n sessionData[invocation.sessionId].tools++;\n return { permissionDecision: \"allow\" };\n },\n onSessionEnd: async (input, invocation) => {\n const data = sessionData[invocation.sessionId];\n console.log(`\nSession Summary:\n ID: ${invocation.sessionId}\n Duration: ${(input.timestamp - data.startTime) / 1000}s\n Prompts: ${data.prompts}\n Tool calls: ${data.tools}\n End reason: ${input.reason}\n `.trim());\n \n delete sessionData[invocation.sessionId];\n return null;\n },\n },\n});\n```\n\n## Gancho de parada do agente {#agent-stop}\n\nO gancho de parada do agente é executado quando o agente de nível superior naturalmente atinge o final de uma curva. Ela é separada de `onSessionEnd`: a sessão permanece ativa e o gancho pode solicitar a volta de outro agente.\n\n| Linguagem | Manipulador |\n| ------------------ | ---------------- |\n| Node.js/TypeScript | `onAgentStop` |\n| Python | `on_agent_stop` |\n| Go | `OnAgentStop` |\n| .NET | `OnAgentStop` |\n| Rust | `on_agent_stop` |\n| Java | `setOnAgentStop` |\n\n### Entrada\n\nOs nomes de membros públicos seguem as convenções de maiúsculas e minúsculas de cada idioma:\n\n| Meaning | Node.js/Python | Go / .NET | Rust | Java |\n| ----------------------------------------------------------- | ---------------- | ---------------- | ------------------ | --------------------- |\n| Por que o agente parou, por exemplo `end_turn` | `stopReason` | `StopReason` | `stop_reason` | `getStopReason()` |\n| Caminho para a transcrição da sessão no disco | `transcriptPath` | `TranscriptPath` | `transcript_path` | `getTranscriptPath()` |\n| Se uma decisão de bloco anterior já forçou essa continuação | `stopHookActive` | `StopHookActive` | `stop_hook_active` | `getStopHookActive()` |\n\n### Saída\n\nNão produza saída para que o agente pare. Retorne uma decisão de bloqueio para enfileirar outra mensagem do usuário e continuar:\n\n```json\n{\n \"decision\": \"block\",\n \"reason\": \"Run the final validation and fix any failures.\"\n}\n```\n\nUse o membro de parada ativa listado acima para evitar bloquear repetidamente um agente que já tenha continuado devido a esse gancho. O ambiente de execução também impõe um limite ao número de decisões de bloqueio consecutivas.\n\n## Práticas recomendadas\n\n1. **Mantenha `onSessionStart` rápido** – os usuários estão aguardando a sessão ficar pronta.\n\n2. **Trate todos os motivos de encerramento** – não presuma que as sessões se encerrem sem problemas; trate erros e abortos.\n\n3. **Limpar recursos** – Use `onSessionEnd` para liberar todos os recursos alocados durante a sessão.\n\n4. **Armazenar o estado mínimo** – se estiver acompanhando os dados da sessão, mantenha-os leves.\n\n5. **Tornar a limpeza idempotente** - `onSessionEnd` pode não ser chamado se o processo falhar.\n\n## Consulte também\n\n* [Usar ganchos](/pt/copilot/how-tos/copilot-sdk/hooks)\n* [Gancho de tratamento de erros](/pt/copilot/how-tos/copilot-sdk/hooks/error-handling)\n* [Guia de depuração](/pt/copilot/how-tos/copilot-sdk/troubleshooting/debugging)"}