AgentsOperations interface

Solicita la cancelación de un trabajo en curso o en cola. Devuelve 409 Conflicto si el trabajo ya está en estado terminal.

cancelOptimizationJob: (jobId: string, options?: AgentsCancelOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Valor de propiedad

Crea un trabajo de optimización y devuelve el trabajo en cola. Honores Operation-Id por reintento idempotente. Los clientes consultan la URL Operation-Location usando la operación get.

createOptimizationJob: (job: AgentOptimizationJob, options?: AgentsCreateOptimizationJobOptionalParams) => JobPoller<AgentOptimizationJobResult>

Valor de propiedad

Crea una nueva sesión para un endpoint agente. El endpoint resuelve la versión del agente de respaldo desde version_indicator y hace cumplir la propiedad de la sesión usando la clave de aislamiento proporcionada para las operaciones de mutación de sesión.

createSession: (agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

Valor de propiedad

Crea una nueva versión del agente a partir del código. Sube el código postal y crea una nueva versión para un agente existente. El resumen hexadecimal SHA-256 del zip se proporciona en el x-ms-code-zip-sha256 encabezado para integridad y deduplicación. El cuerpo de la solicitud es multipart/formulario con una parte de metadatos JSON y una parte de código binario (el orden de las piezas es irrelevante). El tamaño máximo de subida es de 250 MB.

createVersionFromCode: (agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

Valor de propiedad

Elimina un agente. Para los agentes alojados, si alguna versión tiene sesiones activas, la solicitud se rechaza con HTTP 409 a menos que force se ponga como true. Cuando la fuerza es verdadera, todas las sesiones asociadas se eliminan en cascada junto con el agente y sus versiones.

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

Valor de propiedad

Cancela el trabajo activo y luego elimina el trabajo y sus artefactos candidatos.

deleteOptimizationJob: (jobId: string, options?: AgentsDeleteOptimizationJobOptionalParams) => Promise<void>

Valor de propiedad

Elimina una sesión de forma síncrona. Devuelve 204 Sin contenido cuando la sesión se elimina o no existe.

deleteSession: (agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

Valor de propiedad

Elimina el archivo o directorio especificado del sandbox de sesión. Cuando recursive es falso, eliminar un directorio no vacío devuelve 409 Conflicto.

deleteSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

Valor de propiedad

Elimina una versión específica de un agente. Para los agentes alojados, si la versión tiene sesiones activas, la solicitud se rechaza con HTTP 409 a menos que force se ponga en true. Cuando la fuerza es verdadera, todas las sesiones asociadas a esta versión se eliminan en cascada.

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

Valor de propiedad

Desactiva el agente especificado, impidiéndole aceptar nuevas sesiones o procesar solicitudes. Las sesiones activas existentes pueden drenarse de forma elegante, pero no se pueden crear nuevas sesiones. Esta operación es idempotente: desactivar a un agente ya discapacitado devuelve el éxito sin efectos secundarios.

disable: (agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

Valor de propiedad

Descarga el código postal de un agente alojado basado en código. Devuelve el código postal previamente subido (application/zip).

Si agent_version se proporciona, devuelve el código zip de esa versión; de lo contrario, devuelve el código zip de la última versión.

El resumen SHA-256 de los bytes devueltos coincide con el content_hash de la versión code_configurationresuelta .

downloadAgentCode: (agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

Valor de propiedad

Descarga el archivo en la ruta sandbox especificada como un flujo binario. La ruta se resuelve en relación con el directorio principal de la sesión.

downloadSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Valor de propiedad

Activa el agente especificado, permitiéndole aceptar nuevas sesiones y procesar solicitudes. Esta operación es idempotente: permitir que un agente ya habilitado devuelva el éxito sin efectos secundarios.

enable: (agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

Valor de propiedad

Estima las filas del conjunto de validación, los volúmenes de llamadas por etapa del modelo y las bandas de costes sin enviar el trabajo.

estimateOptimizationJob: (inputs: AgentOptimizationEstimateInputs, options?: AgentsEstimateOptimizationJobOptionalParams) => Promise<AgentOptimizationEstimateResult>

Valor de propiedad

Recupera el agente.

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

Valor de propiedad

Genera el paquete de aplicaciones de Microsoft Teams (zip) para un agente de Foundry a partir de la solicitud de publicación proporcionada, sin publicarla. Devuelve el paquete de la app como application/zip.

getMicrosoft365Package: (agentName: string, publishScope: Microsoft365PublishScope, options?: GetMicrosoft365PackageOptionalParams) => Promise<GetMicrosoft365PackageResponse>

Valor de propiedad

Devuelve valores por defecto y previamente publicados usados para precompletar una solicitud de publicación de Microsoft 365 para un agente de Foundry.

getMicrosoft365PublishDefaults: (agentName: string, options?: GetMicrosoft365PublishDefaultsOptionalParams) => Promise<Microsoft365PublishDefaults>

Valor de propiedad

Recupera un solo candidato. Los valores de mutación siempre están incluidos.

getOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsGetOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Valor de propiedad

Recupera un trabajo de optimización por su identificador.

getOptimizationJob: (jobId: string, options?: AgentsGetOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Valor de propiedad

Recupera los detalles de una sesión de agente alojada por nombre del agente e identificador de sesión.

getSession: (agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

Valor de propiedad

Transmite los registros de consola (stdout / stderr) para una sesión de agente alojada específica como un flujo de Server-Sent Eventos (SSE).

Cada trama SSE contiene:

• event: siempre "log"
• data: una línea de registro en texto plano (actualmente con formato JSON, pero el esquema no es contractual y puede incluir claves adicionales o cambiar de formato con el tiempo — los clientes deben tratarla como una cadena opaca)

Ejemplos de tramas SSE:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"}

event: log
data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}

event: log
data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}

La transmisión permanece abierta hasta que el cliente se desconecta o el servidor termina la conexión. Los clientes deben gestionar la reconexión según sea necesario.

getSessionLogStream: (agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Valor de propiedad

Recupera una versión específica de un agente.

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

Valor de propiedad

Devuelve la lista de todos los agentes.

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Valor de propiedad

Lista los candidatos para el puesto de optimización con paginación de cursor, incluyendo la línea base original y los candidatos generados. Cada output.mutations elemento identifica un atributo modificado mediante type; los campos de mutación value se omiten a menos que el cliente pase expand=mutations.

listOptimizationCandidates: (jobId: string, options?: AgentsListOptimizationCandidatesOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationCandidate, AgentOptimizationCandidate[], PageSettings>

Valor de propiedad

Lista trabajos de optimización con paginación por cursor y filtros opcionales de estado o nombre de agente.

listOptimizationJobs: (options?: AgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationJob, AgentOptimizationJob[], PageSettings>

Valor de propiedad

Devuelve archivos y directorios en la ruta especificada en el sandbox de sesión. La respuesta incluye solo a los hijos inmediatos del directorio destino y por defecto pasa al directorio principal de la sesión cuando no se proporciona ruta.

listSessionFiles: (agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

Valor de propiedad

Devuelve una colección paginada de sesiones asociadas al punto final del agente especificado.

listSessions: (agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

Valor de propiedad

Devuelve la lista de versiones de un agente.

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Valor de propiedad

Modifica un agente existente.

patchAgentObject: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Valor de propiedad

Promociona a un candidato al agente de Foundry almacenado en la configuración de destino del trabajo principal. No hay promoción disponible cuando el puesto se target_configuration. La promoción de agente de prompt crea una nueva versión para agente. Actualmente, la promoción por agente hospedado registra los metadatos de la promoción sin desplegar una nueva versión para agente alojado.

promoteOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsPromoteOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Valor de propiedad

Publica un agente de Foundry en Microsoft 365 / Microsoft Teams y devuelve el título publicado y los identificadores de la app de Teams.

publishToMicrosoft365: (agentName: string, publishScope: Microsoft365PublishScope, options?: PublishToMicrosoft365OptionalParams) => Promise<Microsoft365PublishResponse>

Valor de propiedad

Termina la sesión del agente alojado especificada y devuelve 204 Sin contenido cuando la solicitud tiene éxito.

stopSession: (agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

Valor de propiedad

Aplica una actualización de parche de fusión a la configuración de endpoint agente especificada.

updateAgent: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Valor de propiedad

Sube el contenido binario de archivos a la ruta especificada en el sandbox de sesión. El servicio almacena el archivo en relación con el directorio principal de la sesión y rechaza cargas útiles mayores a 50 MB.

uploadSessionFile: (agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

Valor de propiedad

Crea el agente.

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

Parámetros

Devoluciones

Crea un agente a partir de un manifiesto.

function create(name: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

Parámetros

Devoluciones

Cree una nueva versión del agente.

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateVersionOptionalParams): Promise<AgentVersion>

Parámetros

Devoluciones

Cree una nueva versión del agente a partir de un manifiesto.

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

Parámetros

Devoluciones

Actualiza el agente agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

Parámetros

Devoluciones

Actualiza el agente desde un manifiesto agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

function update(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parámetros

Devoluciones