Enlaces de ciclo de vida de sesión

Los enlaces de ciclo de vida de la sesión permiten responder a los eventos de inicio y finalización de la sesión. Úselos para:

• Inicialización del contexto cuando comienzan las sesiones
• Limpieza de recursos cuando finalizan las sesiones
• Seguimiento de métricas de la sesión y análisis
• Configuración dinámica del comportamiento de la sesión

Gancho de inicio de sesión

El onSessionStart gancho se llama cuando se inicia una sesión, ya sea nueva o reanudada.

Firma de gancho

import type { SessionStartHookInput, HookInvocation, SessionStartHookOutput } from "@github/copilot-sdk";
type SessionStartHandler = (
  input: SessionStartHookInput,
  invocation: HookInvocation
) => Promise<
  SessionStartHookOutput | null | undefined
>;

Para obtener firmas de enlace en Python, Go y .NET, consulte el github/copilot-sdk repositorio.

Entrada

Campo	Tipo	Descripción
timestamp	número	Marca de tiempo de Unix cuando se desencadenó el hook
cwd	cuerda / cadena	Directorio de trabajo actual
source

          `"startup"`
          \|
          `"resume"`
          \|
          `"new"`
         | Cómo se inició la sesión |

| initialPrompt | cadena | indefinido | El indicador inicial si se proporciona |

Salida

Campo	Tipo	Descripción
additionalContext	cuerda / cadena	Contexto a añadir al inicio de la sesión
modifiedConfig	objeto	Invalidación de la configuración de sesión

Ejemplos

Agregar contexto del proyecto al principio

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      console.log(
        `Session ${invocation.sessionId} `
        + `started (${input.source})`
      );

      const projectInfo =
        await detectProjectType(input.cwd);

      return {
        additionalContext:
          `This is a ${projectInfo.type} project.\n`
          + `Main language: `
          + `${projectInfo.language}\n`
          + `Package manager: `
          + `${projectInfo.packageManager}`,
      };
    },
  },
});

Para obtener ejemplos en Python, consulte el github/copilot-sdk repositorio.

Gestionar la reanudación de la sesión

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      if (input.source === "resume") {
        const previousState =
          await loadSessionState(
            invocation.sessionId
          );

        return {
          additionalContext:
            `Session resumed. Previous context:\n`
            + `- Last topic: `
            + `${previousState.lastTopic}\n`
            + `- Open files: `
            + previousState.openFiles.join(", "),
        };
      }
      return null;
    },
  },
});

Cargar preferencias de usuario

const session = await client.createSession({
  hooks: {
    onSessionStart: async () => {
      const preferences =
        await loadUserPreferences();

      const contextParts = [];

      if (preferences.language) {
        contextParts.push(
          `Preferred language: `
          + `${preferences.language}`
        );
      }
      if (preferences.codeStyle) {
        contextParts.push(
          `Code style: ${preferences.codeStyle}`
        );
      }
      if (preferences.verbosity === "concise") {
        contextParts.push(
          "Keep responses brief and "
          + "to the point."
        );
      }

      return {
        additionalContext:
          contextParts.join("\n"),
      };
    },
  },
});

Gancho de final de sesión

El onSessionEnd hook se llama cuando finaliza una sesión.

Firma de hook

import {
  HookInvocation,
  SessionEndHookInput,
  SessionEndHookOutput,
} from "@github/copilot-sdk";

type SessionEndHandler = (
  input: SessionEndHookInput,
  invocation: HookInvocation
) => Promise<
  SessionEndHookOutput | null | undefined
>;

Para obtener firmas de enlace en Python, Go y .NET, consulte el github/copilot-sdk repositorio.

Entrada

Campo	Tipo	Descripción
timestamp	número	Marca de tiempo de Unix cuando se desencadenó el enlace
cwd	cuerda / cadena	Directorio de trabajo actual
reason	cuerda / cadena	Por qué finalizó la sesión (consulte la tabla siguiente)
finalMessage	string | indefinido	El último mensaje de la sesión
error	cadena | indefinido	Mensaje de error si la sesión finalizó debido a un error

Motivos de finalización

Motivo	Descripción
"complete"	La sesión se completó normalmente
"error"	La sesión finalizó debido a un error
"abort"	El usuario o el código anularon la sesión
"timeout"	La sesión ha caducado
"user_exit"	El usuario finalizó explícitamente la sesión

