{"meta":{"title":"Ganchos de sessão","intro":"Os ganchos permitem interceptar e personalizar o comportamento de sessões de Copilot em pontos-chave no ciclo de vida da conversa. Use ganchos 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/hooks-overview","title":"Visão geral dos ganchos"}],"documentType":"article"},"body":"# Ganchos de sessão\n\nOs ganchos permitem interceptar e personalizar o comportamento de sessões de Copilot em pontos-chave no ciclo de vida da conversa. Use ganchos para:\n\n\n\n\n\n* **Controlar a execução da ferramenta** – aprovar, negar ou modificar chamadas de ferramenta\n* **Transformar resultados** – modificar saídas de ferramenta antes de serem processadas\n* **Adicionar contexto** – injetar informações adicionais no início da sessão\n* **Manipular erros** – implementar o tratamento de erros personalizados\n* **Auditoria e registro** - acompanhe todas as interações para fins de conformidade\n\n## Ganchos disponíveis\n\n| Gancho | Gatilho | Caso de uso |\n| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------- |\n| [Gancho de uso de pré-ferramenta](/pt/copilot/how-tos/copilot-sdk/hooks/pre-tool-use) | Antes que uma ferramenta seja executada | Controle de permissão, validação de argumento |\n| [Gancho de uso pós-ferramenta](/pt/copilot/how-tos/copilot-sdk/hooks/post-tool-use) | Após a execução de uma ferramenta (apenas em caso de sucesso) | Transformação de resultados, registro em log |\n| [Gancho de uso pós-ferramenta](/pt/copilot/how-tos/copilot-sdk/hooks/post-tool-use#failure-variant) | Após uma execução de ferramenta cujo resultado foi uma falha | Inserir orientações para nova tentativa, registrar falhas |\n| [Gancho enviado pelo prompt do usuário](/pt/copilot/how-tos/copilot-sdk/hooks/user-prompt-submitted) | Quando o usuário envia uma mensagem | Modificação de prompt, filtragem |\n| [Gancho transformado do prompt do usuário](/pt/copilot/how-tos/copilot-sdk/hooks/user-prompt-transformed) | Depois da transformação do prompt em runtime | Inspecionar ou substituir o conteúdo voltado para o modelo |\n| [Ganchos de ciclo de vida de sessão](/pt/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#session-start) | A sessão começa | Adicionar contexto, configurar sessão |\n| [Ganchos de ciclo de vida de sessão](/pt/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#session-end) | Término da sessão | Limpeza, análise |\n| [Gancho de tratamento de erros](/pt/copilot/how-tos/copilot-sdk/hooks/error-handling) | Erro ocorre | Tratamento de erros personalizados |\n| [Ganchos de ciclo de vida de sessão](/pt/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#agent-stop) | O agente de nível superior para naturalmente | Validar a conclusão ou solicitar outra execução |\n\n## Início rápido\n\n
\n
TypeScript
\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n console.log(`Tool called: ${input.toolName}`);\n // Allow all tools\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`Tool result: ${JSON.stringify(input.toolResult)}`);\n return null; // No modifications\n },\n onSessionStart: async (input) => {\n return { additionalContext: \"User prefers concise answers.\" };\n },\n },\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n async def on_pre_tool_use(input_data, invocation):\n print(f\"Tool called: {input_data['toolName']}\")\n return {\"permissionDecision\": \"allow\"}\n\n async def on_post_tool_use(input_data, invocation):\n print(f\"Tool result: {input_data['toolResult']}\")\n return None\n\n async def on_session_start(input_data, invocation):\n return {\"additionalContext\": \"User prefers concise answers.\"}\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n \"on_session_start\": on_session_start,\n })\n```\n\n
\n\n
Go
\n\n```golang\npackage main\n\nimport (\n \"context\"\n \"fmt\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n client := copilot.NewClient(nil)\n\n session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n fmt.Printf(\"Tool called: %s\\n\", input.ToolName)\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"allow\",\n }, nil\n },\n OnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n fmt.Printf(\"Tool result: %v\\n\", input.ToolResult)\n return nil, nil\n },\n OnSessionStart: func(input copilot.SessionStartHookInput, inv copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n return &copilot.SessionStartHookOutput{\n AdditionalContext: \"User prefers concise answers.\",\n }, nil\n },\n },\n })\n _ = session\n}\n```\n\n
\n\n
.NET
\n\n```csharp\nusing GitHub.Copilot;\n\nvar client = new CopilotClient();\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"Tool called: {input.ToolName}\");\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" }\n );\n },\n OnPostToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"Tool result: {input.ToolResult}\");\n return Task.FromResult(null);\n },\n OnSessionStart = (input, invocation) =>\n {\n return Task.FromResult(\n new SessionStartHookOutput { AdditionalContext = \"User prefers concise answers.\" }\n );\n },\n },\n});\n```\n\n
\n\n
Java
\n\n```java\nimport com.github.copilot.*;\nimport com.github.copilot.rpc.*;\nimport java.util.concurrent.CompletableFuture;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var hooks = new SessionHooks()\n .setOnPreToolUse((input, invocation) -> {\n System.out.println(\"Tool called: \" + input.getToolName());\n return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());\n })\n .setOnPostToolUse((input, invocation) -> {\n System.out.println(\"Tool result: \" + input.getToolResult());\n return CompletableFuture.completedFuture(null);\n })\n .setOnSessionStart((input, invocation) -> {\n return CompletableFuture.completedFuture(\n new SessionStartHookOutput(\"User prefers concise answers.\", null)\n );\n });\n\n var session = client.createSession(\n new SessionConfig()\n .setHooks(hooks)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n}\n```\n\n
\n\n
\n\n## Contexto de invocação do gancho\n\nCada gancho recebe um `invocation` parâmetro com contexto sobre a sessão atual:\n\n| Campo | Tipo | Descrição |\n| ----------- | ------ | -------------------- |\n| `sessionId` | cadeia | O ID da sessão atual |\n\nIsso permite que os ganchos mantenham o estado ou executem uma lógica específica da sessão.\n\n## Padrões comuns\n\n### Registrando todas as chamadas de ferramenta\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n console.log(`[${new Date().toISOString()}] Tool: ${input.toolName}, Args: ${JSON.stringify(input.toolArgs)}`);\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`[${new Date().toISOString()}] Result: ${JSON.stringify(input.toolResult)}`);\n return null;\n },\n },\n});\n```\n\n### Bloquear ferramentas perigosas\n\n```typescript\nconst BLOCKED_TOOLS = [\"shell\", \"bash\", \"exec\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (BLOCKED_TOOLS.includes(input.toolName)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: \"Shell access is not permitted\",\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Adicionar contexto do usuário\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async () => {\n const userPrefs = await loadUserPreferences();\n return {\n additionalContext: `User preferences: ${JSON.stringify(userPrefs)}`,\n };\n },\n },\n});\n```\n\n## Guias de gancho\n\n* **[Gancho de uso de pré-ferramenta](/pt/copilot/how-tos/copilot-sdk/hooks/pre-tool-use)** – Controlar permissões de execução da ferramenta\n* **[Gancho de uso pós-ferramenta](/pt/copilot/how-tos/copilot-sdk/hooks/post-tool-use)** – Transformar resultados da ferramenta\n* **[Gancho enviado pelo prompt do usuário](/pt/copilot/how-tos/copilot-sdk/hooks/user-prompt-submitted)** – Modificar prompts do usuário\n* **[Gancho transformado do prompt do usuário](/pt/copilot/how-tos/copilot-sdk/hooks/user-prompt-transformed)** – Substituir prompts voltados para modelo\n* **[Ganchos de ciclo de vida de sessão](/pt/copilot/how-tos/copilot-sdk/hooks/session-lifecycle)** – Início e término da sessão\n* **[Ganchos de ciclo de vida de sessão](/pt/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#agent-stop)** – Validar a conclusão antes que o agente pare\n* **[Gancho de tratamento de erros](/pt/copilot/how-tos/copilot-sdk/hooks/error-handling)** – Tratamento de erros personalizado\n\n## Consulte também\n\n* [Crie seu primeiro aplicativo com tecnologia do Copilot](/pt/copilot/how-tos/copilot-sdk/getting-started)\n* [Crie seu primeiro aplicativo com tecnologia do Copilot](/pt/copilot/how-tos/copilot-sdk/getting-started#step-4-add-a-custom-tool)\n* [Guia de depuração](/pt/copilot/how-tos/copilot-sdk/troubleshooting/debugging)"}