Salida

Campo	Tipo	Descripción
suppressOutput	boolean	Suprimir la salida final de la sesión
cleanupActions	string[]	Lista de acciones de limpieza que se van a realizar
sessionSummary	cuerda / cadena	Resumen de la sesión para el registro de eventos o las analíticas

Ejemplos

Seguimiento de las métricas de sesión

const sessionStartTimes =
  new Map<string, number>();

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      sessionStartTimes.set(
        invocation.sessionId, input.timestamp
      );
      return null;
    },
    onSessionEnd: async (
      input, invocation
    ) => {
      const startTime = sessionStartTimes.get(
        invocation.sessionId
      );
      const duration = startTime
        ? input.timestamp - startTime
        : 0;

      await recordMetrics({
        sessionId: invocation.sessionId,
        duration,
        endReason: input.reason,
      });

      sessionStartTimes.delete(
        invocation.sessionId
      );
      return null;
    },
  },
});

Para obtener ejemplos en Python, consulte el github/copilot-sdk repositorio.

Limpieza de recursos

const sessionResources =
  new Map<string, { tempFiles: string[] }>();

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      sessionResources.set(
        invocation.sessionId,
        { tempFiles: [] }
      );
      return null;
    },
    onSessionEnd: async (
      input, invocation
    ) => {
      const resources =
        sessionResources.get(
          invocation.sessionId
        );

      if (resources) {
        for (const file
          of resources.tempFiles) {
          await fs.unlink(file).catch(() => {});
        }
        sessionResources.delete(
          invocation.sessionId
        );
      }

      console.log(
        `Session ${invocation.sessionId} `
        + `ended: ${input.reason}`
      );
      return null;
    },
  },
});

Guardar el estado de sesión para reanudar

const session = await client.createSession({
  hooks: {
    onSessionEnd: async (input, invocation) => {
      if (input.reason !== "error") {
        // Save state for potential resume
        await saveSessionState(invocation.sessionId, {
          endTime: input.timestamp,
          cwd: input.cwd,
          reason: input.reason,
        });
      }
      return null;
    },
  },
});

Resumen de la sesión de registro

const sessionData: Record<
  string,
  { prompts: number; tools: number;
    startTime: number }
> = {};

const session = await client.createSession({
  hooks: {
    onSessionStart: async (
      input, invocation
    ) => {
      sessionData[invocation.sessionId] = {
        prompts: 0,
        tools: 0,
        startTime: input.timestamp,
      };
      return null;
    },
    onUserPromptSubmitted: async (
      _, invocation
    ) => {
      sessionData[
        invocation.sessionId
      ].prompts++;
      return null;
    },
    onPreToolUse: async (_, invocation) => {
      sessionData[
        invocation.sessionId
      ].tools++;
      return { permissionDecision: "allow" };
    },
    onSessionEnd: async (
      input, invocation
    ) => {
      const data =
        sessionData[invocation.sessionId];
      const durationSec =
        (input.timestamp - data.startTime)
        / 1000;
      console.log(
        `Session Summary:\n`
        + `  ID: ${invocation.sessionId}\n`
        + `  Duration: ${durationSec}s\n`
        + `  Prompts: ${data.prompts}\n`
        + `  Tool calls: ${data.tools}\n`
        + `  End reason: ${input.reason}`
      );

      delete sessionData[
        invocation.sessionId
      ];
      return null;
    },
  },
});

procedimientos recomendados

•         **Manténgase `onSessionStart` rápido.** Los usuarios esperan a que la sesión esté lista.
  

•         **Controle todas las razones finales.** No debe asumir que las sesiones terminan limpiamente; gestione errores e interrupciones.
  

•         **Limpie los recursos.** Use `onSessionEnd` para liberar los recursos asignados durante la sesión.
  

•         **Almacenar el estado mínimo.** Si realiza el seguimiento de los datos de la sesión, manténgalos ligeros.
  

•         **Asegúrate de que la depuración sea idempotente.** 
          `onSessionEnd` puede que no se invoque si el proceso se bloquea.
  

Lectura adicional

•         [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/quickstart)
  

•         [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/error-handling)
  

•         [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/user-prompt-submitted)