Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
See how MongoDB 9.0 delivers up to 2x higher throughput.
MongoDB Branding Shape
Register now >
Menu Docs
Página inicial do Docs
/ /
Agent-Engine- Runner-Shared
Página inicial do Docs
/ /
JavaScript SDK
/
Agent-Engine- Runner-Shared
Página inicial do Docs
/
Mecanismo do Atlas Agent
/
Atlas Agent Engine SDK
/
JavaScript SDK
/
Agent-Engine- Runner-Shared

@mongodb-js/agent-engine-run-shared

Sumário

Namespaces

chunkTypes

variáveis

CUSTOM_EVENT
const CUSTOM_EVENT: "custom_event" = "custom_event";
FITO
const DONE: "done" = "done";
ERROR
const ERROR: "error" = "error";
LLM_CREDENTIAL_REJECTED_ERROR_CODE
const LLM_CREDENTIAL_REJECTED_ERROR_CODE: "llm_credential_rejected" = "llm_credential_rejected";

Discriminador legível por máquina definido em metadata.error_code quando o provedor LLM rejeitou a credencial configurada (HTTP 401/403). Ao contrário de llm_invocation_failed, ele é deliberadamente carimboado sem metadata.source: a correção é o segredo do projeto do próprio cliente e a chave de proprietário do gateway mapeia o código simples para pertencente ao cliente, enquanto uma fonte llm o atribuiria à flakiness do provedor.

LLM_INVOCATION_ERROR_CODE
const LLM_INVOCATION_ERROR_CODE: "llm_invocation_failed" = "llm_invocation_failed";

Discriminador legível por máquina definido em metadata.error_code de um chunk/ chamada de resposta de ERRO quando a chamada LLM do agente falhou após a aprovação do OE (provider 401/404, limite de taxa etc.). metadata.source é llm, portanto, a atribuição de invocações não precisa corresponder à prosa de erro.

LLM_INVOCATION_ERROR_SOURCE
const LLM_INVOCATION_ERROR_SOURCE: "llm" = "llm";

Atribuição de proprietário para falhas do fornecedor LLM. Deve corresponder à chave de origem invocador-proprietário do gateway.

POLICY_DENIED_ERROR_CODE
const POLICY_DENIED_ERROR_CODE: "policy_denied" = "policy_denied";
Etapa
const STEP: "step" = "step";
SUBAGENT_END
const SUBAGENT_END: "subagent_end" = "subagent_end";
SUBAGENT_START
const SUBAGENT_START: "subagent_start" = "subagent_start";
TEXT
const TEXT: "text" = "text";

Constantes do protocolo de fio para blocos de fluxo AER → OE .

Centralizado para que um erro de digitação em um site não possa dessincronizar silenciosamente o consumidor. Os valores são cadeias de caracteres estáveis encaminhadas textualmente por OE para o gateway da API e para a UI; não renomeie sem coordenar todas as três camadas (e o modelo Go-side StreamChunk).

TIMEOUT_ERROR_CODE
const TIMEOUT_ERROR_CODE: "timeout" = "timeout";

Discriminador legível por máquina definido em metadata.error_code de um bloco/ chamada de resposta de ERRO quando um prazo expirou em vez de o trabalho falhar. Abrange ambos os tipos - uma ultrapassagem de ferramenta/chamada de LLM e toda a reviravolta - porque a resposta do consumidor a qualquer uma delas é a mesma: oferecer mais tempo ou uma nova tentativa, não um relatório de bug. Encaminhado verbatim como os valores acima.

TOOL_CREDENTIAL_REJECTED_ERROR_CODE
const TOOL_CREDENTIAL_REJECTED_ERROR_CODE: "tool_credential_rejected" = "tool_credential_rejected";

A mesma portadora quando uma execução falha porque a falha classificada como API externa de uma chamada de ferramenta foi uma rejeitada de autenticação (AUTH_FAILED): a credencial rejeitada é um dos segredos do projeto para essa ferramenta, não a chave LLM. Também carimbo sem metadata.source, então o código gera uma atribuição de propriedade do cliente.

Enumerações

ActivityKind

O ActivityKind categoriza uma operação não determinística repetível.

gerado

de enumeração mongodb.agentic.workflow.v1.ActivityKind

Membros da enumeração

Membro da Enumeração
Valor
Descrição

LLM

1

Gerado a partir do valor de enumeração : actIVity_KIND_LLM = 1;

MEMORY

3

Gerado a partir do valor de enumeração : actIVity_KIND_MEMORY = 3;

TOOL

2

Gerado a partir do valor de enumeração : actIVity_KIND_TOOL = 2;

UNSPECIFIED

0

Gerado a partir do valor de enumeração : actIVity_Kind_UNspecIFied = 0;

ActivityOutcomeKind

ActivityOutcomeKind descreve um resultado de atividade em série durável.

gerado

de enumeração mongodb.agentic.workflow.v1.ActivityOutcomeKind

Membros da enumeração

Membro da Enumeração
Valor
Descrição

COMPLETED

1

Gerado a partir do valor de enumeração : actIVity_outcome_kind_completed = 1;

DENIED

3

Gerado a partir do valor de enumeração : actIVity_outcome_kind_denied = 3;

FAILED

2

Gerado a partir do valor de enumeração : actIVity_OUTCOME_KIND_FAILED = 2;

SUSPENDED

4

Gerado a partir do valor de enumeração : actIVity_OUTCOME_KIND_SUSPENDED = 4;

UNSPECIFIED

0

Gerado a partir do valor de enumeração : actIVity_outcome_kind_unspecified = 0;

messageRole

MensagemRole identifica o papel de conversação de uma mensagem de fluxo de trabalho.

gerado

de enumeração mongodb.agentic.workflow.v1.MessageRole

Membros da enumeração

Membro da Enumeração
Valor
Descrição

ASSISTANT

2

Gerado a partir do valor de enumeração : MESSAGE_ROLE_ASSISTANT = 2;

SYSTEM

4

Gerado a partir do valor de enumeração : MESSAGE_ROLE_SYSTEM = 4;

TOOL

3

Gerado a partir do valor de enumeração : MESSAGE_ROLE_TOOL = 3;

UNSPECIFIED

0

Gerado a partir do valor de enumeração : MESSAGE_ROLE_UNSPECIFIED = 0;

USER

1

Gerado a partir do valor de enumeração : MESSAGE_ROLE_USER = 1;

RuntimeMode

modo de tempo de execução para o Runner SDK.

Membros da enumeração

Membro da Enumeração
Valor

AER

"aer"

TOOL

"tool"

TOOL_FUNCTION

"tool_function"

WorkflowErrorCode

WorkflowErrorCode é o vocabulário estável de falhas de fluxo de trabalho entre linguagens.

gerado

de enumeração mongodb.agentic.workflow.v1.WorkflowErrorCode

Membros da enumeração

Membro da Enumeração
Valor
Descrição

CONFLICT

3

Gerado a partir do valor do enumeração : WORKFlow_error_CODE_CONFLICT = 3;

INVALID_ARGUMENT

1

Gerado a partir do valor do enumeração : WORKFlow_error_CODE_INVALID_ARGUMENT = 1;

NONDETERMINISTIC

5

Gerado a partir do valor do enumeração : WORKFlow_error_CODE_NONDETERMINISTIC = 5;

NOT_FOUND

2

Gerado a partir do valor de enumeração : WORKFlow_error_CODE_NOT_FOUND = 2;

OUTCOME_UNKNOWN

7

Gerado a partir do valor de enumeração : WORKFlow_error_CODE_OUTCOME_UNKNOWN = 7;

STALE_FENCE

4

Gerado a partir do valor de enumeração : WORKFlow_ERROR_CODE_Stale_Fence = 4;

UNAUTHORIZED

8

Gerado a partir do valor de enumeração : WORKFlow_error_CODE_UNAUThorIZED = 8;

UNSPECIFIED

0

Gerado a partir do valor de enumeração : WORKFlow_error_CODE_UNSPECIFIED = 0;

VERSION_UNAVAILABLE

6

Gerado a partir do valor de enumeração : WORKFlow_ERROR_CODE_VERSION_UNAVAILABLE = 6;

Aulas

ActivityDispatch

Constructor

new ActivityDispatch(context): ActivityDispatch;

Parâmetros

Parâmetro
Tipo

context

`ActivityContext <#activitycontext>`__

Devoluções

`ActivityDispatch <#activitydispatch>`__

Propriedades

Propriedade
Modifier
Tipo

context

readonly

`ActivityContext <#activitycontext>`__

ActivityReplay

Constructor

new ActivityReplay(outcome): ActivityReplay;

Parâmetros

Parâmetro
Tipo

outcome

`ActivityOutcome <#activityoutcome>`__

Devoluções

`ActivityReplay <#atividadereplay>`__

Propriedades

Propriedade
Modifier
Tipo

outcome

readonly

`ActivityOutcome <#activityoutcome>`__

AERServer

Estende-se

  • BaseServer

Constructor

new AERServer(runtime): AERServer;

Parâmetros

Parâmetro
Tipo

runtime

`ITenantRuntime <#itenantruntime>`__

Devoluções

`AERServer <#aerserver>'__

Herdado de

BaseServer.constructor

Propriedades

Propriedade
Modifier
Tipo
Valor padrão
Herdado de

app

protected

| FastifyInstance <RawServerDefault, IncomingMessage, ServerResponse <IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault> | null

null

BaseServer.app

ownerCallbackUrl

public

Map <string, string>

undefined

pendingSessionFinish

public

Set <string>

undefined

runtime

readonly

`ITenantRuntime <#itenantruntime>`__

undefined

BaseServer.runtime

Acessores

defaultPort

Obter assinatura

get defaultPort(): number;

Devoluções

number

Herdado de

BaseServer.defaultPort
drainRegistry

Obter assinatura

get drainRegistry(): DrainRegistry;

Estado de drenagem com escopo de execução para POST /drain; as rotas de trabalho são registradas nele para que o trabalho a bordo de uma execução cancelada possa ser interrompido. Criado de forma preguiçosa no protótipo para que os testes que ignoram o construtor (Object.create) ainda obtenham um registro funcional.

Devoluções

DrainRegistry

Herdado de

BaseServer.drainRegistry
modeName

Obter assinatura

get modeName(): string;

Devoluções

string

Substitui

BaseServer.modeName

Métodos

close()
close(): Promise<void>;

Feche graciosamente o servidor Fastify subjacente, drenagem solicitações a bordo e executando ganchos onClose. Nenhum oplog se o aplicativo nunca foi criado.

Devoluções

Promise <void>

Herdado de

BaseServer.close
createApp()
createApp(): FastifyInstance;

Devoluções

FastifyInstance

Herdado de

BaseServer.createApp
getHealthDetails()
getHealthDetails(): Record<string, unknown>;

Devoluções

Record <string, unknown>

Substitui

BaseServer.getHealthDetails
onShutdown()
onShutdown(): Promise<void>;

Devoluções

Promise <void>

Substitui

BaseServer.onShutdown
onStartup()
onStartup(): Promise<void>;

Devoluções

Promise <void>

Substitui

BaseServer.onStartup
registrarCommonRoutes()
protected registerCommonRoutes(app): void;

Parâmetros

Parâmetro
Tipo

app

FastifyInstance

Devoluções

void

Herdado de

BaseServer.registerCommonRoutes
registrarRoutes()
registerRoutes(app): void;

Parâmetros

Parâmetro
Tipo

app

FastifyInstance

Devoluções

void

Substitui

BaseServer.registerRoutes
run()
run(host?, port?): Promise<void>;

Parâmetros

Parâmetro
Tipo
Valor padrão

host

string

"0.0.0.0"

port?

number

undefined

Devoluções

Promise <void>

Herdado de

BaseServer.run

AppBoundCrudClient

MemoryCrudClient pelo proxy de memória OE.

Implementos

  • MemoryCrudClient

Constructor

new AppBoundCrudClient(): AppBoundCrudClient;

Devoluções

`AppBoundCrudClient <#appboundrudclient>'__

Métodos

createCustom()
createCustom(args): Promise<{
  has_embedding: boolean;
  id: string;
  tags: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
  type: string;
}>;

A identidade é marcada pela plataforma.

Parâmetros

Parâmetro
Tipo

args

{ content: string; contextualMetadata?: Record <string, unknown> | null; memoryType: string; tags?: Record <string, unknown> | null; }

args.content

string

args.contextualMetadata?

Record <string, unknown> | null

args.memoryType

string

args.tags?

Record <string, unknown> | null

Devoluções

Promise <{ has_embedding: boolean; id: string; tags: z.ZodRecord <z.ZodString, z.ZodUnion <readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>; type: string; }>

Implementação de

MemoryCrudClient.createCustom
createEpisodic()
createEpisodic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  title: string;
}>;

Parâmetros

Parâmetro
Tipo

args

{ agentId?: string | null; content: string; metadata?: Record <string, unknown> | null; participants?: string [] | null; sessionId: string; summaryText?: string | null; tags?: string [] | null; title: string; userId: string; visibility?: string; }

args.agentId?

string | null

args.content

string

args.metadata?

Record <string, unknown> | null

args.participants?

string [] | null

args.sessionId

string

args.summaryText?

string | null

args.tags?

string [] | null

args.title

string

args.userId

string

args.visibility?

string

Devoluções

Promise <{ acknowledged: boolean; has_embedding: boolean; id: string; title: string; }>

Implementação de

MemoryCrudClient.createEpisodic
createProcedural()
createProcedural(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  procedure: string;
}>;

Parâmetros

Parâmetro
Tipo

args

{ agentId?: string | null; allowedTools?: string [] | null; compatibility?: string | null; content: string; description: string; extractionSource?: string | null; license?: string | null; procedure: string; resources?: Record <string, unknown>[] | null; sourceFormat?: string | null; sourcePath?: string | null; steps?: Record <string, unknown>[] | null; tags?: string [] | null; triggerConditions?: string [] | null; updateExisting?: boolean; userId: string; visibility?: string; }

args.agentId?

string | null

args.allowedTools?

string [] | null

args.compatibility?

string | null

args.content

string

args.description

string

args.extractionSource?

string | null

args.license?

string | null

args.procedure

string

args.resources?

Record <string, unknown>[] | null

args.sourceFormat?

string | null

args.sourcePath?

string | null

args.steps?

Record <string, unknown>[] | null

args.tags?

string [] | null

args.triggerConditions?

string [] | null

args.updateExisting?

boolean

args.userId

string

args.visibility?

string

Devoluções

Promise <{ acknowledged: boolean; has_embedding: boolean; id: string; procedure: string; }>

Implementação de

MemoryCrudClient.createProcedural
createSemantic()
createSemantic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  label: string;
}>;

Parâmetros

Parâmetro
Tipo

args

{ agentId?: string | null; label: string; metadata?: Record <string, unknown> | null; source?: string; text: string; upsert?: boolean; userId: string; visibility?: string; }

args.agentId?

string | null

args.label

string

args.metadata?

Record <string, unknown> | null

args.source?

string

args.text

string

args.upsert?

boolean

args.userId

string

args.visibility?

string

Devoluções

Promise <{ acknowledged: boolean; has_embedding: boolean; id: string; label: string; }>

Implementação de

MemoryCrudClient.createSemantic
createTaxonomic()
createTaxonomic(args): Promise<{
  acknowledged: boolean;
  domain: string;
  has_embedding: boolean;
  id: string;
  term: string;
}>;

Parâmetros

Parâmetro
Tipo

args

{ definition: string; domain: string; relatedTerms?: string [] | null; term: string; userId: string; visibility?: string; }

args.definition

string

args.domain

string

args.relatedTerms?

string [] | null

args.term

string

args.userId

string

args.visibility?

string

Devoluções

Promise <{ acknowledged: boolean; domain: string; has_embedding: boolean; id: string; term: string; }>

Implementação de

MemoryCrudClient.createTaxonomic
getDistinctDomains()
getDistinctDomains(args): Promise<string[]>;

Parâmetros

Parâmetro
Tipo

args

{ visibility?: string | null; }

args.visibility?

string | null

Devoluções

Promise <string []>

Implementação de

MemoryCrudClient.getDistinctDomains
getProcedural()
getProcedural(args): Promise<unknown>;

Parâmetros

Parâmetro
Tipo

args

{ includeDeleted?: boolean; procedure?: string | null; userId?: string | null; visibility?: string | null; }

args.includeDeleted?

boolean

args.procedure?

string | null

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <unknown>

Implementação de

MemoryCrudClient.getProcedural
getSemantic()
getSemantic(args): Promise<unknown>;

Parâmetros

Parâmetro
Tipo

args

{ label: string; userId?: string | null; visibility?: string | null; }

args.label

string

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <unknown>

Implementação de

MemoryCrudClient.getSemantic
getTaxonomic()
getTaxonomic(args): Promise<unknown>;

Parâmetros

Parâmetro
Tipo

args

{ domain: string; term?: string | null; userId?: string | null; visibility?: string | null; }

args.domain

string

args.term?

string | null

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <unknown>

Implementação de

MemoryCrudClient.getTaxonomic
listEpisodic()
listEpisodic(args): Promise<unknown[]>;

Parâmetros

Parâmetro
Tipo

args

{ limit?: number; sessionId?: string | null; userId?: string | null; visibility?: string | null; }

args.limit?

number

args.sessionId?

string | null

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <unknown []>

Implementação de

MemoryCrudClient.listEpisodic
retrieveCustom()
retrieveCustom(args): Promise<{
  count: number;
  results: object[];
}>;

A identidade é marcada pela plataforma.

Parâmetros

Parâmetro
Tipo

args

{ memoryType: string; query: string; tags?: Record <string, unknown> | null; topK?: number; }

args.memoryType

string

args.query

string

args.tags?

Record <string, unknown> | null

args.topK?

number

Devoluções

Promise <{ count: number; results: object []; }>

Implementação de

MemoryCrudClient.retrieveCustom

AppBoundRuntime

MemoryRuntime sobre o proxy de memória OE, expondo a identidade do ambiente.

Implementos

  • MemoryRuntime

Constructor

new AppBoundRuntime(): AppBoundRuntime;

Devoluções

`AppBoundRuntime <#appboundruntime>`__

Métodos

buildContext()
buildContext(args): Promise<{
  formatted_context: string | Record<string, unknown>[];
  metadata: {
     memory_counts: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     timing: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     token_count: number;
  };
  selected_memories?: object[] | null;
}>;

Parâmetros

Parâmetro
Tipo
Descrição

args

{ enabledSources?: Set <string> | null; maxTokens?: number; metadataFilter?: Record <string, unknown> | null; query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.enabledSources?

Set <string> | null

args.maxTokens?

number

orçamento bruto opcional para construção de contexto. Após a recuperação e a classificação, o servidor subtrai uma reserva de formatação de 500-token e, em seguida, seleciona avidamente chunks de memória inteiros que cabem no restante. Valores positivos iguais ou inferiores a 500 não deixam orçamento para recordações. Valores acima de 500 ainda podem gerar um contexto vazio quando nenhum chunk se encaixa.

args.metadataFilter?

Record <string, unknown> | null

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <{ formatted_context: string | Record <string, unknown>[]; metadata: { memory_counts: z.ZodDefault <z.ZodRecord <z.ZodString, z.ZodNumber>>; timing: z.ZodDefault <z.ZodRecord <z.ZodString, z.ZodNumber>>; token_count: number; }; selected_memories?: object [] | null; }>

Implementação de

MemoryRuntime.buildContext
findProceduras()
discoverProcedures(args): Promise<Record<string, unknown>[]>;

Parâmetros

Parâmetro
Tipo

args

{ metadataFilter?: Record <string, unknown> | null; query: string; similarityThreshold?: number; tags?: string [] | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.metadataFilter?

Record <string, unknown> | null

args.query

string

args.similarityThreshold?

number

args.tags?

string [] | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <Record <string, unknown>[]>

Implementação de

MemoryRuntime.discoverProcedures
recordTurn()
recordTurn(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  session_id: string;
  turn_seq: number;
}>;

Parâmetros

Parâmetro
Tipo

args

{ agentId?: string | null; content?: string | null; idempotencyKey?: string | null; isError?: boolean; modelName?: string | null; role: string; sessionId?: string | null; toolCallId?: string | null; toolCalls?: Record <string, unknown>[] | null; toolName?: string | null; userId?: string | null; }

args.agentId?

string | null

args.content?

string | null

args.idempotencyKey?

string | null

args.isError?

boolean

args.modelName?

string | null

args.role

string

args.sessionId?

string | null

args.toolCallId?

string | null

args.toolCalls?

Record <string, unknown>[] | null

args.toolName?

string | null

args.userId?

string | null

Devoluções

Promise <{ acknowledged: boolean; has_embedding: boolean; id: string; session_id: string; turn_seq: number; }>

Implementação de

MemoryRuntime.recordTurn
requestContext()
requestContext(): MemoryRequestContext | null;

Identidade recente do contexto do running; Campos em branco são normalizados pela Fachada.

Devoluções

MemoryRequestContext | null

searchEpisodes()
searchEpisodes(args): Promise<object[]>;

Parâmetros

Parâmetro
Tipo

args

{ query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <object []>

Implementação de

MemoryRuntime.searchEpisodes
searchSemantic()
searchSemantic(args): Promise<object[]>;

Parâmetros

Parâmetro
Tipo

args

{ query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <object []>

Implementação de

MemoryRuntime.searchSemantic
searchTaxonomic()
searchTaxonomic(args): Promise<object[]>;

Parâmetros

Parâmetro
Tipo

args

{ domain?: string | null; query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.domain?

string | null

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

Devoluções

Promise <object []>

Implementação de

MemoryRuntime.searchTaxonomic

AttemptHeartbeat

Constructor

new AttemptHeartbeat(attempt, client): AttemptHeartbeat;

Parâmetros

Parâmetro
Tipo

attempt

`AttemptContext <#attemptcontext>`__

client

`WorkflowClient <#workflowclient>'__

Devoluções

`AttemptHeartbeat <#attempt heartbeat>`__

Métodos

start()
start(): Promise<void>;

Devoluções

Promise <void>

stop()
stop(): Promise<void>;

Devoluções

Promise <void>

Política de conteúdoOTLPSpanExporter

Envolve um SpanExporter OTLP, aplicando AGENTIC_PLATFORM_OTEL_CONTENT_CAPTURE. Falhas de redação falham no fechamento: um lote que não pode ser editado com segurança é descartado em vez de encaminhado sem edição, correspondendo à intenção de privacidade em primeiro lugar do padrão somente de metadados. Falhas de transporte no exportador envolto nunca são descartadas — elas são exibidas somente por meio de resultCallback.

Implementos

  • SpanExporter

Constructor

new ContentPolicyOTLPSpanExporter(inner, contentCaptureMode?): ContentPolicyOTLPSpanExporter;

Parâmetros

Parâmetro
Tipo

inner

SpanExporter

contentCaptureMode?

string

Devoluções

`ContentPolicyOTLPSpanExporter <#contentpolicyotlpspanexporter>`__

Métodos

export()
export(spans, resultCallback): void;

Chamado para exportar ReadableSpans amostrados.

Parâmetros

Parâmetro
Tipo
Descrição

spans

ReadableSpan []

a lista de spans amostrados a serem exportados.

resultCallback

(result) => void

Devoluções

void

Implementação de

SpanExporter.export
forceFlush()
forceFlush(): Promise<void>;

Exportar imediatamente todos os spans

Devoluções

Promise <void>

Implementação de

SpanExporter.forceFlush
shutdown()
shutdown(): Promise<void>;

Interrompe o exportador.

Devoluções

Promise <void>

Implementação de

SpanExporter.shutdown

DurableActivityDeniedError

Estende-se

  • Error

Constructor

new DurableActivityDeniedError(message, options?): DurableActivityDeniedError;

Parâmetros

Parâmetro
Tipo

message

string

options?

ErrorOptions

Devoluções

`DurableActivityDeniedError <#durableactivitydeniederror>`__

Substitui

Error.constructor

DurableActivityInterrupted

Estende-se

  • Error

Constructor

new DurableActivityInterrupted(controlFlow): DurableActivityInterrupted;

Parâmetros

Parâmetro
Tipo

controlFlow

unknown

Devoluções

`DurableActivityInterrupted <#durableactivityinterrupted>`__

Substitui

Error.constructor

Propriedades

Propriedade
Modifier
Tipo

controlFlow

readonly

unknown

DurableMemoryState

projeção de memória durável própria, entrega e entrada pendente do usuário.

Constructor

new DurableMemoryState(pendingUserMessage?): DurableMemoryState;

Parâmetros

Parâmetro
Tipo
Valor padrão

pendingUserMessage

string | null

null

Devoluções

`DurableMemoryState <#durablememorystate>`__

Métodos

syncLlm()
synchronizeLlm(
   client,
   context,
   result,
   userId
): Promise<void>;

Parâmetros

Parâmetro
Tipo

client

WorkflowMemoryClient

context

`ActivityContext <#activitycontext>`__

result

unknown

userId

string | null | undefined

Devoluções

Promise <void>

syncTool()
synchronizeTool(
   client,
   context,
   result,
   userId,
   toolCallId,
   toolName
): Promise<void>;

Parâmetros

Parâmetro
Tipo

client

WorkflowMemoryClient

context

`ActivityContext <#activitycontext>`__

result

unknown

userId

string | null | undefined

toolCallId

string | undefined

toolName

string

Devoluções

Promise <void>

InternalAPICallError

Gerado quando a execução da ferramenta falha.

Estende-se

  • `ToolExecutionError <#toolexecutionerror>`__

Constructor

new ExternalAPICallError(
   error,
   toolApiError,
   options?
): ExternalAPICallError;

Parâmetros

Parâmetro
Tipo

error

string

toolApiError

{ classification: string; error_code?: string | null; http_status?: number | null; provider_type?: string | null; reason?: string | null; retryable: boolean; }

toolApiError.classification

string

toolApiError.error_code?

string | null

toolApiError.http_status?

number | null

toolApiError.provider_type?

string | null

toolApiError.reason?

string | null

toolApiError.retryable?

boolean

options?

ErrorOptions

Devoluções

`ExternalAPICallError <#externalapicallerror>`__

Substitui

`ToolExecutionError <#toolexecutionerror>`__. `constructor <#constructor-35>`__

Propriedades

Propriedade
Modifier
Tipo
Herdado de

error

readonly

string

`ToolExecutionError <#toolexecutionerror>`__. `error <#property-error-4>`__

tool_api_error

readonly

object

tool_api_error.classification

public

string

tool_api_error.error_code?

public

string | null

tool_api_error.http_status?

public

number | null

tool_api_error.provider_type?

public

string | null

tool_api_error.reason?

public

string | null

tool_api_error.retryable

public

boolean

JSONLSpanExporter

Implementos

  • SpanExporter

Constructor

new JSONLSpanExporter(path?): JSONLSpanExporter;

Parâmetros

Parâmetro
Tipo

path?

string

Devoluções

`JSONLSpanExporter <#jsonlspanexporter>`__

Métodos

export()
export(spans, resultCallback): void;

Chamado para exportar ReadableSpans amostrados.

Parâmetros

Parâmetro
Tipo
Descrição

spans

ReadableSpan []

a lista de spans amostrados a serem exportados.

resultCallback

(result) => void

Devoluções

void

Implementação de

SpanExporter.export
forceFlush()
forceFlush(): Promise<void>;

Exportar imediatamente todos os spans

Devoluções

Promise <void>

Implementação de

SpanExporter.forceFlush
shutdown()
shutdown(): Promise<void>;

Interrompe o exportador.

Devoluções

Promise <void>

Implementação de

SpanExporter.shutdown

Erro de invocação do LLM

Estende-se

  • Error

Constructor

new LLMInvocationError(error, options?): LLMInvocationError;

Parâmetros

Parâmetro
Tipo

error

string

options?

ErrorOptions & object

Devoluções

`LLMInvocationError <#llminvocationerror>`__

Substitui

Error.constructor

Propriedades

Propriedade
Modifier
Tipo
Descrição

error

readonly

string

error_code?

readonly

string

Classificação legível por máquina que o pod de ferramenta carimbou na falha (por exemplo, uma rejeitação de credencial de fornecedor), quando isso ocorreu. Viagens para o OE/UI nos metadados do bloco ERROR em vez do código de invocação genérico para que os consumidores possam classificar sem prosa de correspondência de string.

source?

readonly

string

Atribuição do proprietário invocador. Apenas "llm" significa que o provedor falhou.

LLMInvocaçãoOptions

Opções explícitas de provedor/modelo passadas com uma invocação LLM.

Constructor

new LLMInvocationOptions(data): LLMInvocationOptions;

Parâmetros

Parâmetro
Tipo

data

{ [key: string]: unknown; frequency_penalty?: number; max_tokens?: number; parallel_tool_calls?: boolean; presence_penalty?: number; reasoning_effort?: string; response_format?: `JsonValue <#jsonvalue>`__; seed?: number; timeout?: number; top_k?: number; top_p?: number; }

data.frequency_penalty?

number

data.max_tokens?

number

data.parallel_tool_calls?

boolean

data.presence_penalty?

number

data.reasoning_effort?

string

data.response_format?

`JsonValue <#jsonvalue>`__

data.seed?

number

data.timeout?

number

data.top_k?

number

data.top_p?

number

Devoluções

`LLMInvocationOptions <#llmin preferenceoptions>`__

Propriedades

Propriedade
Modifier
Tipo
Descrição

extras

readonly

Record <string, unknown>

Kwares específicos do fornecedor que não estão no conjunto de campo padrão (por exemplo, temperatura). Espelha o extra= “permitir” do Python.

frequencyPenalty?

readonly

number

maxTokens?

readonly

number

parallelToolCalls?

readonly

boolean

presencePenalty?

readonly

number

reasoningEffort?

readonly

string

responseFormat?

readonly

`JsonValue <#jsonvalue>`__

seed?

readonly

number

timeout?

readonly

number

topK?

readonly

number

topP?

readonly

number

Métodos

toJSON()
toJSON(): Record<string, unknown>;

Serializa para o formato de fio snake_case para que JSON.stringify viaje de ida e volta por meio do LLMIn preferenceOptionsSchema.

Devoluções

Record <string, unknown>

toModelKservices()
toModelKwargs(): Record<string, unknown>;

Converte para kvarg para invocação de modelo subjacente. Espelha o model_dump(exclude_none=True) do Python com extra="allow".

Devoluções

Record <string, unknown>

LLMRegistryLoadError

Lançado quando uma pesquisa LLM falha porque o carregamento do registro do ponto de entrada falhou.

O registro nomeado-LLM é preenchido executando o ponto de entrada do usuário. Quando essa execução é lançada, o registro é deixado vazio (ou retendo apenas registros de tempo de importação) e todas as pesquisas de um LLM que o ponto de entrada teria registrado falham com um erro simples de “não registrado” – que aponta o desenvolvedor do agente para seu app.llm() chamadas em vez da causa transitória que realmente quebrou a carga. A causa real é mencionada somente na mensagem; ele não está anexado deliberadamente como cause, porque a resposta voltada para o chamador é renderizada por formatLlmError, que anda cause e despejaria um provedor bruto .details/.body de lá, ignorando a supressão da mensagem . Espelha o LLMRegistryLoadError do Python.

Estende-se

  • Error

Constructor

new LLMRegistryLoadError(message, options?): LLMRegistryLoadError;

Parâmetros

Parâmetro
Tipo

message

string

options?

ErrorOptions

Devoluções

`LLMRegistryLoadError <#llmregistryloaderror>`__

Substitui

Error.constructor

Resposta do LLM

Resposta LLM neutro em relação à estrutura.

Constructor

new LLMResponse(data): LLMResponse;

Parâmetros

Parâmetro
Tipo

data

{ additionalKwargs?: Record <string, `JsonValue <#jsonvalue>`__>; content: string; id?: string; metadata?: Record <string, `JsonValue <#jsonvalue>`__>; name?: string; responseMetadata?: Record <string, `JsonValue <#jsonvalue>`__>; toolCalls?: `LLMToolCall <#llmtoolcall>`__ []; usage?: `LLMTokenUsage <#llmtokenusage>`__; }

data.additionalKwargs?

Record <string, `JsonValue <#jsonvalue>`__>

data.content

string

data.id?

string

data.metadata?

Record <string, `JsonValue <#jsonvalue>`__>

data.name?

string

data.responseMetadata?

Record <string, `JsonValue <#jsonvalue>`__>

data.toolCalls?

`LLMToolCall <#llmtoolcall>`__ []

data.usage?

`LLMTokenUsage <#llmtokenusage>`__

Devoluções

`LLMResponse <#llmresponse>`__

Propriedades

Propriedade
Modifier
Tipo

additionalKwargs?

readonly

Record <string, `JsonValue <#jsonvalue>`__>

content

readonly

string

id?

readonly

string

metadata

readonly

Record <string, `JsonValue <#jsonvalue>`__>

name?

readonly

string

responseMetadata?

readonly

Record <string, `JsonValue <#jsonvalue>`__>

toolCalls?

readonly

`LLMToolCall <#llmtoolcall>`__ []

usage?

readonly

`LLMTokenUsage <#llmtokenusage>`__

Métodos

fromRaw()
static fromRaw(data): LLMResponse;

Constrói um LLMResponse a partir de um dicionário bruto do fornecedor, normalizando o uso de uma chave de " uso " de nível superior ou de chaves de token incorporadas em " metadados ".

Parâmetros

Parâmetro
Tipo

data

Record <string, unknown>

Devoluções

`LLMResponse <#llmresponse>`__

LLMResult

Resultado normalizado de uma invocação LLM.

Fornece uma forma consistente para respostas LLM, independentemente do provedor subjacente (OpenAI, Gêmeos, Antrópicos, etc.). Implementado como uma classe para espelhar LLMResponse no agente-engine-sdk e hospedar os métodos de conversão fromResponse / toResponse / extractUsage.

Constructor

new LLMResult(data): LLMResult;

Parâmetros

Parâmetro
Tipo

data

{ additionalKwargs?: Record <string, `JsonValue <#jsonvalue>`__>; content?: string; id?: string; metadata?: Record <string, `JsonValue <#jsonvalue>`__>; name?: string; responseMetadata?: Record <string, `JsonValue <#jsonvalue>`__>; toolCalls?: `LLMToolCall <#llmtoolcall>`__ []; usage?: `LLMTokenUsage <#llmtokenusage>`__; }

data.additionalKwargs?

Record <string, `JsonValue <#jsonvalue>`__>

data.content?

string

data.id?

string

data.metadata?

Record <string, `JsonValue <#jsonvalue>`__>

data.name?

string

data.responseMetadata?

Record <string, `JsonValue <#jsonvalue>`__>

data.toolCalls?

`LLMToolCall <#llmtoolcall>`__ []

data.usage?

`LLMTokenUsage <#llmtokenusage>`__

Devoluções

`LLMResult <#llmresult>`__

Propriedades

Propriedade
Modifier
Tipo

additionalKwargs?

readonly

Record <string, `JsonValue <#jsonvalue>`__>

content

readonly

string

id?

readonly

string

metadata

readonly

Record <string, `JsonValue <#jsonvalue>`__>

name?

readonly

string

responseMetadata?

readonly

Record <string, `JsonValue <#jsonvalue>`__>

toolCalls

readonly

`LLMToolCall <#llmtoolcall>`__ []

usage?

readonly

`LLMTokenUsage <#llmtokenusage>`__

Métodos

ToResponse()
toResponse(): LLMResponse;

Converta o resultado normalizado do executor para a forma LLMResponse do sdk-core.

Devoluções

`LLMResponse <#llmresponse>`__

extractUsage()
static extractUsage(response): LLMTokenUsage | undefined;

Extraia metadados de uso de token de qualquer resposta ou chunk.

Verificações (em ordem): sdk-core LLMResponse.usage, usage_metadata, response_metadata.usage, response_metadata.token_usage, usage, metadata.usage.

Parâmetros

Parâmetro
Tipo

response

unknown

Devoluções

`LLMTokenUsage <#llmtokenusage>`__ | undefined

fromResponse()
static fromResponse(response): LLMResult;

Extraia um resultado normalizado de qualquer objeto de resposta LLM.

Aceita um sdk-core LLMResponse diretamente ou um objeto do tipo Duck (por exemplo, resposta bruta do fornecedor), retornando à extração de conteúdo forçada por string.

Parâmetros

Parâmetro
Tipo

response

unknown

Devoluções

`LLMResult <#llmresult>`__

LLMTokenUsage

Metadados de uso de token digitados para chamadas LLM.

Constructor

new LLMTokenUsage(data): LLMTokenUsage;

Parâmetros

Parâmetro
Tipo

data

{ completion_tokens?: number; input_tokens?: number; model?: string; output_tokens?: number; prompt_tokens?: number; total_tokens?: number; }

data.completion_tokens?

number

data.input_tokens?

number

data.model?

string

data.output_tokens?

number

data.prompt_tokens?

number

data.total_tokens?

number

Devoluções

`LLMTokenUsage <#llmtokenusage>`__

Propriedades

Propriedade
Modifier
Tipo

completionTokens?

readonly

number

inputTokens?

readonly

number

model?

readonly

string

outputTokens?

readonly

number

promptTokens?

readonly

number

totalTokens?

public

number

Métodos

toJSON()
toJSON(): Record<string, unknown>;

Serializa para o formato de fio snake_case para que JSON.stringify ida e volta através de LLMTokenUsageSchema.

Devoluções

Record <string, unknown>

toLangchainUsageMetadata()
toLangchainUsageMetadata(): object;

Retorna as chaves de metadados de uso esperadas do LangChain.

Devoluções

object

Nome
Tipo

input_tokens

number

output_tokens

number

total_tokens

number

LLMToolCall

Chamada de ferramenta final digitada solicitada por um LLM.

Constructor

new LLMToolCall(data): LLMToolCall;

Parâmetros

Parâmetro
Tipo

data

{ args?: `JsonValue <#jsonvalue>`__; arguments?: `JsonValue <#jsonvalue>`__; id?: string; index?: number; name?: string; type?: string; }

data.args?

`JsonValue <#jsonvalue>`__

data.arguments?

`JsonValue <#jsonvalue>`__

data.id?

string

data.index?

number

data.name?

string

data.type?

string

Devoluções

`LLMToolCall <#llmtoolcall>`__

Propriedades

Propriedade
Modifier
Tipo

args?

readonly

`JsonValue <#jsonvalue>`__

id?

readonly

string

index?

readonly

number

name?

readonly

string

type?

readonly

string

Métodos

toLangchainDict()
toLangchainDict(): Record<string, JsonValue>;

Retorna um dicionário de chamada de ferramenta compatível com LangChain (exclui índice).

Devoluções

Record <string, `JsonValue <#jsonvalue>`__>

LLMToolSchema

Esquema de ferramenta de limite serializável encaminhado com uma chamada LLM.

Constructor

new LLMToolSchema(data): LLMToolSchema;

Parâmetros

Parâmetro
Tipo

data

{ description?: string; function?: `JsonValue <#jsonvalue>`__; name?: string; parameters?: `JsonValue <#jsonvalue>`__; strict?: boolean; type?: string; }

data.description?

string

data.function?

`JsonValue <#jsonvalue>`__

data.name?

string

data.parameters?

`JsonValue <#jsonvalue>`__

data.strict?

boolean

data.type?

string

Devoluções

`LLMToolSchema <#llmtoolschema>`__

Propriedades

Propriedade
Modifier
Tipo

description?

readonly

string

function?

readonly

`JsonValue <#jsonvalue>`__

name?

readonly

string

parameters?

readonly

`JsonValue <#jsonvalue>`__

strict?

readonly

boolean

type?

readonly

string

Métodos

toLangchainDict()
toLangchainDict(): Record<string, JsonValue>;

Retorna o esquema na forma que o LangChain bind_tools espera.

Devoluções

Record <string, `JsonValue <#jsonvalue>`__>

MCPConfigError

Gerado quando a configuração remota do MCP não pode ser resolvida.

Estende-se

  • Error

Constructor

new MCPConfigError(message): MCPConfigError;

Parâmetros

Parâmetro
Tipo

message

string

Devoluções

`MCPConfigError <#mcpconfigerror>`__

Substitui

Error.constructor

MCPToolError

Gerado quando uma ferramenta MCP remota retorna um resultado de erro MCP ou ocorre uma falha de transporte.

Estende-se

  • Error

Constructor

new MCPToolError(message): MCPToolError;

Parâmetros

Parâmetro
Tipo

message

string

Devoluções

`MCPToolError <#mcptoolerror>`__

Substitui

Error.constructor

Métricas

Constructor

new Metrics(): Metrics;

Devoluções

`Metrics <#metrics>`__

Métodos

getAll()
static getAll(): object;

Devoluções

object

Nome
Tipo

errors

Record <string, number>

latencies

Record <string, `LatencyStatsJson <#latencystatsjson>`__>

requests

Record <string, number>

recordError()
static recordError(operation, labels?): void;

Parâmetros

Parâmetro
Tipo

operation

string

labels

Record <string, string>

Devoluções

void

recordLatency()
static recordLatency(
   operation,
   durationMs,
   labels?
): void;

Parâmetros

Parâmetro
Tipo

operation

string

durationMs

number

labels

Record <string, string>

Devoluções

void

reiniciar()
static reset(): void;

Devoluções

void

MongoDBSpanExporter

Implementos

  • SpanExporter

Constructor

new MongoDBSpanExporter(collection): MongoDBSpanExporter;

Parâmetros

Parâmetro
Tipo

collection

Collection

Devoluções

`MongoDBSpanExporter <#mongodbspanexporter>`__

Métodos

export()
export(spans, resultCallback): void;

Chamado para exportar ReadableSpans amostrados.

Parâmetros

Parâmetro
Tipo
Descrição

spans

ReadableSpan []

a lista de spans amostrados a serem exportados.

resultCallback

(result) => void

Devoluções

void

Implementação de

SpanExporter.export
forceFlush()
forceFlush(): Promise<void>;

Exportar imediatamente todos os spans

Devoluções

Promise <void>

Implementação de

SpanExporter.forceFlush
shutdown()
shutdown(): Promise<void>;

Interrompe o exportador.

Devoluções

Promise <void>

Implementação de

SpanExporter.shutdown

NodeExecutionLogger

Estende-se

  • NullExecutionCallback

Constructor

new NodeExecutionLogger(opts): NodeExecutionLogger;

Parâmetros

Parâmetro
Tipo

opts

`NodeExecutionLoggerOpts <#nodeexecutionloggeropts>`__

Devoluções

`NodeExecutionLogger <#nodeexecutionlogger>`__

Substitui

NullExecutionCallback.constructor

Métodos

onNodeEnd()
onNodeEnd(
   nodeName,
   outputs,
   opts
): void;

Parâmetros

Parâmetro
Tipo

nodeName

string

outputs

Record <string, unknown>

opts

NodeCallbackOpts

Devoluções

void

Substitui

NullExecutionCallback.onNodeEnd
onNodeError()
onNodeError(
   nodeName,
   error,
   opts
): void;

Parâmetros

Parâmetro
Tipo

nodeName

string

error

string

opts

NodeCallbackOpts

Devoluções

void

Substitui

NullExecutionCallback.onNodeError
onNodeStart()
onNodeStart(
   nodeName,
   inputs,
   opts
): void;

Parâmetros

Parâmetro
Tipo

nodeName

string

inputs

Record <string, unknown>

opts

NodeCallbackOpts

Devoluções

void

Substitui

NullExecutionCallback.onNodeStart
onNodeSuspend()
onNodeSuspend(nodeName, opts): void;

Parâmetros

Parâmetro
Tipo

nodeName

string

opts

NodeCallbackOpts

Devoluções

void

Substitui

NullExecutionCallback.onNodeSuspend

OperationalStepAllocator

Process-local operation step_number mint for a execution AER.

Compartilhado pelo SecureToolWrapper e SecureLLMPrxy portanto, ferramentas paralelas e chamadas LLM não podem colidir em um único AER. Não é uma autoridade multi-OE. O loop de eventos de thread único do Node torna um contador simples seguro em tarefas assíncronas simultâneas, desde que a criação permaneça síncrona antes da primeira espera.

Implementos

  • `OperationalStepSource <#operationalstepsource>'__

Constructor

new OperationalStepAllocator(): OperationalStepAllocator;

Devoluções

`OperationalStepAllocator <#operationalstepallocator>'__

Métodos

current()
current(): number;

Devoluções

number

Implementação de

`OperationalStepSource <#operationalstepsource>'__. `current <#current-1>`__

próximo()
next(): number;

Devoluções

number

Implementação de

`OperationalStepSource <#operationalstepsource>'__. `next <#next-1>`__

observeAtLeast()
observeAtLeast(n): void;

Parâmetros

Parâmetro
Tipo

n

number

Devoluções

void

Implementação de

`OperationalStepSource <#operationalstepsource>'__. `observeAtLeast <#observeatleast-1>`__

OutputValidationPolicyEngine

Contrato implementado por mecanismos de proteção remota nativos e futuros.

Implementos

  • `GuardrailPolicyEngine <#guardrailpolicyengine>`__

Constructor

new OutputValidationPolicyEngine(): OutputValidationPolicyEngine;

Devoluções

`OutputValidationPolicyEngine <#outputvalidationpolicyengine>`__

Propriedades

Propriedade
Modifier
Tipo
Valor padrão

policyType

readonly

"output_validation"

OUTPUT_VALIDATION_POLICY_TYPE

Métodos

avaliar()
evaluate(policy, text):
  | GuardrailPolicyEngineResult
  | null;

Retornar provas de propriedade do mecanismo e texto transformado opcional quando acionado.

Parâmetros

Parâmetro
Tipo
Descrição

policy

{ action: string; config: Record <string, `JsonValue <#jsonvalue>`__>; id: string; stage_filter: string []; status: string; type: string; }

policy.action

string

Ação solicitada quando a política é acionada.

policy.config

Record <string, `JsonValue <#jsonvalue>`__>

Configuração da política específica do avaliador.

policy.id

string

Identificador da política de guardrail.

policy.stage_filter

string []

Estágios de tempo de execução aos quais esta política se aplica; vazio significa todos os estágios.

policy.status

string

Status da política de proteção.

policy.type

string

Tipo de política de guardrail.

text

string

Devoluções

| `GuardrailPolicyEngineResult <#guardrailpolicyengineresult>`__ | null

Implementação de

`GuardrailPolicyEngine <#guardrailpolicyengine>`__. `evaluate <#evaluate-1>`__

PolíticaDeniedException

Estende-se

  • Error

Constructor

new PolicyDeniedException(
   reason,
   guardrailMeta?,
   options?
): PolicyDeniedException;

Parâmetros

Parâmetro
Tipo
Valor padrão

reason

string

undefined

guardrailMeta

| { guardrail_category: string; guardrail_id: string; } | null

null

options?

ErrorOptions

undefined

Devoluções

`PolicyDeniedException <#policydeniedexException>`__

Substitui

Error.constructor

Propriedades

Propriedade
Modifier
Tipo
Descrição

guardrailMeta

readonly

| { guardrail_category: string; guardrail_id: string; } | null

Identidade da política de proteção quando a negação veio de uma política de proteção.

reason

readonly

string

ReplayedActivityFailedError

Estende-se

  • `WorkflowClientError <#workflowclienterror>`__

Constructor

new ReplayedActivityFailedError(code, message): ReplayedActivityFailedError;

Parâmetros

Parâmetro
Tipo

code

`WorkflowErrorCode <#work Bloscherorcode>`__

message

string

Devoluções

`ReplayedActivityFailedError <#replayedatividadefailederror>`__

Substitui

`WorkflowClientError <#workflowclienterror>`__. `constructor <#constructor-40>`__

Propriedades

Propriedade
Modifier
Tipo
Herdado de

code

readonly

`WorkflowErrorCode <#work Bloscherorcode>`__

`WorkflowClientError <#workflowclienterror>`__. `code <#property-code-1>`__

RuntimeAgentConfig

Visualização validada do tempo de execução de agent.yaml.

Baseado em classe porque o Python usa acessadores @property computados e métodos assistente (feature_enabled, configured_feature). As propriedades são expostas como getters TS sob nomes camelCase; Os nomes de campo do Python em AgentFeatureConfig são preservados literalmente para que a paridade fio/registro seja mantida.

Constructor

new RuntimeAgentConfig(init?): RuntimeAgentConfig;

Parâmetros

Parâmetro
Tipo
Descrição

init

{ entrypoint?: string | null; features?: { deep_agent: boolean | null; durable_workflow: boolean | null; guardrails: boolean | null; memory: boolean | null; playground: boolean | null; use_custom_parser: boolean | null; }; framework?: string | null; language?: string | null; mcp?: { servers: Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>; }; path?: string | null; requiredSecrets?: { aer?: string []; disable_restriction?: boolean; tools?: Record <string, string []>; }; }

init.entrypoint?

string | null

init.features?

{ deep_agent: boolean | null; durable_workflow: boolean | null; guardrails: boolean | null; memory: boolean | null; playground: boolean | null; use_custom_parser: boolean | null; }

init.features.deep_agent

boolean | null

Se o agente usa o chicote de agentes profundos (deepagents). Bloqueia o sistema de arquivos integrado + registro do manipulador de shell para que os locatários que não executam agentes profundos não obtenham nenhum sistema de arquivos/superfície de shell em seu Tool Pod. A chave permanece snake_case deep_agent porque agent.yaml é um artefato de linguagem cruzada compartilhado com o tempo de execução e a plataforma Python.

init.features.durable_workflow

boolean | null

Opte pelo fluxo de trabalho durável de propriedade de OE. Omitido ou falso significa que o agente permanece nos checkpoints nativos; somente um true explícito aceita. Quando definido, o OE usa esse sinalizador com o idioma anunciando para atribuir de forma fixa a autoridade de fluxo de trabalho da sessão.

init.features.guardrails

boolean | null

Se as grades de proteção são aplicadas a esse agente no tempo de execução. null (o padrão) significa omitido, permitindo que o tempo de execução volte ao comportamento legado .

init.features.memory

boolean | null

init.features.playground

boolean | null

Se a plataforma provisiona a interface do usuário do playground para o agente (nulo/verdadeiro = provisionado, comportamento de hoje). Quando falso — por exemplo, para agentes que não sejam de chat sem conversa com a visualização — nenhum playground é criado ou atendido; chamadores usam a API de chamada diretamente. Leia somente no momento da implantação/provisionamento — sem efeito no tempo de execução.

init.features.use_custom_parser

boolean | null

Opte pela modelagem de saída de streaming definida pelo autor. Quando verdadeiro, o adaptador executa o analisador de saída registrado e emite armações custom_event; off deixa o stream inalterado.

init.framework?

string | null

init.language?

string | null

init.mcp?

{ servers: Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>; }

init.mcp.servers

Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>

init.path?

string | null

init.requiredSecrets?

{ aer?: string []; disable_restriction?: boolean; tools?: Record <string, string []>; }

init.requiredSecrets.aer?

string []

init.requiredSecrets.disable_restriction?

boolean

init.requiredSecrets.tools?

Record <string, string []>

Devoluções

`RuntimeAgentConfig <#runtimeagentconfig>`__

Propriedades

Propriedade
Modifier
Tipo
Descrição

entrypoint

readonly

string | null

features

readonly

object

features.deep_agent

public

boolean | null

Se o agente usa o chicote de agentes profundos (deepagents). Bloqueia o sistema de arquivos integrado + registro do manipulador de shell para que os locatários que não executam agentes profundos não obtenham nenhum sistema de arquivos/superfície de shell em seu Tool Pod. A chave permanece snake_case deep_agent porque agent.yaml é um artefato de linguagem cruzada compartilhado com o tempo de execução e a plataforma Python.

features.durable_workflow

public

boolean | null

Opte pelo fluxo de trabalho durável de propriedade de OE. Omitido ou falso significa que o agente permanece nos checkpoints nativos; somente um true explícito aceita. Quando definido, o OE usa esse sinalizador com o idioma anunciando para atribuir de forma fixa a autoridade de fluxo de trabalho da sessão.

features.guardrails

public

boolean | null

Se as grades de proteção são aplicadas a esse agente no tempo de execução. null (o padrão) significa omitido, permitindo que o tempo de execução volte ao comportamento legado .

features.memory

public

boolean | null

features.playground

public

boolean | null

Se a plataforma provisiona a interface do usuário do playground para o agente (nulo/verdadeiro = provisionado, comportamento de hoje). Quando falso — por exemplo, para agentes que não sejam de chat sem conversa com a visualização — nenhum playground é criado ou atendido; chamadores usam a API de chamada diretamente. Leia somente no momento da implantação/provisionamento — sem efeito no tempo de execução.

features.use_custom_parser

public

boolean | null

Opte pela modelagem de saída de streaming definida pelo autor. Quando verdadeiro, o adaptador executa o analisador de saída registrado e emite armações custom_event; off deixa o stream inalterado.

framework

readonly

string | null

Estrutura do aplicativo do agente.yaml; omitido significa não definido no momento do anúncio.

language

readonly

string | null

Idioma de tempo de execução do agente.yaml; omitido significa não definido no momento do anúncio.

mcp

readonly

object

mcp.servers

public

Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>

path

readonly

string | null

requiredSecrets

readonly

object

requiredSecrets.aer

public

string []

requiredSecrets.disable_restriction

public

boolean

requiredSecrets.tools

public

Record <string, string []>

Métodos

configuradoFeature()
configuredFeature(name): boolean | null;

Retorne o valor da funcionalidade explícita de agent.yaml, se existir.

Parâmetros

Parâmetro
Tipo

name

| "memory" | "guardrails" | "playground" | "deep_agent" | "use_custom_parser" | "durable_workflow"

Devoluções

boolean | null

featureEnabled()
featureEnabled(name, defaultValue?): boolean;

Retorne um valor de sinalizador de feição, retornando para defaultValue quando omitido.

Parâmetros

Parâmetro
Tipo
Valor padrão

name

| "memory" | "guardrails" | "playground" | "deep_agent" | "use_custom_parser" | "durable_workflow"

undefined

defaultValue

boolean

false

Devoluções

boolean

SecureLLMProxy

Constructor

new SecureLLMProxy(args): SecureLLMProxy;

Parâmetros

Parâmetro
Tipo

args

{ boundToolChoice?: unknown; boundTools?: unknown [] | null; durableMemory?: `DurableMemoryState <#durablememorystate>`__ | null; executionId: string; llmId?: string; modelName?: string; oeUrl: string; operationalSteps?: `OperationalStepSource <#operationalstepsource>`__; }

args.boundToolChoice?

unknown

args.boundTools?

unknown [] | null

args.durableMemory?

`DurableMemoryState <#durablememorystate>`__ | null

args.executionId

string

args.llmId?

string

args.modelName?

string

args.oeUrl

string

args.operationalSteps?

`OperationalStepSource <#operationalstepsource>'__

Devoluções

`SecureLLMProxy <#securellmproxy>`__

Propriedades

Propriedade
Modifier
Tipo
Descrição

boundToolChoice

readonly

unknown

boundTools

readonly

unknown [] | null

durableMemory

readonly

`DurableMemoryState <#durablememorystate>`__ | null

executionId

readonly

string

lastDurationMs

public

number

lastFromCache

public

boolean

lastLatestStepNumber

public

number | null

lastPodName

public

string | null

llmId

readonly

string

modelName

readonly

string

oeUrl

readonly

string

operationalSteps

readonly

`OperationalStepSource <#operationalstepsource>'__

Prefira o alocador do wrapper para que a ferramenta + LLM compartilhe uma sequência.

Acessores

stepCounter

Obter assinatura

get stepCounter(): number;

Marca d'gua de etapa operacional atual para leitores de compatibilidade.

Devoluções

number

Métodos

invoke()
invoke(
   messages,
   step?,
   stop?,
   options?
): Promise<LLMResponse>;

Invoque o LLM coletando o caminho de execução orientado ao fluxo. Equivalente ao invoke() do Python que chama list(self.stream(...)).

Parâmetros

Parâmetro
Tipo

messages

`Message <#message>`__ []

step?

number | null

stop?

string [] | null

options?

`LLMInvocationOptions <#llmin preferenceoptions>`__ | null

Devoluções

Promise <`LLMResponse <#llmresponse>`__>

stream()
stream(
   messages,
   step?,
   stop?,
   options?
): AsyncGenerator<LLMStreamChunk>;

Transmitir chunks invoke_llm por meio da aprovação da OE e do relé SSE de propriedade da OE.

A etapa aumenta automaticamente quando não é fornecida. Se o OE retornar um resultado em cache/sincronização, um LLMStreamChunk sintético será gerado em vez de abrir uma conexão SSE.

Parâmetros

Parâmetro
Tipo

messages

`Message <#message>`__ []

step?

number | null

stop?

string [] | null

options?

`LLMInvocationOptions <#llmin preferenceoptions>`__ | null

Devoluções

AsyncGenerator <LLMStreamChunk>

responseFromStreamChunks()
static responseFromStreamChunks(chunks): LLMResponse;

Colete chunks sdk-core transmitidos em um sdk-core LLMResponse final. Estático — pode ser chamado sem uma instância de proxy (por exemplo, após a transmissão paralela).

Parâmetros

Parâmetro
Tipo

chunks

LLMStreamChunk []

Devoluções

`LLMResponse <#llmresponse>`__

SecureToolWrapper

Constructor

new SecureToolWrapper(
   oeUrl,
   executionId,
   customHeaders?,
   oeOwnerUrl?,
   drainRegistry?
): SecureToolWrapper;

Parâmetros

Parâmetro
Tipo

oeUrl

string

executionId

string

customHeaders?

Record <string, string>

oeOwnerUrl?

string | null

drainRegistry?

DrainRegistry | null

Devoluções

`SecureToolWrapper <#securetoolwrapper>`__

Propriedades

Propriedade
Modifier
Tipo
Valor padrão
Descrição

customHeaders

readonly

Record <string, string>

undefined

durableMemory

public

`DurableMemoryState <#durablememorystate>`__ | null

null

executionId

readonly

string

undefined

oeOwnerUrl

readonly

string | null

undefined

URL base do proprietário da OE específico da réplica validado ou nulo. Encaminhado para reportOeResult para o caminho do resultado da ferramenta em processo (local-callback) para que o acordo prefira a réplica OE proprietário.

oeUrl

readonly

string

undefined

operationalSteps

readonly

`OperationalStepSource <#operationalstepsource>'__

undefined

Compartilhado com SecureLLMPrxy para esta execução (suposição de AER única).

Acessores

stepCounter

Obter assinatura

get stepCounter(): number;

Marca d'gua de etapa operacional atual para leitores de compatibilidade.

Devoluções

number

Métodos

close()
close(): Promise<void>;

Devoluções

Promise <void>

executeTool()
executeTool(
   toolName,
   args,
   options?
): Promise<unknown>;

Execute uma chamada de ferramenta por OE.

Fluxo: 1. POST /tool/execute — OE aprova ou nega 2. A OE retorna um resultado final ou roteia a chamada de volta no processo 3. O Wrapper registra o resultado e converte as cargas úteis de suspensão de volta para interrupções de framework

Parâmetros

Parâmetro
Tipo

toolName

string

args

Record <string, unknown>

options

ExecuteToolOptions

Devoluções

Promise <unknown>

próximaOperationalStep()
nextOperationalStep(): number;

Aloque o próximo step_number operacional para esta execução.

Devoluções

number

observarOperationalStep()
observeOperationalStep(n): void;

Aumente a marca d'gua do alocador (por exemplo, de OE últimas_step_number).

Parâmetros

Parâmetro
Tipo

n

number

Devoluções

void

TenantRuntime

SDK do tempo de execução do inquilino.

Construído uma vez por processo. registerAndRun conecta o construtor de gráficos do SDK do framework e inicia o servidor Fastify por modo.

Implementos

  • `ITenantRuntime <#itenantruntime>`__

Constructor

new TenantRuntime(opts?): TenantRuntime;

Parâmetros

Parâmetro
Tipo

opts

`TenantRuntimeOptions <#tenantruntimeoptions>`__

Devoluções

`TenantRuntime <#tenantruntime>`__

Propriedades

Propriedade
Modifier
Tipo
Valor padrão
Descrição

appName

readonly

string

undefined

appVersion

readonly

string

undefined

graphBuilder

public

`GraphBuilderLike <#graphbuilderlike>`__ | null

null

Instância do construtor de gráfico — nulo se não for definido na inicialização.

memoryWriter

readonly

MemoryWriter | null

undefined

Escritor de mudanças de ponto de verificação nativo, presente somente quando a Memória está habilitada.

mode

readonly

`RuntimeMode <#runtimemode>`__

undefined

orgId

readonly

string | null

undefined

projectId

readonly

string | null

undefined

Opcional para que as implementações manuscritas pré-existentes (tempos de execução personalizados, testes duplos) continuem verificando a digitação no aumento do SDK que a introduziu. O caminho da capacidade de anunciar trata ausente e nulo da mesma forma ignorando.

toolDefinitions

public

Record <string, Record <string, unknown>>

{}

Metadados da ferramenta (description, is_local etc.), digitados por nome.

tools

public

Record <string, `ServerToolFn <#servertoolfn>`__>

{}

Funções de ferramenta bruta registradas via app.tool(), digitadas por nome.

Métodos

getAgent()
getAgent(opts?): BaseAgent;

Obtenha uma instância do BaseAgent, opcionalmente conectada com chamadas de resposta de execução.

Parâmetros

Parâmetro
Tipo

opts?

{ callbacks?: BaseExecutionCallback []; }

opts.callbacks?

BaseExecutionCallback []

Devoluções

BaseAgent

Implementação de

`ITenantRuntime <#itenantruntime>`__. `getAgent <#getagent-2>`__

getAgentConfig()
getAgentConfig(): RuntimeAgentConfig;

Configuração agent.yaml analisada.

Devoluções

`RuntimeAgentConfig <#runtimeagentconfig>`__

Implementação de

`ITenantRuntime <#itenantruntime>`__. `getAgentConfig <#getagentconfig-1>`__

getCurrentSessionId()
getCurrentSessionId(): string | null;

Devoluções

string | null

getCurrentUserId()
getCurrentUserId(): string | null;

Obtenha o user_id atual do contexto de execução.

Devoluções

string | null

ID de usuário do contexto de execução atual ou nulo se não estiver disponível

getMongodbUri()
getMongodbUri(): string | null;

URI do MongoDB resolvido: opção de construtor > MONGODB_URI env var > nulo.

Devoluções

string | null

Implementação de

`ITenantRuntime <#itenantruntime>`__. `getMongodbUri <#getmongodburi-1>`__

getToolMetadata()
getToolMetadata(name): Record<string, unknown>;

Obtenha metadados para uma ferramenta registrada.

Parâmetros

Parâmetro
Tipo
Descrição

name

string

Nome da ferramenta

Devoluções

Record <string, unknown>

objeto de metadados da ferramenta (is_local, rede, tempo limite, etc.) ou objeto vazio se a ferramenta não for encontrada.

registrarAndRun()
registerAndRun(graphBuilder?, options?): Promise<void>;

Registre o construtor de gráfico e inicie o servidor específico do modo.

Resolve quando o Fastify está escutando — o soquete aberto mantém o loop de eventos Node ativo, correspondendo ao efeito prático do bloqueio asyncio.run(uvicorn.serve()) do Python até o desligamento.

Parâmetros

Parâmetro
Tipo

graphBuilder?

`GraphBuilderLike <#graphbuilderlike>`__ | null

options?

`RegisterAndRunOptions <#registerandrunoptions>`__

Devoluções

Promise <void>

ferramenta de registro ()
registerTool(
   name,
   func,
   metadata
): void;

Registre uma função de ferramenta bruta e seus metadados.

Armazena a função para execução do Pod da Ferramenta e os metadados para decisões de roteamento. Ele NÃO cria nenhum objeto de ferramenta específico do framework - isso é responsabilidade do SDK do framework.

Parâmetros

Parâmetro
Tipo
Descrição

name

string

Nome da ferramenta

func

`ServerToolFn <#servertoolfn>'__

Função da ferramenta bruta

metadata

Record <string, unknown>

Metadados da ferramenta (is_local, rede, tempo limite etc.)

Devoluções

void

shutdown()
shutdown(): Promise<void>;

Feche o MongoClient de rastreamento. Idempotente — seguro para chamar de vários manipuladores de sinal. Adição somente de TS: o uvicorn do Python lida com o próprio SIGTERM, então o Python TenantRuntime não tem método equivalente.

Devoluções

Promise <void>

hotUpAgent()
warmUpAgent(): void;

Pré-construção explícita por meio do warmUp() do construtor de gráficos, se ele tiver um.

Devoluções

void

Implementação de

`ITenantRuntime <#itenantruntime>`__. `warmUpAgent <#warmupagent-1>`__

TerminalExecutionError

Gerado quando a execução da ferramenta falha.

Estende-se

  • `ToolExecutionError <#toolexecutionerror>`__

Constructor

new TerminalExecutionError(error, options?): TerminalExecutionError;

Parâmetros

Parâmetro
Tipo

error

string

options?

ErrorOptions

Devoluções

`TerminalExecutionError <#terminalexecutionerror>`__

Substitui

`ToolExecutionError <#toolexecutionerror>`__. `constructor <#constructor-35>`__

Propriedades

Propriedade
Modifier
Tipo
Herdado de

error

readonly

string

`ToolExecutionError <#toolexecutionerror>`__. `error <#property-error-4>`__

Erro de Timeout da Chamada de Ferramenta

Gerado quando uma chamada de ferramenta ultrapassa seu prazo.

Distinto de PolicyDeniedException de propósito. Um tempo limite significa que a chamada foi permitida e executada - ela acabou demorando muito - portanto, denunciá-la como uma negação envia o desenvolvedor para depurar a administração em vez de sua ferramenta.

Estende-se

  • `ToolExecutionError <#toolexecutionerror>`__

Constructor

new ToolCallTimeoutError(
   toolName,
   timeoutSeconds,
   elapsedSeconds,
   options?
): ToolCallTimeoutError;

Parâmetros

Parâmetro
Tipo

toolName

string

timeoutSeconds

number

elapsedSeconds

number

options?

ErrorOptions

Devoluções

`ToolCallTimeoutError <#toolcalltimeouterror>`__

Substitui

`ToolExecutionError <#toolexecutionerror>`__. `constructor <#constructor-35>`__

Propriedades

Propriedade
Modifier
Tipo
Herdado de

elapsedSeconds

readonly

number

error

readonly

string

`ToolExecutionError <#toolexecutionerror>`__. `error <#property-error-4>`__

timeoutSeconds

readonly

number

toolName

readonly

string

Erro de execução da ferramenta

Gerado quando a execução da ferramenta falha.

Estende-se

  • Error

Estendido por

  • `TerminalExecutionError <#terminalexecutionerror>`__

  • `ToolCallTimeoutError <#toolcalltimeouterror>`__

  • `ExternalAPICallError <#externalapicallerror>`__

Constructor

new ToolExecutionError(error, options?): ToolExecutionError;

Parâmetros

Parâmetro
Tipo

error

string

options?

ErrorOptions

Devoluções

`ToolExecutionError <#toolexecutionerror>`__

Substitui

Error.constructor

Propriedades

Propriedade
Modifier
Tipo

error

readonly

string

Corretor de funções de ferramentas

Executa uma chamada de ferramenta fornecida por metadados e sai. Não é um servidor.

Lê o envelope ToolFunctionRequest do diretório de metadados do convidado, invoca a ferramenta nomeada do registro, relata o ToolResultRequest para {oe_url}/tool/result e retorna. Espelha o ToolFunctionRunner do Python.

metadataDir é injetado para testes.

Constructor

new ToolFunctionRunner(runtime, __namedParameters?): ToolFunctionRunner;

Parâmetros

Parâmetro
Tipo

runtime

`ITenantRuntime <#itenantruntime>`__

__namedParameters

{ metadataDir?: string; }

__namedParameters.metadataDir?

string

Devoluções

`ToolFunctionRunner <#toolfunction Runner>'__

Métodos

run()
run(): Promise<void>;

Execute uma ferramenta a partir da solicitação entregue de metadados e relate o resultado.

Aumenta novamente se o POST de resultado não puder ser entregue após novas tentativas, então o fctr registra a execução como falha.

Devoluções

Promise <void>

Servidor de ferramentas

Estende-se

  • BaseServer

Constructor

new ToolServer(runtime): ToolServer;

Parâmetros

Parâmetro
Tipo

runtime

`ITenantRuntime <#itenantruntime>`__

Devoluções

`ToolServer <#toolserver>`__

Substitui

BaseServer.constructor

Propriedades

Propriedade
Modifier
Tipo
Valor padrão
Herdado de

app

protected

| FastifyInstance <RawServerDefault, IncomingMessage, ServerResponse <IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault> | null

null

BaseServer.app

runtime

readonly

`ITenantRuntime <#itenantruntime>`__

undefined

BaseServer.runtime

Acessores

defaultPort

Obter assinatura

get defaultPort(): number;

Devoluções

number

Herdado de

BaseServer.defaultPort
drainRegistry

Obter assinatura

get drainRegistry(): DrainRegistry;

Estado de drenagem com escopo de execução para POST /drain; as rotas de trabalho são registradas nele para que o trabalho a bordo de uma execução cancelada possa ser interrompido. Criado de forma preguiçosa no protótipo para que os testes que ignoram o construtor (Object.create) ainda obtenham um registro funcional.

Devoluções

DrainRegistry

Herdado de

BaseServer.drainRegistry
modeName

Obter assinatura

get modeName(): string;

Devoluções

string

Substitui

BaseServer.modeName

Métodos

close()
close(): Promise<void>;

Feche graciosamente o servidor Fastify subjacente, drenagem solicitações a bordo e executando ganchos onClose. Nenhum oplog se o aplicativo nunca foi criado.

Devoluções

Promise <void>

Herdado de

BaseServer.close
createApp()
createApp(): FastifyInstance;

Devoluções

FastifyInstance

Herdado de

BaseServer.createApp
getHealthDetails()
getHealthDetails(): Record<string, unknown>;

Devoluções

Record <string, unknown>

Substitui

BaseServer.getHealthDetails
onShutdown()
onShutdown(): Promise<void>;

Devoluções

Promise <void>

Substitui

BaseServer.onShutdown
onStartup()
onStartup(): Promise<void>;

Devoluções

Promise <void>

Substitui

BaseServer.onStartup
registrarCommonRoutes()
protected registerCommonRoutes(app): void;

Parâmetros

Parâmetro
Tipo

app

FastifyInstance

Devoluções

void

Herdado de

BaseServer.registerCommonRoutes
registrarRoutes()
registerRoutes(app): void;

Parâmetros

Parâmetro
Tipo

app

FastifyInstance

Devoluções

void

Substitui

BaseServer.registerRoutes
run()
run(host?, port?): Promise<void>;

Parâmetros

Parâmetro
Tipo
Valor padrão

host

string

"0.0.0.0"

port?

number

undefined

Devoluções

Promise <void>

Herdado de

BaseServer.run

UnsupportedChildOperationFanOutError

Estende-se

  • Error

Constructor

new UnsupportedChildOperationFanOutError(message): UnsupportedChildOperationFanOutError;

Parâmetros

Parâmetro
Tipo

message

string

Devoluções

`UnsupportedChildOperationFanOutError <#unsupportedchildoperationphanouterror>`__

Substitui

Error.constructor

Cliente de fluxo de trabalho

Constructor

new WorkflowClient(oeUrl, options?): WorkflowClient;

Parâmetros

Parâmetro
Tipo

oeUrl

string

options

{ fetch?: { (input, init?): Promise <Response>; (input, init?): Promise <Response>; }; timeoutMs?: number; }

options.fetch?

{ (input, init?): Promise <Response>; (input, init?): Promise <Response>; }

options.timeoutMs?

number

Devoluções

`WorkflowClient <#workflowclient>'__

Métodos

completeExecution()
completeExecution(command): Promise<void>;

Parâmetros

Parâmetro
Tipo

command

`CompleteExecutionCommand <#completeexecutioncommand>`__

Devoluções

Promise <void>

ensureMemoryWritten()
ensureMemoryWritten(command): Promise<void>;

Parâmetros

Parâmetro
Tipo

command

`ActivityMemoryCommand <#atividadememorycommand>`__

Devoluções

Promise <void>

finalizeStep()
finalizeStep(command): Promise<StepActivityEntry[]>;

Parâmetros

Parâmetro
Tipo

command

`FinalizeStepCommand <#finalizestepcommand>`__

Devoluções

Promise <`StepActivityEntry <#steptivityentry>`__ []>

heartbeat()
heartbeat(request): Promise<void>;

Parâmetros

Parâmetro
Tipo

request

`AttemptHeartbeatRequest <#attempt heartbeatrequest>`__

Devoluções

Promise <void>

reportOutcome()
reportOutcome(outcome): Promise<void>;

Parâmetros

Parâmetro
Tipo

outcome

`ActivityOutcome <#activityoutcome>`__

Devoluções

Promise <void>

startActivity()
startActivity(command): Promise<StartActivityResult>;

Parâmetros

Parâmetro
Tipo

command

`ActivityCommand <#atividadecommand>`__

Devoluções

Promise <`StartActivityResult <#startatividaderesult>`__>

startAttempt()
startAttempt(request): Promise<AttemptContext | null>;

Parâmetros

Parâmetro
Tipo

request

`AttemptStartRequest <#attemptstartrequest>`__

Devoluções

Promise <`AttemptContext <#attemptcontext>`__ | null>

WorkflowClientError

Estende-se

  • Error

Estendido por

  • `ReplayedActivityFailedError <#replayedatividadefailederror>`__

Constructor

new WorkflowClientError(
   code,
   message,
   options?
): WorkflowClientError;

Parâmetros

Parâmetro
Tipo

code

`WorkflowErrorCode <#work Bloscherorcode>`__

message

string

options?

ErrorOptions

Devoluções

`WorkflowClientError <#workflowclienterror>`__

Substitui

Error.constructor

Propriedades

Propriedade
Modifier
Tipo

code

readonly

`WorkflowErrorCode <#work Bloscherorcode>`__

Interfaces

AERQueryPlugin

plugin -in do lado da leitura que apresenta o estado da sessão específico da estrutura.

As implementações coexistem com adaptadores de estrutura e leem a partir da persistência do adaptador (coleções de checkpoint LangGraph, armazenamento de estado do ADK etc.).

Métodos

getMessagesForSession()
getMessagesForSession(sessionId): Promise<{
  messages: object[];
}>;

Dado um session_id, retorne um SessionMessagesResponse.

Parâmetros

Parâmetro
Tipo

sessionId

string

Devoluções

Promise <{ messages: object []; }>

getSummariesForSessions()
getSummariesForSessions(sessionIds): Promise<{
  sessions: object[];
}>;

Dada uma lista de session_ids, retorne um SessionsSummaryResponse.

Parâmetros

Parâmetro
Tipo

sessionIds

string []

Devoluções

Promise <{ sessions: object []; }>

CaptureExceptionArgs

Propriedades

Propriedade
Tipo

extra?

Record <string, unknown>

summary?

string | null

Limite da operação inferior

Propriedades

Propriedade
Tipo

name

string

occurrenceKey

string

ExecutionStore

Propriedades

Propriedade
Tipo
Descrição

authorization

| { expires_at?: number | null; token: string; } | null

Credenciais delegadas injetadas pelo OE para execução da ferramenta.

customHeaders

Record <string, string> | null

executionId

string | null

executionMetadata

Record <string, unknown> | null

oeOwnerUrl

string | null

URL de chamada de resposta do proprietário do OE específico da réplica validado ou nulo quando a solicitação não carregou nenhum / falhou na validação. Os transportes com preferência pelo proprietário (por exemplo, módulo:progress) são enviados para aqui primeiro e retornam para oeUrl em qualquer falha do proprietário. Já validado em relação a oeUrl pelo chamador (consulte server/owner_url.ts), então os consumidores confiam nele como está.

oeUrl

string | null

ownerUrlFailure

object

Trava unidirecional de falha do proprietário: uma vez que uma pré-tentativa do proprietário falha, as publicações posteriores com preferência do proprietário nessa execução ignoram totalmente o URL do proprietário em vez de pagar novamente o tempo limite pré-tentativa a cada emissão. Um objeto aninhado pela mesma razão que sessionFinish: a referência sobrevive propagações da loja (por exemplo, runWithSuspendRequestContext), um campo reatribuído não o faria. Espelha o descarte onOwnerFailure do caminho do fluxo AER.

ownerUrlFailure.failed

boolean

payload

Record <string, unknown> | null

Carga útil de invocação fornecida pelo chamador opaco (o corpo da solicitação além de message).

requestId

string | null

sessionFinish

object

Detém uma solicitação de conclusão de sessão pendente. Um objeto aninhado em vez de um booleano simples: o AER o lê a partir do quadro que iniciou a execução, enquanto o código do agente no fundo da cadeia de chamadas o transforma no lugar — a referência do objeto é compartilhada por essa cadeia, um campo booleano reatribuído no armazenamento não seria.

sessionFinish.closed

boolean

sessionFinish.requested

boolean

sessionId

string | null

signal

AbortSignal | null

Sinal de cancelamento de toda a execução (dispara no tempo limite de execução do AER). Combinado em buscas OE/LLM a bordo via withExecutionSignal para que um tempo limite cancele a E/S de rede ativa em vez de deixá-la para ser executada. Nulo fora de uma execução AER (por exemplo, uma única chamada de Pod de Ferramenta).

suspendRequest

object

Sinal de suspensão fora de banda. Somente o suspendPayloadToJson voltado para o autor o grava, portanto, o conteúdo não confiável da ferramenta-result – que não pode alcançar esse framework local do processo – nunca pode forjar uma suspensão HITL. Um titular aninhado pelo mesmo motivo que sessionFinish: uma ferramenta descarregada para um thread de trabalho altera o objeto compartilhado, não um campo de armazenamento reatribuído.

suspendRequest.payload

Record <string, unknown> | null

traceId

string | null

ID de rastreamento da plataforma para correlação de registro.

userId

string | null

workspaceId

string | null

wrapper

unknown

Uso extraído

Forma de uso normalizada retornada por extractUsage / extractPodUsage. Espelha o retorno em forma de dicionário do Python para que os consumidores downstream possam passar esses campos diretamente para reportOeResult.

Propriedades

Propriedade
Tipo

completion_tokens

number | null

model

string | null

prompt_tokens

number | null

total_tokens

number | null

GraphBuilderLike

Interface mínima do construtor de gráficos.

Métodos

getAgent()?
optional getAgent(opts?): BaseAgent;

Parâmetros

Parâmetro
Tipo

opts?

{ callbacks?: BaseExecutionCallback []; }

opts.callbacks?

BaseExecutionCallback []

Devoluções

BaseAgent

pronto()?
optional ready(): Promise<void>;

Resolve quando qualquer configuração assíncrona iniciada durante a construção (por exemplo, descoberta de ferramentas MCP) termina de registrar ferramentas. TenantRuntime.runAsync() espera por isso antes de vincular o servidor, para que nenhuma solicitação possa chegar antes da conclusão da configuração. Opcional — construtores sem configuração assíncrona podem omiti-lo.

Devoluções

Promise <void>

aquecimento()?
optional warmUp(): void;

Crie o gráfico do agente antes do primeiro uso, quando explicitamente solicitado. O TypeScript AER não chama esse gancho síncrono durante o aquecimento em espera porque isso bloquearia o loop de eventos Node e a integridade do servidor .

Devoluções

void

GuardrailPolicyEngine

Contrato implementado por mecanismos de proteção remota nativos e futuros.

Propriedades

Propriedade
Modifier
Tipo

policyType

readonly

string

Métodos

avaliar()
evaluate(policy, text):
  | GuardrailPolicyEngineResult
  | null;

Retornar provas de propriedade do mecanismo e texto transformado opcional quando acionado.

Parâmetros

Parâmetro
Tipo
Descrição

policy

{ action: string; config: Record <string, `JsonValue <#jsonvalue>`__>; id: string; stage_filter: string []; status: string; type: string; }

policy.action

string

Ação solicitada quando a política é acionada.

policy.config

Record <string, `JsonValue <#jsonvalue>`__>

Configuração da política específica do avaliador.

policy.id

string

Identificador da política de guardrail.

policy.stage_filter

string []

Estágios de tempo de execução aos quais esta política se aplica; vazio significa todos os estágios.

policy.status

string

Status da política de proteção.

policy.type

string

Tipo de política de guardrail.

text

string

Devoluções

| `GuardrailPolicyEngineResult <#guardrailpolicyengineresult>`__ | null

GuardrailPolicyEngineResult

Resultado de propriedade do mecanismo para uma avaliação de política.

Propriedades

Propriedade
Tipo

evidence

object []

transformedText?

string | null

InitErrorReportingArgs

Propriedades

Propriedade
Tipo

component?

string | null

mode?

string | null

surface

string

InstallStructedLoggingArgs

Propriedades

Propriedade
Tipo
Descrição

captureStdio?

boolean

Defina como false para ignorar a aplicação de process.stdout / process.stderr. Útil em testes que compartilham um processo de nó entre casos ou em chamadores que possuem seu próprio roteamento de stdio. O padrão é true (corresponde a Python).

fileLogPath?

string | null

Caminho absoluto para um anexador dateFile em modo de desenvolvimento ao lado do anexador stdout estruturado. Quando definido, um segundo registrador 4js grava registros legíveis por humanos nesse caminho, girando diariamente e mantendo os últimos arquivos 5 (paridade Python TimedRotatingFileHandler). Usado apenas por setupLogging quando AGENTIC_DEV_MODES está definido; deixado por definir na produção, onde Fluent Bit é o único coletor.

level?

string | null

Nível de registro — nome da string ("DEBUG", "info"). O padrão é LOG_LEVEL env var e, em seguida, INFO. Deve ser honrado no lançamento porque os operadores continuam a inverter LOG_LEVEL=DEBUG para buscar problemas.

mode?

string | null

modo Runner ("orchestrator", "aer", "tool", "memory-server") usado para derivar service e fields.component no fio. Tem precedência sobre RUNNER_MODE env var quando definido; volta para env quando null. Permite que os chamadores setupLogging(mode=...) permaneçam autoritários mesmo que o pod env não tenha sido carimboso.

InterruptedActivity

Propriedades

Propriedade
Modifier
Tipo

command

readonly

`ActivityCommand <#atividadecommand>`__

controlFlow

readonly

unknown

ItenantRuntime

Interface mínima de tempo de execução da qual as classes do servidor dependem.

Propriedades

Propriedade
Modifier
Tipo
Descrição

appName

readonly

string

appVersion?

readonly

string

graphBuilder

readonly

`GraphBuilderLike <#graphbuilderlike>`__ | null

Instância do construtor de gráfico — nulo se não for definido na inicialização.

memoryWriter?

readonly

TurnMemoryWriter | null

Escritor de mudanças de ponto de verificação nativo, presente somente quando a Memória está habilitada.

orgId

readonly

string | null

projectId?

readonly

string | null

Opcional para que as implementações manuscritas pré-existentes (tempos de execução personalizados, testes duplos) continuem verificando a digitação no aumento do SDK que a introduziu. O caminho da capacidade de anunciar trata ausente e nulo da mesma forma ignorando.

toolDefinitions

readonly

Record <string, Record <string, unknown>>

Metadados da ferramenta (description, is_local etc.), digitados por nome.

tools

readonly

Record <string, `ServerToolFn <#servertoolfn>`__>

Funções de ferramenta bruta registradas via app.tool(), digitadas por nome.

Métodos

getAgent()
getAgent(opts?): BaseAgent;

Obtenha uma instância do BaseAgent, opcionalmente conectada com chamadas de resposta de execução.

Parâmetros

Parâmetro
Tipo

opts?

{ callbacks?: BaseExecutionCallback []; }

opts.callbacks?

BaseExecutionCallback []

Devoluções

BaseAgent

getAgentConfig()
getAgentConfig(): RuntimeAgentConfig;

Configuração agent.yaml analisada.

Devoluções

`RuntimeAgentConfig <#runtimeagentconfig>`__

getMongodbUri()
getMongodbUri(): string | null;

URI do MongoDB resolvido: opção de construtor > MONGODB_URI env var > nulo.

Devoluções

string | null

hotUpAgent()?
optional warmUpAgent(): void;

Pré-construção explícita por meio do warmUp() do construtor de gráficos, se ele tiver um.

Devoluções

void

LatencyStatsJson

Propriedades

Propriedade
Tipo

avg_ms

number

count

number

max_ms

number

min_ms

number

total_ms

number

MCPToolBinding

Descoberta ferramenta MCP vinculada a um servidor configurado.

Propriedades

Propriedade
Modifier
Tipo

description

readonly

string

inputSchema

readonly

Record <string, unknown>

sdkToolName

readonly

string

serverConfig

readonly

object

serverConfig.allowed_tools

public

string [] | null

serverConfig.auth

public

object

serverConfig.auth.client_id_env

public

string | null

serverConfig.auth.client_name

public

string | null

serverConfig.auth.client_secret_env

public

string | null

serverConfig.auth.redirect_uri

public

string | null

serverConfig.auth.scope

public

string | null

serverConfig.auth.token_env

public

string | null

serverConfig.auth.token_url

public

string | null

serverConfig.auth.type

public

"none" | "bearer_env" | "oauth" | "client_credentials"

serverConfig.headers

public

Record <string, string>

serverConfig.timeout_seconds

public

number

serverConfig.transport

public

"streamable_http"

serverConfig.url

public

string

serverName

readonly

string

toolName

readonly

string

MCPToolResult

Resultado seguro para JSON/BSON retornado por uma invocação do MCP tools/call.

Propriedades

Propriedade
Modifier
Tipo

content

readonly

unknown []

isError

readonly

boolean

structuredContent

readonly

Record <string, unknown> | null

mensagem

Mensagem neutro em relação à estrutura.

O conteúdo pode ser uma string simples para mensagens somente de texto ou uma lista de blocos de conteúdo para conteúdo multimodal (imagens, documentos etc.).

Propriedades

Propriedade
Tipo

additionalKwargs?

Record <string, `JsonValue <#jsonvalue>`__>

content

| string | ( | { text: string; type: "text"; } | { mime_type?: string; type: "image"; url: string; } | { filename?: string; mime_type?: string; type: "document"; url: string; })[]

id?

string

isError?

boolean

name?

string

responseMetadata?

Record <string, `JsonValue <#jsonvalue>`__>

role

Role

toolCallId?

string

toolCalls?

`LLMToolCall <#llmtoolcall>`__ []

NodeExecutionLoggerOpts

Propriedades

Propriedade
Tipo

executionId

string

oeUrl

string

orgId?

string | null

projectId?

string | null

sessionId?

string | null

userId?

string | null

OperationalStepSource

Process-local operation step_number mint for a execution AER.

Compartilhado pelo SecureToolWrapper e SecureLLMPrxy portanto, ferramentas paralelas e chamadas LLM não podem colidir em um único AER. Não é uma autoridade multi-OE. O loop de eventos de thread único do Node torna um contador simples seguro em tarefas assíncronas simultâneas, desde que a criação permaneça síncrona antes da primeira espera.

Métodos

current()
current(): number;

Devoluções

number

próximo()
next(): number;

Devoluções

number

observeAtLeast()
observeAtLeast(n): void;

Parâmetros

Parâmetro
Tipo

n

number

Devoluções

void

OwnerUrlFailureState

Propriedades

Propriedade
Tipo

failed

boolean

RecordMemoryMetadataArgs

Propriedades

Propriedade
Tipo

action

string

content?

string

memoryType

string

query?

string

relevanceScore?

number

Registre-se e execute opções

Opções públicas para registerAndRun.

Propriedades

Propriedade
Tipo
Descrição

logLevel?

string

Nível de registro passado para o servidor subjacente .

ReportOeResultArgs

Propriedades

Propriedade
Tipo
Descrição

completionTokens?

number | null

durationMs

number

error?

string | null

executionId

string

kind?

string | null

metadata?

Record <string, unknown>

model?

string | null

oeUrl

string

onOwnerFailure?

(() => void) | null

Chamado uma vez quando a pré-tentativa do proprietário falha, antes do fallback do serviço.

ownerUrl?

string | null

URL base do proprietário da OE específico da réplica validado, já verificado em oeUrl pelo chamador. Quando definido, uma pré-tentativa de proprietário único é executada antes do loop de serviço e não consome o orçamento de novas tentativas de serviço; o proprietário é o melhor esforço, portanto, qualquer falha — um erro de transporte OU qualquer resposta não2xx — marca a réplica como inutilizável e cai no loop oeUrl confiável. O proprietário nunca é repetido e uma resposta de proprietário nunca é lançada.

podName?

string | null

promptTokens?

number | null

result?

unknown

status

string

step

number

toolApiError?

| { classification: string; error_code?: string | null; http_status?: number | null; provider_type?: string | null; reason?: string | null; retryable: boolean; } | null

toolCallId?

string

toolName

string

totalTokens?

number | null

RequestOeApprovalArgs

Propriedades

Propriedade
Tipo
Descrição

arguments

Record <string, unknown>

customHeaders?

Record <string, string>

Cabeçalhos fornecidos pelo chamador carregados apenas para esta solicitação ativa.

executionId

string

isLocal?

boolean

kind?

string | null

metadata?

Record <string, unknown>

oeUrl

string

providerType?

string | null

redactFields?

somente leitura string []

Nomes de argumento de ferramenta de nível superior para eliminar dos registros de execução.

scopes?

somente leitura string []

step

number

timeoutMs?

number

Prazo geral da solicitação em milissegundos. O padrão é getToolReadTimeout(). O proxy LLM passa um valor mais longo (LLM_READ_TIMEOUT) para invoke_llm, porque o OE mantém /tool/execute aberto enquanto a chamada LLM é concluída - o análogo do httpx.Timeout(get_request_timeout(), read=LLM_READ_TIMEOUT) do Python.

toolCallId?

string

ID de chamada de ferramenta LLM estável, encaminhada para OE para a chave de junção do registro de execução.

toolName

string

ResolvedEntrypoint

Propriedades

Propriedade
Tipo

exportName

string

modulePath

string

SetExecutionContextArgs

Propriedades

Propriedade
Tipo
Descrição

authorization?

| { expires_at?: number | null; token: string; } | null

customHeaders?

Record <string, string> | null

executionId

string

oeOwnerUrl?

string | null

URL de chamada de resposta do proprietário OE específico validado da réplica.

oeUrl

string

ownerUrlFailure?

`OwnerUrlFailureState <#wnerurlfailurestate>`__

payload?

Record <string, unknown> | null

requestId?

string | null

sessionId?

string | null

signal?

AbortSignal | null

traceId?

string | null

userId?

string | null

workspaceId?

string | null

wrapper

unknown

SetupLoggingArgs

Propriedades

Propriedade
Tipo
Descrição

appName?

string

Nome do aplicativo — exibido na linha de registro de instalação e usado para nomear o arquivo de log de modo de desenvolvimento (<appName>-<mode>.log) quando AGENTIC_DEV_MODES está definido. Corresponde ao Python app_name.

backupCount?

number

Não usado — espaço reservado de paridade.

logDir?

string | null

Diretório de registro — usado somente quando AGENTIC_DEV_MODES está definido para gravar um registro de arquivo de modo de desenvolvimento junto com a saída do console.

logLevel?

string | null

Nível de registro — string ("debug", "info", ...) ou LOG_LEVEL ambiente quando omitido.

mode?

string

modo de corrida (aer / tool / orchestrator / memory-server).

SetupTratingArgs

Propriedades

Propriedade
Tipo
Descrição

mongodbCollectionName?

string

Nome da coleção dentro de mongodbDatabaseName. O padrão é "traces".

mongodbDatabaseName?

string | null

Substituição explícita do banco de dados . Omita o uso do padrão da loja de plataformas.

mongodbUri?

string | null

URI para o armazenamento de rastreamento. Quando fornecido, setupTracing cria o MongoClient, faz pings admin e resolve o próprio (database, collection). O TenantRuntime._setup_tracing do Python faz isso de forma síncrona e passa a coleção; O driver do Node é fundamentalmente assíncrono, portanto, a conexão + ping live aqui. Após uma falha de conexão, uma nova tentativa em segundo plano anexa o exportador MongoDB assim que o armazenamento se recuperar — a mesma forma de recuperação do Python.

serviceName?

string

Falha no subprocesso

Propriedades

Propriedade
Tipo
Descrição

command

string | somente leitura string []

O comando que falhou — array (argv) ou uma única string.

exitCode?

number | null

Código de saída do processo, se conhecido.

stderr?

string | Uint8Array <ArrayBufferLike> | null

stdout?

string | Uint8Array <ArrayBufferLike> | null

TenantRuntimeOptions

Propriedades

Propriedade
Tipo
Descrição

appName?

string

Nome do aplicativo. O padrão é "Agent".

appVersion?

string

Versão do aplicativo. O padrão é "1.0.0".

databaseName?

string | null

Nome explícito do banco de dados para armazenamento de rastreamento. O padrão é a loja de plataformas.

mongodbUri?

string | null

URI do MongoDB usado para persistência do rastreamento. Retorna para MONGODB_URI.

[STRIKEOUT:orgId?]

string | null

Obsoleto ignorado. A organização é retirada da var de ambiente ORG_ID, que a plataforma injeta.

[STRIKEOUT:projectId?]

string | null

Obsoleto ignorado. O projeto é retirado da var de ambiente PROJECT_ID, que a plataforma injeta.

tracesCollectionName?

string

Nome da coleção para armazenamento de rastreamento. O padrão é "traces".

ToolCallChunk

Chamada de ferramenta parcial durante a transmissão.

Todos os campos são opcionais, pois os chunks podem conter dados parciais (por exemplo, apenas o início dos argumentos ou apenas o nome da ferramenta).

Propriedades

Propriedade
Tipo

args?

string

id?

string

index?

number

name?

string

type?

string

WorkflowAdapter

Propriedades

Propriedade
Modifier
Tipo

name

readonly

string

version

readonly

string

Aliases de tipo

ActivityCommand

type ActivityCommand = Message<"mongodb.agentic.workflow.v1.ActivityCommand"> & object;

O ActivityCommand envia uma entrada semântica em uma posição determinística do fluxo de trabalho.

Declaração de tipo

Nome
Tipo
Descrição

activityKind

`ActivityKind <#activitykind>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityKind Activity_ kind = 5;

activityName

string

Gerado a partir do campo: string Activity_name = 6;

attemptId

string

Gerado a partir do campo: string try_id = 2;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 3;

position?

`ActivityPosition <#activityposition>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityPositionposition = 4;

semanticInput?

Value

Gerado a partir do campo: google.protobuf.Value semantic_input = 7;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivityCommand

ActivityContext

type ActivityContext = Message<"mongodb.agentic.workflow.v1.ActivityContext"> & object;

ActivityContext é o contexto mínimo emitido por OE enviado para um trabalhador de atividade.

Declaração de tipo

Nome
Tipo
Descrição

activityId

string

Gerado a partir do campo: string Activity_id = 2;

attemptId

string

Gerado a partir do campo: string try_id = 3;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 4;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivityContext

ActivityHeartbeatRequest

type ActivityHeartbeatRequest = Message<"mongodb.agentic.workflow.v1.ActivityHeartbeatRequest"> & object;

O ActivityHeartbeatRequest renovará o aluguel de uma atividade sob sua cerca atual.

Declaração de tipo

Nome
Tipo
Descrição

activityId

string

Gerado a partir do campo: string Activity_id = 2;

attemptId

string

Gerado a partir do campo: string try_id = 3;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 4;

ownerId

string

Gerado a partir do campo: string proprietário_id = 5;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivityHeartbeatRequest

ActivityMemoryCommand

type ActivityMemoryCommand = Message<"mongodb.agentic.workflow.v1.ActivityMemoryCommand"> & object;

O ActivityMemoryCommand solicita à OE que garanta que o lote de memória produzido pelo wrapper para uma atividade durável tenha sido reconhecido. O mesmo comando segue um resultado recém-executado ou repetido.

Declaração de tipo

Nome
Tipo
Descrição

activityId

string

Gerado a partir do campo: string Activity_id = 2;

attemptId

string

Gerado a partir do campo: string try_id = 3;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 4;

memoryWrites

`MemoryWrite <#memorywrite>`__ []

Gerado a partir do campo: repetido mongodb.agentic.workflow.v1.MemoryWrite memory_writes = 5;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivityMemoryCommand

Resultado da atividade

type ActivityOutcome = Message<"mongodb.agentic.workflow.v1.ActivityOutcome"> & object;

O ActivityOutcome relata um resultado sob sua cerca de tentativa emitida pelo OE.

Declaração de tipo

Nome
Tipo
Descrição

activityId

string

Gerado a partir do campo: string Activity_id = 2;

attemptId

string

Gerado a partir do campo: string try_id = 3;

error?

`WorkflowError <#workspaceror>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowError error = 7;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 4;

outcomeKind

`ActivityOutcomeKind <#activityoutcomekind>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityOutcomeKind result_ kind = 5;

result?

Value

Gerado a partir do campo: google.protobuf.Value result = 6;

suspension?

`ActivitySuspension <#atividadesuspension>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivitySuspension suspensão = 8;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivityOutcome

ActivityPosition

type ActivityPosition = Message<"mongodb.agentic.workflow.v1.ActivityPosition"> & object;

ActivityPosition identifica uma atividade independentemente das novas tentativas. Etapa atividades de escopo ordinal para uma etapa comprometida; o caminho da operação e o ordinal da atividade localizam a atividade dentro dessa etapa.

Declaração de tipo

Nome
Tipo
Descrição

activityOrdinal

bigint

Gerado a partir do campo: int64 Activity_ordinal = 2;

operationPath?

`OperationPath <#operationpath>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.OperationPath operation_path = 1;

stepOrdinal

bigint

Gerado a partir do campo: int64 step_ordinal = 3;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivityPosition

ActivityResolveuHook

type ActivityResolvedHook<T> = (client, context, result) => void | Promise<void>;

Parâmetros de tipo

Type Parameter
Tipo padrão

T

unknown

Parâmetros

Parâmetro
Tipo

client

ActivityRuntimeClient

context

`ActivityContext <#activitycontext>`__

result

T

Devoluções

void | Promise <void>

ActivitySuspension

type ActivitySuspension = Message<"mongodb.agentic.workflow.v1.ActivitySuspension"> & object;

ActivitySuspension descreve por que uma atividade está esperando um resultado externo. O Activity_id em ActivityOutcome é a identidade de espera estável.

Declaração de tipo

Nome
Tipo
Descrição

context?

JsonObject

Gerado a partir do campo: google.protobuf.Struct context = 2;

reason

string

Gerado a partir do campo: string motivo = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.ActivitySuspension

AERExecuteResponse

type AERExecuteResponse = z.infer<typeof AERExecuteResponseSchema>;

AgentFeatureConfig

type AgentFeatureConfig = z.infer<typeof AgentFeatureConfigSchema>;

AgentResumeRequest

type AgentResumeRequest = z.infer<typeof AgentResumeRequestSchema>;

AgentResumeResponse

type AgentResumeResponse = z.infer<typeof AgentResumeResponseSchema>;

AgentStartStreamRequest

type AgentStartStreamRequest = z.infer<typeof AgentStartStreamRequestSchema>;

AttemptContext

type AttemptContext = Message<"mongodb.agentic.workflow.v1.AttemptContext"> & object;

AttemptContext é a identidade e a cerca emitidas pela OE para uma tentativa de tempo de execução.

Declaração de tipo

Nome
Tipo
Descrição

attemptId

string

Gerado a partir do campo: string try_id = 1;

branchLineage?

`BranchLineage <#branchlineage>`__

branch_lineage está presente somente para uma execução ramificada e identifica o limite de origem imutável representado por Previous_state. Gerado a partir do campo: mongodb.agentic.workflow.v1.BranchLineage branch_lineage = 9;

declaration?

`WorkflowDeclaration <#workflowdeclaration>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowDeclaration declaração = 6;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 2;

heartbeatIntervalMs

bigint

Gerado a partir do campo: int64 heartbeat_interval_ms = 7;

ownerId

string

Gerado a partir do campo: string proprietário_id = 3;

previousState?

`StateSnapshot <#statesnapshot>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.StateSnapshot anterior_state = 8;

replayMode

boolean

Gerado a partir do campo: bool replay_mode = 4;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 5;

gerado

da mensagem mongodb.agentic.workflow.v1.AttemptContext

AttemptHeartbeatRequest

type AttemptHeartbeatRequest = Message<"mongodb.agentic.workflow.v1.AttemptHeartbeatRequest"> & object;

O AttemptHeartbeatRequest renovará uma tentativa de aluguel sob sua cerca atual.

Declaração de tipo

Nome
Tipo
Descrição

attemptId

string

Gerado a partir do campo: string try_id = 2;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 3;

ownerId

string

Gerado a partir do campo: string proprietário_id = 4;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.AttemptHeartbeatRequest

AttemptStartRequest

type AttemptStartRequest = Message<"mongodb.agentic.workflow.v1.AttemptStartRequest"> & object;

AttemptStartRequest solicita ao OE que ative uma tentativa de execução.

Declaração de tipo

Nome
Tipo
Descrição

declaration?

`WorkflowDeclaration <#workflowdeclaration>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowDeclaration declaração = 3;

ownerId

string

Gerado a partir do campo: string proprietário_id = 2;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.AttemptStartRequest

AttemptStartResponse

type AttemptStartResponse = Message<"mongodb.agentic.workflow.v1.AttemptStartResponse"> & object;

AttemptStartResponse retorna a tentativa aceita ou um erro estável.

Declaração de tipo

Nome
Tipo
Descrição

attemptContext?

`AttemptContext <#attemptcontext>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.AttemptContext try_context = 1;

error?

`WorkflowError <#workspaceror>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowError error = 2;

gerado

da mensagem mongodb.agentic.workflow.v1.AttemptStartResponse

branchLineage

type BranchLineage = Message<"mongodb.agentic.workflow.v1.BranchLineage"> & object;

branchLineage identifica o limite de origem imutável para uma tentativa de branch.

Declaração de tipo

Nome
Tipo
Descrição

sourceStateHash

string

source_state_hash é o hash canônico do snapshot de origem confirmada em source_step_ordinal. Gerado a partir do campo: string source_state_hash = 3;

sourceStepOrdinal

bigint

source_step_ordinal é o ordinal positivo de etapas confirmadas cujo snapshot semeia a ramificação. As etapas locais da ramificação começam após esse limite. Gerado a partir do campo: int64 source_step_ordinal = 2;

sourceWorkflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

source_workflow_identity identifica a execução de origem na organização, projeto e espaço de trabalho da ramificação. Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity source_workflow_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.BranchLineage

Comando CompleteExecution

type CompleteExecutionCommand = Message<"mongodb.agentic.workflow.v1.CompleteExecutionCommand"> & object;

CompleteExecutionCommand confirma um estado final de execução bem-sucedida para a próxima invocação na sessão.

Declaração de tipo

Nome
Tipo
Descrição

attemptId

string

Gerado a partir do campo: string try_id = 2;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 3;

state?

`StateSnapshot <#statesnapshot>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.StateSnapshot state = 4;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.CompleteExecutionCommand

CostByModel

type CostByModel = z.infer<typeof CostByModelSchema>;

CostByWorkspace

type CostByWorkspace = z.infer<typeof CostByWorkspaceSchema>;

CostDashboardResponse

type CostDashboardResponse = z.infer<typeof CostDashboardResponseSchema>;

CostSummary

type CostSummary = z.infer<typeof CostSummarySchema>;

DailyCostEntry

type DailyCostEntry = z.infer<typeof DailyCostEntrySchema>;

ElicitationInfo

type ElicitationInfo = z.infer<typeof ElicitationInfoSchema>;

ExecuteRequest

type ExecuteRequest = z.infer<typeof ExecuteRequestSchema>;

Execução

type Execution = z.infer<typeof ExecutionSchema>;

ExecutionDetailQueryResponse

type ExecutionDetailQueryResponse = z.infer<typeof ExecutionDetailQueryResponseSchema>;

Documento de execução

type ExecutionDocument = z.infer<typeof ExecutionDocumentSchema>;

ExecutionLogsQueryResponse

type ExecutionLogsQueryResponse = z.infer<typeof ExecutionLogsQueryResponseSchema>;

ExecutionsListQueryResponse

type ExecutionsListQueryResponse = z.infer<typeof ExecutionsListQueryResponseSchema>;

Status da execução

type ExecutionStatus = z.infer<typeof ExecutionStatusSchema>;

ExecutionStatusResponse

type ExecutionStatusResponse = z.infer<typeof ExecutionStatusResponseSchema>;

Etapa de execução

type ExecutionStep = z.infer<typeof ExecutionStepSchema>;

ExecutorCallbackRequest

type ExecutorCallbackRequest = z.infer<typeof ExecutorCallbackRequestSchema>;

FeatureName

type FeatureName = keyof AgentFeatureConfig;

Derivado de AgentFeatureConfigSchema — não mantenha uma união paralela.

Comando FinalizeStep

type FinalizeStepCommand = Message<"mongodb.agentic.workflow.v1.FinalizeStepCommand"> & object;

O FinalizeStepCommand atinge um limite de framework. Uma etapa raiz estabelecida fornece um estado; uma etapa interrompida fornece sua borda de suspensão completa.

Declaração de tipo

Nome
Tipo
Descrição

attemptId

string

Gerado a partir do campo: string try_id = 2;

fencingToken

bigint

Gerado a partir do campo: int64 fencing_token = 3;

observedActivityPositions

`ActivityPosition <#activityposition>`__ []

Observed_atividade_positions relata as posições de atividade que essa tentativa encontrou antes da finalização. OE valida a integridade em relação ao histórico. Gerado a partir do campo: repetido mongodb.agentic.workflow.v1.ActivityPosition observed_atividade_positions = 6;

state?

`StateSnapshot <#statesnapshot>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.StateSnapshot state = 4;

stepOrdinal

bigint

Gerado a partir do campo: int64 step_ordinal = 5;

suspensions

`StepSuspensionEntry <#stepsuspendionentry>`__ []

Gerado a partir do campo: repetido mongodb.agentic.workflow.v1.StepSuspensionEntry suspensões = 7;

workflowIdentity?

`WorkflowIdentity <#workflowidentity>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowIdentity pipeline_identity = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.FinalizeStepCommand

FinalizeStepResponse

type FinalizeStepResponse = Message<"mongodb.agentic.workflow.v1.FinalizeStepResponse"> & object;

O FinalizeStepResponse retorna cada resultado posicionado para uma borda interrompida e nenhuma entrada para uma etapa de raiz comprometida.

Declaração de tipo

Nome
Tipo
Descrição

entries

`StepActivityEntry <#steptivityentry>`__ []

Gerado a partir do campo: mongodb.agentic.workflow.v1.StepActivityEntry registros repetidos = 1;

error?

`WorkflowError <#workspaceror>'__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowError error = 2;

gerado

da mensagem mongodb.agentic.workflow.v1.FinalizeStepResponse

GuardrailCheckContext

type GuardrailCheckContext = z.infer<typeof GuardrailCheckContextSchema>;

GuardrailCheckDecision

type GuardrailCheckDecision = z.infer<typeof GuardrailCheckDecisionSchema>;

GuardrailCheckEvidence

type GuardrailCheckEvidence = z.infer<typeof GuardrailCheckEvidenceSchema>;

GuardrailCheckInput

type GuardrailCheckInput = z.infer<typeof GuardrailCheckInputSchema>;

GuardrailCheckRequest

type GuardrailCheckRequest = z.infer<typeof GuardrailCheckRequestSchema>;

GuardrailCheckResponse

type GuardrailCheckResponse = z.infer<typeof GuardrailCheckResponseSchema>;

GuardrailMeta

type GuardrailMeta = z.infer<typeof GuardrailMetaSchema>;

GuardrailRuntimePolicy

type GuardrailRuntimePolicy = z.infer<typeof GuardrailRuntimePolicySchema>;

GuardrailRuntimeStage

type GuardrailRuntimeStage = z.infer<typeof GuardrailRuntimeStageSchema>;

HealthResponse

type HealthResponse = z.infer<typeof HealthResponseSchema>;

HealthStatus

type HealthStatus = z.infer<typeof HealthStatusSchema>;

HumanReviewData

type HumanReviewData = z.infer<typeof HumanReviewDataSchema>;

Instrumentor

type Instrumentor = () => void;

Devoluções

void

InterruptResult

type InterruptResult = z.infer<typeof InterruptResultSchema>;

InvokeLLMRequestArguments

type InvokeLLMRequestArguments = z.infer<typeof InvokeLLMRequestArgumentsSchema>;

InvokeRequest

type InvokeRequest = z.infer<typeof InvokeRequestSchema>;

InvokeResponse

type InvokeResponse = z.infer<typeof InvokeResponseSchema>;

JsonValue

type JsonValue =
  | string
  | number
  | boolean
  | null
  | JsonValue[]
  | {
[key: string]: JsonValue;
};

LLMAdapterFactory

type LLMAdapterFactory = (rawLlm, options?) => BaseLLM;

Parâmetros

Parâmetro
Tipo

rawLlm

unknown

options?

{ tool_choice?: unknown; tools?: unknown []; }

options.tool_choice?

unknown

options.tools?

unknown []

Devoluções

BaseLLM

LLMPodInvokeRequest

type LLMPodInvokeRequest = z.infer<typeof LLMPodInvokeRequestSchema>;

LLMPodInvokeResponse

type LLMPodInvokeResponse = z.infer<typeof LLMPodInvokeResponseSchema>;

LLMPodStreamEvent

type LLMPodStreamEvent = z.infer<typeof LLMPodStreamEventSchema>;

Gravação de memória

type MemoryWrite = Message<"mongodb.agentic.workflow.v1.MemoryWrite"> & object;

MemoryWrite é uma solicitação exata de memória de curto prazo produzida por um wrapper. OE encaminha payload_json sem interpretar mensagens de framework.

Declaração de tipo

Nome
Tipo
Descrição

id

string

Gerado a partir do campo: string id = 1;

payloadJson

Uint8Array

Gerado a partir do campo: bytes payload_json = 2;

gerado

da mensagem mongodb.agentic.workflow.v1.MemoryWrite

NodeExecutionRequest

type NodeExecutionRequest = z.infer<typeof NodeExecutionRequestSchema>;

NodeExecutionsQueryResponse

type NodeExecutionsQueryResponse = z.infer<typeof NodeExecutionsQueryResponseSchema>;

OperationPath

type OperationPath = Message<"mongodb.agentic.workflow.v1.OperationPath"> & object;

OperationPath é um caminho determinístico absoluto dentro de uma execução.

Declaração de tipo

Nome
Tipo
Descrição

segments

`OperationPathSegment <#operationpathsegment>'__ []

Gerado a partir do campo: repetidos segmentos mongodb.agentic.workflow.v1.OperationPathSegment = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.OperationPath

OperationPathResolver

type OperationPathResolver = () => readonly ChildOperationBoundary[];

Devoluções

readonly `ChildOperationBoundary <#childoperationboundary>`__ []

OperationPathSegment

type OperationPathSegment = Message<"mongodb.agentic.workflow.v1.OperationPathSegment"> & object;

OperationPathSegment é uma posição determinística em um caminho de operação.

Declaração de tipo

Nome
Tipo
Descrição

name

string

Gerado a partir do campo: string name = 1;

ordinal

bigint

Gerado a partir do campo: int64 ordinal = 2;

gerado

da mensagem mongodb.agentic.workflow.v1.OperationPathSegment

Interrupção pendente

type PendingInterrupt = z.infer<typeof PendingInterruptSchema>;

RuntimeMCPAuthConfig

type RuntimeMCPAuthConfig = z.infer<typeof RuntimeMCPAuthConfigSchema>;

RuntimeMCPConfig

type RuntimeMCPConfig = z.infer<typeof RuntimeMCPConfigSchema>;

RuntimeMCPServerConfig

type RuntimeMCPServerConfig = z.infer<typeof RuntimeMCPServerConfigSchema>;

SecretsConfig

type SecretsConfig = z.infer<typeof SecretsConfigSchema>;

SecretsConfigInput

type SecretsConfigInput = z.input<typeof SecretsConfigSchema>;

Os chamadores de formas de entrada podem construir: toda chave é omitida, já que os padrões do Zd as preenchem. O SecretsConfig analisado tem todas elas presentes.

ServerToolFn

type ServerToolFn = (args) => unknown;

Assinatura da função da ferramenta - recebe os argumentos completos do Registro e pode retornar uma Promessa.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

unknown

Status da conclusão da sessão

type SessionFinishStatus = "requested" | "already_requested" | "unavailable";

SessionInfo

type SessionInfo = z.infer<typeof SessionInfoSchema>;

Mensagem da sessão

type SessionMessage = z.infer<typeof SessionMessageSchema>;

SessionMessagesQueryResponse

type SessionMessagesQueryResponse = z.infer<typeof SessionMessagesQueryResponseSchema>;

SessionsQueryResponse

type SessionsQueryResponse = z.infer<typeof SessionsQueryResponseSchema>;

StartActivityResult

type StartActivityResult =
  | ActivityDispatch
  | ActivityReplay;

StateSnapshot

type StateSnapshot = Message<"mongodb.agentic.workflow.v1.StateSnapshot"> & object;

StateSnapshot é o estado completo do aplicação necessário para a próxima curva. As propriedades excluem o canal de mensagens convencional.

Declaração de tipo

Nome
Tipo
Descrição

messageEncodingVersion

number

A versão 0 é a codificação legado de source_message. Versão 1 significa que cada mensagem carrega os campos explícitos necessários para a reconstrução da framework. Gerado a partir do campo: uint32 message_encoding_version = 3;

messages

`WorkflowMessage <#workflowmessage>`__ []

Gerado a partir do campo: mensagens repetidas mongodb.agentic.workflow.v1.WorkflowMessage = 2;

properties?

JsonObject

Gerado a partir do campo: propriedades do google.protobuf.Struct = 1;

replayProperties?

JsonObject

Estado do aplicação selecionado pelo adaptador usado somente para comparação de reprodução de substituição. Quando ausentes, as propriedades são a entrada de comparação de repetição. Gerado do campo: google.protobuf.Struct replay_properties = 4;

gerado

da mensagem mongodb.agentic.workflow.v1.StateSnapshot

StepActivityEntry

type StepActivityEntry = Message<"mongodb.agentic.workflow.v1.StepActivityEntry"> & object;

StepActivityEntry vincula um resultado de atividade durável à sua posição imutável. A ordem de resposta não tem significado.

Declaração de tipo

Nome
Tipo
Descrição

outcome?

`ActivityOutcome <#activityoutcome>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityOutcome result = 2;

position?

`ActivityPosition <#activityposition>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityPositionposition = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.StepActivityEntry

StepSuspensionEntry

type StepSuspensionEntry = Message<"mongodb.agentic.workflow.v1.StepSuspensionEntry"> & object;

StepSuspensionEntry descreve uma atividade descoberta suspensa quando sua estrutura atinge um limite de etapa inativa. O FinalizeStep permite o conjunto completo atomicamente, para que nenhuma faixa de suspensão parcial se torne durável.

Declaração de tipo

Nome
Tipo
Descrição

activityKind

`ActivityKind <#activitykind>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityKind Activity_ kind = 2;

activityName

string

Gerado a partir do campo: string Activity_name = 3;

position?

`ActivityPosition <#activityposition>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivityPositionposition = 1;

semanticInput?

Value

Gerado a partir do campo: google.protobuf.Value semantic_input = 4;

suspension?

`ActivitySuspension <#atividadesuspension>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.ActivitySuspension suspensão = 5;

gerado

da mensagem mongodb.agentic.workflow.v1.StepSuspensionEntry

StreamChunk

type StreamChunk = z.infer<typeof StreamChunkSchema>;

StreamingResult

type StreamingResult = z.infer<typeof StreamingResultSchema>;

SuspendHandler

type SuspendHandler = (payload) => Record<string, unknown>;

Parâmetros

Parâmetro
Tipo

payload

Record <string, unknown>

Devoluções

Record <string, unknown>

Suspender carga

type SuspendPayload = z.infer<typeof SuspendPayloadSchema>;

TenantScope

type TenantScope = Message<"mongodb.agentic.workflow.v1.TenantScope"> & object;

TenantScope identifica o limite do locatário do plano de dados para um fluxo de trabalho.

Declaração de tipo

Nome
Tipo
Descrição

orgId

string

Gerado a partir do campo: string org_id = 1;

projectId

string

Gerado a partir do campo: string project_id = 2;

workspaceId

string

Gerado a partir do campo: string workspace_id = 3;

gerado

da mensagem mongodb.agentic.workflow.v1.TenantScope

Erro da API da ferramenta

type ToolAPIError = z.infer<typeof ToolAPIErrorSchema>;

Autorização de ferramenta

type ToolAuthorization = z.infer<typeof ToolAuthorizationSchema>;

Definição de ferramenta

type ToolDefinition = z.infer<typeof ToolDefinitionSchema>;

ToolExecuteRequest

type ToolExecuteRequest = z.infer<typeof ToolExecuteRequestSchema>;

ToolExecuteResponse

type ToolExecuteResponse = z.infer<typeof ToolExecuteResponseSchema>;

ToolFunctionRequest

type ToolFunctionRequest = z.infer<typeof ToolFunctionRequestSchema>;

ToolPodExecuteRequest

type ToolPodExecuteRequest = z.infer<typeof ToolPodExecuteRequestSchema>;

ToolPodExecuteResponse

type ToolPodExecuteResponse = z.infer<typeof ToolPodExecuteResponseSchema>;

ToolResponseFormat

type ToolResponseFormat = "content" | "content_and_artifact";

ToolResultRequest

type ToolResultRequest = z.infer<typeof ToolResultRequestSchema>;

FerramentasListaResposta

type ToolsListResponse = z.infer<typeof ToolsListResponseSchema>;

Declaração de fluxo de trabalho

type WorkflowDeclaration = Message<"mongodb.agentic.workflow.v1.WorkflowDeclaration"> & object;

WorkflowDeclaration descreve o aplicação imutável e o contrato do adaptador.

Declaração de tipo

Nome
Tipo
Descrição

adapterName

string

Gerado a partir do campo: string adaptor_name = 3;

adapterVersion

string

Gerado a partir do campo: string adaptor_version = 4;

memoryEnabled

boolean

memory_enabled fixa o agente.yaml feature.memory para a execução, para que as tentativas de substituição usem o contrato de sincronização original. Gerado a partir do campo: bool memory_enabled = 5;

workflowName

string

Gerado a partir do campo: string pipeline_name = 1;

workflowVersion

string

Gerado a partir do campo: string pipeline_version = 2;

gerado

da mensagem mongodb.agentic.workflow.v1.WorkflowDeclaration

Erro de Fluxo de Trabalho

type WorkflowError = Message<"mongodb.agentic.workflow.v1.WorkflowError"> & object;

O WorkflowError carrega um código estável e uma mensagem de diagnóstico editada.

Declaração de tipo

Nome
Tipo
Descrição

code

`WorkflowErrorCode <#work Bloscherorcode>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.WorkflowErrorCode code = 1;

message

string

Gerado a partir do campo: string message = 2;

gerado

da mensagem mongodb.agentic.workflow.v1.WorkflowError

WorkflowIdentity

type WorkflowIdentity = Message<"mongodb.agentic.workflow.v1.WorkflowIdentity"> & object;

WorkflowIdentity identifica uma sessão e uma execução durável.

Declaração de tipo

Nome
Tipo
Descrição

executionId

string

Gerado a partir do campo: string execution_id = 3;

sessionId

string

Gerado a partir do campo: string session_id = 2;

tenantScope?

`TenantScope <#tenantscope>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.TenantScope tenant_scope = 1;

gerado

da mensagem mongodb.agentic.workflow.v1.WorkflowIdentity

Mensagem de fluxo de trabalho

type WorkflowMessage = Message<"mongodb.agentic.workflow.v1.WorkflowMessage"> & object;

WorkflowMessage é o valor de conversa durável e neutro em termos de estrutura. Os adaptadores de estrutura reconstruem seus tipos de mensagens nativas a partir desses campos explícitos; a saída do serializador do framework não é um estado durável.

Declaração de tipo

Nome
Tipo
Descrição

additionalKwargs?

JsonObject

Gerado a partir do campo: google.protobuf.Struct additional_kservices = 11;

artifacts

JsonObject []

campo de anexação de plataforma obsoleto emparelhado com source_message. Gerado a partir do campo: artefatos repetidos do google.protobuf.Struct = 10 [obsoleto = verdadeiro]; Obsoleto(a)

content?

Value

Gerado a partir do campo: google.protobuf.Value conteúdo = 2;

id?

string

Gerado a partir do campo: string opcional id = 6;

invalidToolCalls

JsonObject []

Gerado a partir do campo: repetido google.protobuf.Struct invalid_tool_calls = 16;

isError?

boolean

Gerado a partir do campo: opcional bool is_error = 13;

name?

string

Gerado a partir do campo: string opcional name = 5;

platformArtifacts

JsonObject []

Os artefatos de plataforma são anexos de mensagens de propriedade da plataforma exibidos por meio de metadados de mensagens. Eles são diferentes do tool_artifact de um resultado de ferramenta. Gerado a partir do campo: repetido google.protobuf.Struct platform_artifacts = 15;

responseMetadata?

JsonObject

Gerado a partir do campo: google.protobuf.Struct response_metadata = 12;

role

`MessageRole <#messagerole>`__

Gerado a partir do campo: mongodb.agentic.workflow.v1.MessageRole role = 1;

sourceMessage?

Value

Envelope de compatibilidade obsoleto para estados escritos antes da introdução dos campos de mensagem explícita. Os adaptadores o leem durante o replay, mas não o gravam para novas execuções. Gerado do campo: google.protobuf.Value source_message = 9 [descontinuado = verdadeiro]; Obsoleto(a)

toolArtifact?

Value

O artefato de ferramenta são dados de resultado legíveis por máquina mantidos fora do canal de conteúdo voltado para o modelo. Pode conter qualquer valor JSON. Gerado a partir do campo: google.protobuf.Value tool_artifact = 14;

toolCallId?

string

Gerado a partir do campo: opcional string tool_call_id = 4;

toolCalls

JsonObject []

Gerado a partir do campo: repetido google.protobuf.Struct tool_calls = 3;

gerado

da mensagem mongodb.agentic.workflow.v1.WorkflowMessage

variáveis

ActivityCommandSchema

const ActivityCommandSchema: GenMessage<ActivityCommand>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivityCommand. Use create(ActivityCommandSchema) para criar uma nova mensagem.

ActivityContextSchema

const ActivityContextSchema: GenMessage<ActivityContext>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivityContext. Use create(ActivityContextSchema) para criar uma nova mensagem.

ActivityHeartbeatRequestSchema

const ActivityHeartbeatRequestSchema: GenMessage<ActivityHeartbeatRequest>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivityHeartbeatRequest. Use create(ActivityHeartbeatRequestSchema) para criar uma nova mensagem.

ActivityKindSchema

const ActivityKindSchema: GenEnum<ActivityKind>;

Descreve o enumeração mongodb.agentic.workflow.v1.ActivityKind.

ActivityMemoryCommandSchema

const ActivityMemoryCommandSchema: GenMessage<ActivityMemoryCommand>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivityMemoryCommand. Use create(ActivityMemoryCommandSchema) para criar uma nova mensagem.

ActivityOutcomeKindSchema

const ActivityOutcomeKindSchema: GenEnum<ActivityOutcomeKind>;

Descreve o enumeração mongodb.agentic.workflow.v1.ActivityOutcomeKind.

ActivityOutcomeSchema

const ActivityOutcomeSchema: GenMessage<ActivityOutcome>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivityOutcome. Use create(ActivityOutcomeSchema) para criar uma nova mensagem.

ActivityPositionSchema

const ActivityPositionSchema: GenMessage<ActivityPosition>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivityPosition. Use create(ActivityPositionSchema) para criar uma nova mensagem.

ActivitySuspensionSchema

const ActivitySuspensionSchema: GenMessage<ActivitySuspension>;

Descreve a mensagem mongodb.agentic.workflow.v1.ActivitySuspension. Use create(ActivitySuspensionSchema) para criar uma nova mensagem.

AER_BUILD_AGENT

const AER_BUILD_AGENT: "aer.build_agent" = "aer.build_agent";

Nomes de extensão estáveis para o ciclo de vida do primeiro chamar. Não há extensão manual de llm.call; A auto-instrumentação do LangChain já cobre isso.

AERExecuteResponseSchema

const AERExecuteResponseSchema: ZodObject<{
  result: ZodOptional<ZodString>;
  status: ZodString;
  suspend_reason: ZodOptional<ZodString>;
}, $strip>;

Resposta do endpoint AER /execute.

Retornado na conclusão normal e na suspensão HITL.

AgentFeatureConfigSchema

const AgentFeatureConfigSchema: ZodObject<{
  deep_agent: ZodDefault<ZodNullable<ZodBoolean>>;
  durable_workflow: ZodDefault<ZodNullable<ZodBoolean>>;
  guardrails: ZodDefault<ZodNullable<ZodBoolean>>;
  memory: ZodDefault<ZodNullable<ZodBoolean>>;
  playground: ZodDefault<ZodNullable<ZodBoolean>>;
  use_custom_parser: ZodDefault<ZodNullable<ZodBoolean>>;
}, $strip>;

O recurso de tempo de execução sinaliza a partir de agent.yaml.

Mantenha os nomes de campo em paridade com o Python AgentFeatureConfig e a lista de permissões do CLI. Adicione um sinalizador adicionando um campo aqui; FeatureName e o acesso às funcionalidades de tempo de execução derivam dele. null significa "omitido", permitindo que o tempo de execução retorne às variáveis de ambiente legado .

AgentResumeRequestSchema

const AgentResumeRequestSchema: ZodObject<{
  custom_headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
  human_review: ZodObject<{
     decision: ZodString;
     reviewer_notes: ZodOptional<ZodString>;
  }, $strip>;
}, $strip>;

Solicitar a retomada de uma execução suspensa.

AgentResumeResponseSchema

const AgentResumeResponseSchema: ZodObject<{
  execution_id: ZodString;
  status: ZodString;
}, $strip>;

Resposta ao retomar uma execução.

AgentStartStreamRequestSchema

const AgentStartStreamRequestSchema: ZodObject<{
  message: ZodString;
  org_id: ZodOptional<ZodString>;
  session_id: ZodOptional<ZodString>;
  user_id: ZodOptional<ZodString>;
}, $strip>;

Solicite para iniciar uma execução do agente com resposta de transmissão.

AttemptContextSchema

const AttemptContextSchema: GenMessage<AttemptContext>;

Descreve a mensagem mongodb.agentic.workflow.v1.AttemptContext. Use create(AttemptContextSchema) para criar uma nova mensagem.

AttemptHeartbeatRequestSchema

const AttemptHeartbeatRequestSchema: GenMessage<AttemptHeartbeatRequest>;

Descreve a mensagem mongodb.agentic.workflow.v1.AttemptHeartbeatRequest. Use create(AttemptHeartbeatRequestSchema) para criar uma nova mensagem.

AttemptStartRequestSchema

const AttemptStartRequestSchema: GenMessage<AttemptStartRequest>;

Descreve a mensagem mongodb.agentic.workflow.v1.AttemptStartRequest. Use create(AttemptStartRequestSchema) para criar uma nova mensagem.

AttemptStartResponseSchema

const AttemptStartResponseSchema: GenMessage<AttemptStartResponse>;

Descreve a mensagem mongodb.agentic.workflow.v1.AttemptStartResponse. Use create(AttemptStartResponseSchema) para criar uma nova mensagem.

AtTR_CACHE_HIT

const ATTR_CACHE_HIT: "cache_hit" = "cache_hit";

AtTR_COLD_START

const ATTR_COLD_START: "cold_start" = "cold_start";

atTR_SKILLS_LOEADED_COUNT

const ATTR_SKILLS_LOADED_COUNT: "skills.loaded_count" = "skills.loaded_count";

AtTR_SKILLS_SOURCE_COUNT

const ATTR_SKILLS_SOURCE_COUNT: "skills.source_count" = "skills.source_count";

branchLineageSchema

const BranchLineageSchema: GenMessage<BranchLineage>;

Descreve a mensagem mongodb.agentic.workflow.v1.BranchLineage. Use create(BranchLineageSchema) para criar uma nova mensagem.

BUILTIN_TOOL_NAMES

const BUILTIN_TOOL_NAMES: ReadonlySet<string>;

Conjunto canônico de nomes de ferramentas embutidas registradas por registerBuiltinTools. consumido pela afirmação de integridade de ToolServer.onStartup e por testes para que os locais de chamada não possam flutuar silenciosamente.

CALL_INTERRUPTED_ARTIFact_KEY

const CALL_INTERRUPTED_ARTIFACT_KEY: "__agent_engine_oe_call_interrupted__" = "__agent_engine_oe_call_interrupted__";

Chave de fio de interrupção congelada.

Folha de dependência (sem importações): workflow/memory.ts e secure_wrapper.ts consomem isso sem formar um ciclo de módulo pelo cano do fluxo de trabalho. A chave é persistente em pontos de verificação e registros de repetição e duplicada em Runner-shared/src/agent_engine_current_shared/secure_wrapper.py. A alteração de uma das quebras de valor interrompe a detecção em sessões já com ponto de verificação e/ou paridade entre linguagens — mantenha os dois em sincronia.

CompleteExecutionCommandSchema

const CompleteExecutionCommandSchema: GenMessage<CompleteExecutionCommand>;

Descreve a mensagem mongodb.agentic.workflow.v1.CompleteExecutionCommand. Use create(CompleteExecutionCommandSchema) para criar uma nova mensagem.

CostByModelSchema

const CostByModelSchema: ZodObject<{
  call_count: ZodDefault<ZodNumber>;
  model: ZodString;
  percentage: ZodDefault<ZodNumber>;
  total_cost_usd: ZodDefault<ZodNumber>;
  total_tokens: ZodDefault<ZodNumber>;
}, $strip>;

Detalhamento do custo para um único modelo.

CostByWorkspaceSchema

const CostByWorkspaceSchema: ZodObject<{
  call_count: ZodDefault<ZodNumber>;
  percentage: ZodDefault<ZodNumber>;
  total_cost_usd: ZodDefault<ZodNumber>;
  total_tokens: ZodDefault<ZodNumber>;
  workspace_id: ZodString;
}, $strip>;

Detalhamento do custo de um único workspace.

CostDashboardResponseSchema

const CostDashboardResponseSchema: ZodObject<{
  by_model: ZodDefault<ZodArray<ZodObject<{
     call_count: ZodDefault<ZodNumber>;
     model: ZodString;
     percentage: ZodDefault<ZodNumber>;
     total_cost_usd: ZodDefault<ZodNumber>;
     total_tokens: ZodDefault<ZodNumber>;
  }, $strip>>>;
  by_workspace: ZodDefault<ZodArray<ZodObject<{
     call_count: ZodDefault<ZodNumber>;
     percentage: ZodDefault<ZodNumber>;
     total_cost_usd: ZodDefault<ZodNumber>;
     total_tokens: ZodDefault<ZodNumber>;
     workspace_id: ZodString;
  }, $strip>>>;
  daily_trend: ZodDefault<ZodArray<ZodObject<{
     call_count: ZodDefault<ZodNumber>;
     date: ZodString;
     total_cost_usd: ZodDefault<ZodNumber>;
     total_tokens: ZodDefault<ZodNumber>;
  }, $strip>>>;
  summary: ZodDefault<ZodObject<{
     total_completion_tokens: ZodDefault<ZodNumber>;
     total_cost_usd: ZodDefault<ZodNumber>;
     total_llm_calls: ZodDefault<ZodNumber>;
     total_prompt_tokens: ZodDefault<ZodNumber>;
     total_tokens: ZodDefault<ZodNumber>;
     unpriced_llm_calls: ZodDefault<ZodNumber>;
  }, $strip>>;
}, $strip>;

Resposta para agregação do painel de custos (usado pelo proxy do API Gateway).

CostSummarySchema

const CostSummarySchema: ZodObject<{
  total_completion_tokens: ZodDefault<ZodNumber>;
  total_cost_usd: ZodDefault<ZodNumber>;
  total_llm_calls: ZodDefault<ZodNumber>;
  total_prompt_tokens: ZodDefault<ZodNumber>;
  total_tokens: ZodDefault<ZodNumber>;
  unpriced_llm_calls: ZodDefault<ZodNumber>;
}, $strip>;

Métricas de custo agregadas para o período solicitado.

DailyCostEntrySchema

const DailyCostEntrySchema: ZodObject<{
  call_count: ZodDefault<ZodNumber>;
  date: ZodString;
  total_cost_usd: ZodDefault<ZodNumber>;
  total_tokens: ZodDefault<ZodNumber>;
}, $strip>;

Dados de custo de um único dia.

DEFAULT_MCP_OAUTH_CLIENT_NAME

const DEFAULT_MCP_OAUTH_CLIENT_NAME: "Atlas Agent Engine Dev MCP Client" = "Atlas Agent Engine Dev MCP Client";

DEFAULT_MCP_OAUTH_REDIRECT_URI

const DEFAULT_MCP_OAUTH_REDIRECT_URI: "http://127.0.0.1:8765/callback" = "http://127.0.0.1:8765/callback";

DEFAULT_PORTS

const DEFAULT_PORTS: Record<string, number>;

ElicitationInfoSchema

const ElicitationInfoSchema: ZodObject<{
  authorization_url: ZodString;
  created: ZodDefault<ZodBoolean>;
  elicitation_id: ZodString;
  message: ZodDefault<ZodString>;
}, $strip>;

Detalhes da autorização retornados quando o Consentimento do Corretor é Necessário.

ExecuteRequestSchema

const ExecuteRequestSchema: ZodObject<{
  custom_headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
  execution_id: ZodString;
  message: ZodDefault<ZodString>;
  metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  org_id: ZodOptional<ZodString>;
  payload: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  platform_api_owner_url: ZodOptional<ZodNullable<ZodString>>;
  platform_api_url: ZodString;
  platform_trace_id: ZodOptional<ZodNullable<ZodString>>;
  previous_execution_cancelled: ZodDefault<ZodBoolean>;
  project_id: ZodOptional<ZodString>;
  resume: ZodDefault<ZodBoolean>;
  resume_data: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  resume_from_step: ZodOptional<ZodNumber>;
  session_id: ZodOptional<ZodString>;
  suspend_generation: ZodOptional<ZodPipe<ZodNullable<ZodNumber>, ZodTransform<number | undefined, number | null>>>;
  user_id: ZodOptional<ZodString>;
  workspace_id: ZodOptional<ZodString>;
}, $strip>;

Solicite a execução de um agente no AER.

ExecutionDetailQueryResponseSchema

const ExecutionDetailQueryResponseSchema: ZodObject<{
  error: ZodOptional<ZodString>;
  execution: ZodOptional<ZodObject<{
     created_at: ZodOptional<ZodString>;
     error: ZodOptional<ZodString>;
     execution_id: ZodString;
     message: ZodDefault<ZodString>;
     org_id: ZodDefault<ZodString>;
     project_id: ZodDefault<ZodNullable<ZodString>>;
     result: ZodOptional<ZodUnknown>;
     session_id: ZodDefault<ZodString>;
     status: ZodDefault<ZodString>;
     suspend_context: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     suspend_reason: ZodOptional<ZodString>;
     updated_at: ZodOptional<ZodString>;
     user_id: ZodDefault<ZodString>;
     workspace_id: ZodDefault<ZodNullable<ZodString>>;
  }, $strip>>;
  success: ZodDefault<ZodBoolean>;
}, $strip>;

Resposta para query de detalhes de execução única (usada pelo proxy do API Gateway).

ExecutionDocumentSchema

const ExecutionDocumentSchema: ZodObject<{
  created_at: ZodOptional<ZodString>;
  error: ZodOptional<ZodString>;
  execution_id: ZodString;
  message: ZodDefault<ZodString>;
  org_id: ZodDefault<ZodString>;
  project_id: ZodDefault<ZodNullable<ZodString>>;
  result: ZodOptional<ZodUnknown>;
  session_id: ZodDefault<ZodString>;
  status: ZodDefault<ZodString>;
  suspend_context: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  suspend_reason: ZodOptional<ZodString>;
  updated_at: ZodOptional<ZodString>;
  user_id: ZodDefault<ZodString>;
  workspace_id: ZodDefault<ZodNullable<ZodString>>;
}, $strip>;

Um documento de execução conforme armazenado no banco de dados da plataforma .

ExecutionLogsQueryResponseSchema

const ExecutionLogsQueryResponseSchema: ZodObject<{
  count: ZodDefault<ZodNumber>;
  logs: ZodDefault<ZodArray<ZodRecord<ZodString, ZodUnknown>>>;
}, $strip>;

Resposta para query de registros de execução (usada pelo proxy do API Gateway).

ExecutionSchema

const ExecutionSchema: ZodObject<{
  aer_url: ZodOptional<ZodString>;
  created_at: ZodDefault<ZodCoercedDate<unknown>>;
  error: ZodOptional<ZodString>;
  id: ZodString;
  message: ZodString;
  org_id: ZodOptional<ZodString>;
  project_id: ZodOptional<ZodString>;
  result: ZodOptional<ZodUnknown>;
  session_id: ZodOptional<ZodString>;
  status: ZodEnum<{
     cancelled: "cancelled";
     completed: "completed";
     error: "error";
     pending: "pending";
     resuming: "resuming";
     running: "running";
     suspended: "suspended";
  }>;
  suspend_context: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  suspend_reason: ZodOptional<ZodString>;
  tool_url: ZodOptional<ZodString>;
  updated_at: ZodDefault<ZodCoercedDate<unknown>>;
  user_id: ZodOptional<ZodString>;
  workspace_id: ZodOptional<ZodString>;
}, $strip>;

Registro de execução armazenado no TenantDB.

ExecutionsListQueryResponseSchema

const ExecutionsListQueryResponseSchema: ZodObject<{
  count: ZodDefault<ZodNumber>;
  executions: ZodDefault<ZodArray<ZodObject<{
     created_at: ZodOptional<ZodString>;
     error: ZodOptional<ZodString>;
     execution_id: ZodString;
     message: ZodDefault<ZodString>;
     org_id: ZodDefault<ZodString>;
     project_id: ZodDefault<ZodNullable<ZodString>>;
     result: ZodOptional<ZodUnknown>;
     session_id: ZodDefault<ZodString>;
     status: ZodDefault<ZodString>;
     suspend_context: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     suspend_reason: ZodOptional<ZodString>;
     updated_at: ZodOptional<ZodString>;
     user_id: ZodDefault<ZodString>;
     workspace_id: ZodDefault<ZodNullable<ZodString>>;
  }, $strip>>>;
  success: ZodDefault<ZodBoolean>;
}, $strip>;

Resposta para query da lista de execuções (usada pelo proxy do API Gateway).

Status da execução

ExecutionStatus: object;

Declaração de tipo

Nome
Tipo
Valor padrão

CANCELLED

"cancelled"

"cancelled"

COMPLETED

"completed"

"completed"

ERROR

"error"

"error"

PENDING

"pending"

"pending"

RESUMING

"resuming"

"resuming"

RUNNING

"running"

"running"

SUSPENDED

"suspended"

"suspended"

ExecutionStatusResponseSchema

const ExecutionStatusResponseSchema: ZodObject<{
  created_at: ZodCoercedDate<unknown>;
  error: ZodOptional<ZodString>;
  execution_id: ZodString;
  result: ZodOptional<ZodUnknown>;
  status: ZodEnum<{
     cancelled: "cancelled";
     completed: "completed";
     error: "error";
     pending: "pending";
     resuming: "resuming";
     running: "running";
     suspended: "suspended";
  }>;
  suspend_context: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  suspend_reason: ZodOptional<ZodString>;
  updated_at: ZodCoercedDate<unknown>;
}, $strip>;

Resposta para query de status de execução.

ExecutionStatusSchema

const ExecutionStatusSchema: ZodEnum<{
  cancelled: "cancelled";
  completed: "completed";
  error: "error";
  pending: "pending";
  resuming: "resuming";
  running: "running";
  suspended: "suspended";
}>;

Status da execução de um agente .

ExecutionStepSchema

const ExecutionStepSchema: ZodObject<{
  arguments: ZodRecord<ZodString, ZodUnknown>;
  duration_ms: ZodOptional<ZodNumber>;
  error: ZodOptional<ZodString>;
  execution_id: ZodString;
  id: ZodString;
  result: ZodOptional<ZodUnknown>;
  status: ZodString;
  step_number: ZodNumber;
  timestamp: ZodDefault<ZodCoercedDate<unknown>>;
  tool_name: ZodString;
}, $strip>;

Registro da etapa de execução armazenado no TenantDB.

ExecutorCallbackRequestSchema

const ExecutorCallbackRequestSchema: ZodObject<{
  error: ZodOptional<ZodString>;
  execution_id: ZodString;
  interrupts: ZodOptional<ZodArray<ZodObject<{
     id: ZodString;
     value: ZodUnknown;
  }, $strip>>>;
  metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  result: ZodOptional<ZodUnknown>;
  resume_schema: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  status: ZodString;
  suspend_context: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  suspend_generation: ZodOptional<ZodPipe<ZodNullable<ZodNumber>, ZodTransform<number | undefined, number | null>>>;
  suspend_reason: ZodOptional<ZodString>;
}, $strip>;

Chamada de resposta de AER para OE quando a execução é concluída ou suspensa.

EXIT_IMPORT_ERROR

const EXIT_IMPORT_ERROR: 82 = 82;

Códigos de saída de falha de inicialização. A espera de prontidão do OE pode observar o código de saída real de uma carga de trabalho quando ela sai (por meio do Wait RPC do fctr), mas não a exceção que a causou, de modo que o código de saída em si é o único sinal que sobrevive de forma confiável a uma falha de inicialização para alcançar o OE. Escolhido para evitar cada intervalo que o próprio const.go do fctr já afirma: 0/1 (genérico), 64-78 (sysexits.h) e 128+signal (mortes de sinal, por exemplo, 137=SIGKILL, 143=SIGTERM).

Contrato de fio congelado: a classificação da OE de uma falha de inicialização depende desses valores exatos, e eles são duplicados em Runner-shared/src/agent_engine_current_shared/launcher.py. A alteração de um dos arquivos interrompe a capacidade do OE de distinguir causas de falha e/ou paridade entre linguagens — mantenha os dois em sincronia.

EXIT_NO_ENTRYPOINT

const EXIT_NO_ENTRYPOINT: 83 = 83;

EXIT_STARTUP_CRASH

const EXIT_STARTUP_CRASH: 84 = 84;

file_workflow_v1_atividade

const file_workflow_v1_activity: GenFile;

Descreve o arquivo fluxo de trabalho/v1/atividade.proto.

file_workflow_v1_common

const file_workflow_v1_common: GenFile;

Descreve o arquivo fluxo de trabalho/v1/common.proto.

file_workflow_v1_runtime

const file_workflow_v1_runtime: GenFile;

Descreve o arquivo fluxo de trabalho/v1/runtime.proto.

file_workflow_v1_state

const file_workflow_v1_state: GenFile;

Descreve o arquivo fluxo de trabalho/v1/state.proto.

FinalizeStepCommandSchema

const FinalizeStepCommandSchema: GenMessage<FinalizeStepCommand>;

Descreve a mensagem mongodb.agentic.workflow.v1.FinalizeStepCommand. Use create(FinalizeStepCommandSchema) para criar uma nova mensagem.

FinalizeStepResponseSchema

const FinalizeStepResponseSchema: GenMessage<FinalizeStepResponse>;

Descreve a mensagem mongodb.agentic.workflow.v1.FinalizeStepResponse. Use create(FinalizeStepResponseSchema) para criar uma nova mensagem.

Graph_build

const GRAPH_BUILD: "graph.build" = "graph.build";

GuardrailCheckContextSchema

const GuardrailCheckContextSchema: ZodObject<{
  org_id: ZodString;
  project_id: ZodString;
  session_id: ZodOptional<ZodNullable<ZodString>>;
  user_id: ZodOptional<ZodNullable<ZodString>>;
  workspace_id: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;

Contexto de execução de uma verificação de proteção.

GuardrailCheckDecision

GuardrailCheckDecision: object;

Declaração de tipo

Nome
Tipo
Valor padrão

ALLOW

"allow"

"allow"

BLOCK

"block"

"block"

LOG_ONLY

"log_only"

"log_only"

MODIFY

"modify"

"modify"

REQUIRE_REVIEW

"require_review"

"require_review"

GuardrailCheckDecisionSchema

const GuardrailCheckDecisionSchema: ZodEnum<{
  allow: "allow";
  block: "block";
  log_only: "log_only";
  modify: "modify";
  require_review: "require_review";
}>;

Decisão retornada pelo avaliador de proteção do Pod da Ferramenta.

GuardrailCheckEvidenceSchema

const GuardrailCheckEvidenceSchema: ZodObject<{
  message: ZodDefault<ZodString>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  policy_id: ZodString;
}, $strip>;

Edições explicando por que uma política de proteção foi acionada.

GuardrailCheckInputSchema

const GuardrailCheckInputSchema: ZodObject<{
  metadata: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  text: ZodString;
}, $strip>;

Conteúdo e metadados de tempo de execução para avaliar.

GuardrailCheckRequestSchema

const GuardrailCheckRequestSchema: ZodObject<{
  context: ZodObject<{
     org_id: ZodString;
     project_id: ZodString;
     session_id: ZodOptional<ZodNullable<ZodString>>;
     user_id: ZodOptional<ZodNullable<ZodString>>;
     workspace_id: ZodOptional<ZodNullable<ZodString>>;
  }, $strip>;
  execution_id: ZodString;
  input: ZodObject<{
     metadata: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
     text: ZodString;
  }, $strip>;
  policies: ZodDefault<ZodArray<ZodObject<{
     action: ZodString;
     config: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
     id: ZodString;
     stage_filter: ZodDefault<ZodArray<ZodString>>;
     status: ZodDefault<ZodString>;
     type: ZodString;
  }, $strip>>>;
  stage: ZodEnum<{
     llm_input: "llm_input";
     llm_output: "llm_output";
     tool_input: "tool_input";
     tool_output: "tool_output";
  }>;
}, $strip>;

Solicitação do OE ao Pod da Ferramenta para avaliar as políticas de proteção selecionadas.

GuardrailCheckResponseSchema

const GuardrailCheckResponseSchema: ZodObject<{
  allowed: ZodBoolean;
  decision: ZodEnum<{
     allow: "allow";
     block: "block";
     log_only: "log_only";
     modify: "modify";
     require_review: "require_review";
  }>;
  evidence: ZodDefault<ZodArray<ZodObject<{
     message: ZodDefault<ZodString>;
     metadata: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
     policy_id: ZodString;
  }, $strip>>>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  reason: ZodOptional<ZodNullable<ZodString>>;
  transformed_text: ZodOptional<ZodNullable<ZodString>>;
  triggered_policy_ids: ZodDefault<ZodArray<ZodString>>;
}, $strip>;

Decisão retornada pelo avaliador de proteção do Pod da Ferramenta.

GuardrailMetaSchema

const GuardrailMetaSchema: ZodObject<{
  guardrail_category: ZodString;
  guardrail_id: ZodString;
}, $strip>;

Identidade da política que causou um bloqueio de proteção ou uma interrupção do require_review.

GuardrailRuntimePolicySchema

const GuardrailRuntimePolicySchema: ZodObject<{
  action: ZodString;
  config: ZodDefault<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  id: ZodString;
  stage_filter: ZodDefault<ZodArray<ZodString>>;
  status: ZodDefault<ZodString>;
  type: ZodString;
}, $strip>;

Política de proteção selecionada pela OE enviada ao Pod da Ferramenta para avaliação.

GuardrailRuntimeStage

GuardrailRuntimeStage: object;

Declaração de tipo

Nome
Tipo
Valor padrão

LLM_INPUT

"llm_input"

"llm_input"

LLM_OUTPUT

"llm_output"

"llm_output"

TOOL_INPUT

"tool_input"

"tool_input"

TOOL_OUTPUT

"tool_output"

"tool_output"

GuardrailRuntimeStageSchema

const GuardrailRuntimeStageSchema: ZodEnum<{
  llm_input: "llm_input";
  llm_output: "llm_output";
  tool_input: "tool_input";
  tool_output: "tool_output";
}>;

Estágio de tempo de execução em que a OE está solicitando ao pod da ferramenta que avalie as grades de proteção.

HealthResponseSchema

const HealthResponseSchema: ZodObject<{
  component: ZodString;
  details: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  mode: ZodString;
  status: ZodEnum<{
     degraded: "degraded";
     healthy: "healthy";
     unhealthy: "unhealthy";
  }>;
  version: ZodDefault<ZodString>;
}, $strip>;

Resposta da verificação de integridade.

HealthStatus

HealthStatus: object;

Declaração de tipo

Nome
Tipo
Valor padrão

DEGRADED

"degraded"

"degraded"

HEALTHY

"healthy"

"healthy"

UNHEALTHY

"unhealthy"

"unhealthy"

HealthStatusSchema

const HealthStatusSchema: ZodEnum<{
  degraded: "degraded";
  healthy: "healthy";
  unhealthy: "unhealthy";
}>;

Status de saúde de um componente.

HumanReviewDataSchema

const HumanReviewDataSchema: ZodObject<{
  decision: ZodString;
  reviewer_notes: ZodOptional<ZodString>;
}, $strip>;

Dados fornecidos pelo revisor humano ao retomar uma execução suspensa.

InterruptResultSchema

const InterruptResultSchema: ZodObject<{
  interrupts: ZodOptional<ZodArray<ZodObject<{
     id: ZodString;
     value: ZodUnknown;
  }, $strip>>>;
  messages: ZodDefault<ZodArray<ZodPipe<ZodObject<{
     additional_kwargs: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>>;
     content: ZodUnion<readonly [ZodString, ZodArray<ZodDiscriminatedUnion<..., ...>>]>;
     id: ZodOptional<ZodString>;
     is_error: ZodOptional<ZodBoolean>;
     name: ZodOptional<ZodString>;
     response_metadata: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>>;
     role: ZodEnum<{
        assistant: "assistant";
        system: "system";
        tool: "tool";
        user: "user";
     }>;
     tool_call_id: ZodOptional<ZodString>;
     tool_calls: ZodOptional<ZodArray<ZodPipe<ZodObject<..., ...>, ZodTransform<..., ...>>>>;
   }, $loose>, ZodTransform<Message, {
   [x: string]: unknown;
     additional_kwargs?: Record<string, JsonValue>;
     content:   | string
        | (
        | {
        text: ...;
        type: ...;
      }
        | {
        mime_type?: ...;
        type: ...;
        url: ...;
      }
        | {
        filename?: ...;
        mime_type?: ...;
        type: ...;
        url: ...;
      })[];
     id?: string;
     is_error?: boolean;
     name?: string;
     response_metadata?: Record<string, JsonValue>;
     role: "user" | "assistant" | "tool" | "system";
     tool_call_id?: string;
     tool_calls?: LLMToolCall[];
  }>>>>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  resume_schema: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  suspend_payload: ZodUnknown;
}, $strip>;

InvokeLLMRequestArgumentsSchema

const InvokeLLMRequestArgumentsSchema: ZodPreprocess<ZodObject<{
  llm_id: ZodDefault<ZodString>;
  messages: ZodArray<ZodPipe<ZodObject<{
     additional_kwargs: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>>;
     content: ZodUnion<readonly [ZodString, ZodArray<ZodDiscriminatedUnion<..., ...>>]>;
     id: ZodOptional<ZodString>;
     is_error: ZodOptional<ZodBoolean>;
     name: ZodOptional<ZodString>;
     response_metadata: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>>;
     role: ZodEnum<{
        assistant: "assistant";
        system: "system";
        tool: "tool";
        user: "user";
     }>;
     tool_call_id: ZodOptional<ZodString>;
     tool_calls: ZodOptional<ZodArray<ZodPipe<ZodObject<..., ...>, ZodTransform<..., ...>>>>;
   }, $loose>, ZodTransform<Message, {
   [x: string]: unknown;
     additional_kwargs?: Record<string, JsonValue>;
     content:   | string
        | (
        | {
        text: ...;
        type: ...;
      }
        | {
        mime_type?: ...;
        type: ...;
        url: ...;
      }
        | {
        filename?: ...;
        mime_type?: ...;
        type: ...;
        url: ...;
      })[];
     id?: string;
     is_error?: boolean;
     name?: string;
     response_metadata?: Record<string, JsonValue>;
     role: "user" | "assistant" | "tool" | "system";
     tool_call_id?: string;
     tool_calls?: LLMToolCall[];
  }>>>;
  model: ZodString;
  options: ZodOptional<ZodPreprocess<ZodPipe<ZodObject<{
     frequency_penalty: ZodOptional<ZodNumber>;
     max_tokens: ZodOptional<ZodNumber>;
     parallel_tool_calls: ZodOptional<ZodBoolean>;
     presence_penalty: ZodOptional<ZodNumber>;
     reasoning_effort: ZodOptional<ZodString>;
     response_format: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>;
     seed: ZodOptional<ZodNumber>;
     timeout: ZodOptional<ZodNumber>;
     top_k: ZodOptional<ZodNumber>;
     top_p: ZodOptional<ZodNumber>;
   }, $loose>, ZodTransform<LLMInvocationOptions, {
   [x: string]: unknown;
     frequency_penalty?: number;
     max_tokens?: number;
     parallel_tool_calls?: boolean;
     presence_penalty?: number;
     reasoning_effort?: string;
     response_format?: JsonValue;
     seed?: number;
     timeout?: number;
     top_k?: number;
     top_p?: number;
  }>>>>;
  stop_sequences: ZodOptional<ZodArray<ZodString>>;
  stream: ZodDefault<ZodBoolean>;
  tool_choice: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>;
  tools: ZodOptional<ZodArray<ZodPipe<ZodObject<{
     description: ZodOptional<ZodString>;
     function: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>;
     name: ZodOptional<ZodString>;
     parameters: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>;
     strict: ZodOptional<ZodBoolean>;
     type: ZodOptional<ZodString>;
   }, $strip>, ZodTransform<LLMToolSchema, {
     description?: string;
     function?: JsonValue;
     name?: string;
     parameters?: JsonValue;
     strict?: boolean;
     type?: string;
  }>>>>;
}, $strip>>;

Argumentos invoke_llm digitados encaminhados por meio de OE e pods de ferramentas.

O Python usa pseudônimos Pydentic: - alias de validação stop ↔ stop_sequences, alias de serialização stop - o pré-validador renomeia kwargs → options

No zod, replicamos isso com um z.preprocess que normaliza as cargas úteis recebidas no esquema canônico (usando stop_sequences e options). Para serialização de saída que precisa do alias de fio stop, use serializeInvokeLLMRequestArguments().

InvokeRequestSchema

const InvokeRequestSchema: ZodObject<{
  aer_url: ZodOptional<ZodString>;
  custom_headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
  message: ZodString;
  org_id: ZodOptional<ZodString>;
  project_id: ZodOptional<ZodString>;
  session_id: ZodOptional<ZodString>;
  tool_url: ZodOptional<ZodString>;
  user_id: ZodOptional<ZodString>;
  wait: ZodDefault<ZodBoolean>;
  workspace_id: ZodOptional<ZodString>;
}, $strip>;

Solicitação para invocar o agente (compatível com o tempo de execução do agente).

InvokeResponseSchema

const InvokeResponseSchema: ZodObject<{
  error: ZodOptional<ZodString>;
  execution_id: ZodOptional<ZodString>;
  result: ZodOptional<ZodUnknown>;
  session_id: ZodOptional<ZodString>;
  status: ZodOptional<ZodString>;
  user_id: ZodOptional<ZodString>;
}, $strip>;

Resposta ao invocar o agente (compatível com o tempo de execução do agente).

LLM_BACKOFF_MULTIPLIER

const LLM_BACKOFF_MULTIPLIER: number;

LLM_INITIAL_BACKOFF

const LLM_INITIAL_BACKOFF: number;

LLM_MAX_BACKOFF

const LLM_MAX_BACKOFF: number;

LLM_MAX_RETRIES

const LLM_MAX_RETRIES: number;

LLM_READ_TIMEOUT

const LLM_READ_TIMEOUT: number;

LLMPodInvokeRequestSchema

const LLMPodInvokeRequestSchema: ZodPreprocess<ZodObject<{
  arguments: ZodPreprocess<ZodObject<{
     llm_id: ZodDefault<ZodString>;
     messages: ZodArray<ZodPipe<ZodObject<{
        additional_kwargs: ZodOptional<...>;
        content: ZodUnion<...>;
        id: ZodOptional<...>;
        is_error: ZodOptional<...>;
        name: ZodOptional<...>;
        response_metadata: ZodOptional<...>;
        role: ZodEnum<...>;
        tool_call_id: ZodOptional<...>;
        tool_calls: ZodOptional<...>;
      }, $loose>, ZodTransform<Message, {
      [x: string]: unknown;
        additional_kwargs?: ... | ...;
        content: ... | ...;
        id?: ... | ...;
        is_error?: ... | ... | ...;
        name?: ... | ...;
        response_metadata?: ... | ...;
        role: ... | ... | ... | ...;
        tool_call_id?: ... | ...;
        tool_calls?: ... | ...;
     }>>>;
     model: ZodString;
     options: ZodOptional<ZodPreprocess<ZodPipe<ZodObject<{
        frequency_penalty: ...;
        max_tokens: ...;
        parallel_tool_calls: ...;
        presence_penalty: ...;
        reasoning_effort: ...;
        response_format: ...;
        seed: ...;
        timeout: ...;
        top_k: ...;
        top_p: ...;
      }, $loose>, ZodTransform<LLMInvocationOptions, {
      [x: ...]: ...;
        frequency_penalty?: ...;
        max_tokens?: ...;
        parallel_tool_calls?: ...;
        presence_penalty?: ...;
        reasoning_effort?: ...;
        response_format?: ...;
        seed?: ...;
        timeout?: ...;
        top_k?: ...;
        top_p?: ...;
     }>>>>;
     stop_sequences: ZodOptional<ZodArray<ZodString>>;
     stream: ZodDefault<ZodBoolean>;
     tool_choice: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>;
     tools: ZodOptional<ZodArray<ZodPipe<ZodObject<{
        description: ...;
        function: ...;
        name: ...;
        parameters: ...;
        strict: ...;
        type: ...;
      }, $strip>, ZodTransform<LLMToolSchema, {
        description?: ...;
        function?: ...;
        name?: ...;
        parameters?: ...;
        strict?: ...;
        type?: ...;
     }>>>>;
  }, $strip>>;
  execution_id: ZodString;
  platform_trace_id: ZodOptional<ZodNullable<ZodString>>;
  step_number: ZodOptional<ZodNumber>;
}, $strip>>;

Solicite para invocar o LLM em um pod de executor de ferramenta.

Pré-validador de Python _normalize_flat_payload: se arguments estiver ausente, mas execution_id estiver presente, trate as chaves restantes como a carga útil dos argumentos. Mesma lógica replicada via z.preprocess.

LLMPodInvokeResponseSchema

const LLMPodInvokeResponseSchema: ZodObject<{
  duration_ms: ZodNumber;
  error: ZodOptional<ZodString>;
  error_code: ZodOptional<ZodString>;
  pod_name: ZodString;
  result: ZodOptional<ZodObject<{
     additional_kwargs: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     content: ZodString;
     id: ZodOptional<ZodString>;
     metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     name: ZodOptional<ZodString>;
     response_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     tool_calls: ZodOptional<ZodArray<ZodUnknown>>;
     usage: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  }, $loose>>;
  status: ZodString;
  usage: ZodOptional<ZodPreprocess<ZodPipe<ZodObject<{
     completion_tokens: ZodOptional<ZodNumber>;
     input_tokens: ZodOptional<ZodNumber>;
     model: ZodOptional<ZodString>;
     output_tokens: ZodOptional<ZodNumber>;
     prompt_tokens: ZodOptional<ZodNumber>;
     total_tokens: ZodOptional<ZodNumber>;
   }, $strip>, ZodTransform<LLMTokenUsage, {
     completion_tokens?: number;
     input_tokens?: number;
     model?: string;
     output_tokens?: number;
     prompt_tokens?: number;
     total_tokens?: number;
  }>>>>;
}, $strip>;

Resposta da invocação LLM em um pod de executor de ferramenta.

Python _sync_usage_with_result é um model_validator que muta result.usage ↔ usage. O TS LLMResponse.usage é somente leitura, então a mutação não é possível; os chamadores devem usar normalizeLLMPodInvokeResponse() após a análise para sincronizar os dois campos construindo um novo LLMResponse quando necessário.

LLMPodStreamEventSchema

const LLMPodStreamEventSchema: ZodObject<{
  additional_kwargs: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  content: ZodOptional<ZodString>;
  done: ZodOptional<ZodBoolean>;
  duration_ms: ZodOptional<ZodNumber>;
  error: ZodOptional<ZodString>;
  error_code: ZodOptional<ZodString>;
  id: ZodOptional<ZodString>;
  interrupted: ZodOptional<ZodBoolean>;
  name: ZodOptional<ZodString>;
  pod_name: ZodOptional<ZodString>;
  response_metadata: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  retry_after_ms: ZodOptional<ZodNumber>;
  retryable: ZodOptional<ZodBoolean>;
  tool_call_chunks: ZodOptional<ZodArray<ZodObject<{
     args: ZodOptional<ZodString>;
     id: ZodOptional<ZodString>;
     index: ZodOptional<ZodNumber>;
     name: ZodOptional<ZodString>;
     type: ZodOptional<ZodString>;
  }, $strip>>>;
  tool_calls: ZodOptional<ZodArray<ZodRecord<ZodString, ZodUnknown>>>;
  usage: ZodOptional<ZodPreprocess<ZodPipe<ZodObject<{
     completion_tokens: ZodOptional<ZodNumber>;
     input_tokens: ZodOptional<ZodNumber>;
     model: ZodOptional<ZodString>;
     output_tokens: ZodOptional<ZodNumber>;
     prompt_tokens: ZodOptional<ZodNumber>;
     total_tokens: ZodOptional<ZodNumber>;
   }, $strip>, ZodTransform<LLMTokenUsage, {
     completion_tokens?: number;
     input_tokens?: number;
     model?: string;
     output_tokens?: number;
     prompt_tokens?: number;
     total_tokens?: number;
  }>>>>;
}, $strip>;

evento SSE emitido por um pod de ferramenta durante a transmissão invoke_llm.

LLMResultSchema

const LLMResultSchema: ZodObject<{
  additional_kwargs: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  content: ZodDefault<ZodString>;
  id: ZodOptional<ZodString>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  name: ZodOptional<ZodString>;
  response_metadata: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>>;
  tool_calls: ZodDefault<ZodArray<ZodUnknown>>;
  usage: ZodOptional<ZodPreprocess<ZodPipe<ZodObject<{
     completion_tokens: ZodOptional<ZodNumber>;
     input_tokens: ZodOptional<ZodNumber>;
     model: ZodOptional<ZodString>;
     output_tokens: ZodOptional<ZodNumber>;
     prompt_tokens: ZodOptional<ZodNumber>;
     total_tokens: ZodOptional<ZodNumber>;
   }, $strip>, ZodTransform<LLMTokenUsage, {
     completion_tokens?: number;
     input_tokens?: number;
     model?: string;
     output_tokens?: number;
     prompt_tokens?: number;
     total_tokens?: number;
  }>>>>;
}, $loose>;

Esquema de validação de tempo de execução para dados de fio LLMResult. content é o único campo obrigatório.

MAX_TOOL_ARGUMENT_BYTES

const MAX_TOOL_ARGUMENT_BYTES: number;

MemoryWriteSchema

const MemoryWriteSchema: GenMessage<MemoryWrite>;

Descreve a mensagem mongodb.agentic.workflow.v1.MemoryWrite. Use create(MemoryWriteSchema) para criar uma nova mensagem.

MessageRoleSchema

const MessageRoleSchema: GenEnum<MessageRole>;

Descreve o enumeração mongodb.agentic.workflow.v1.MessageRole.

MODEL_REQUEST_PREPARE

const MODEL_REQUEST_PREPARE: "request.prepare" = "request.prepare";

Model_RESPONSE_PROCESS

const MODEL_RESPONSE_PROCESS: "response.process" = "response.process";

NodeExecutionRequestSchema

const NodeExecutionRequestSchema: ZodObject<{
  duration_ms: ZodOptional<ZodNumber>;
  error: ZodOptional<ZodString>;
  execution_id: ZodString;
  inputs: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  node_name: ZodString;
  org_id: ZodOptional<ZodString>;
  outputs: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  parent_run_id: ZodOptional<ZodString>;
  project_id: ZodOptional<ZodString>;
  run_id: ZodString;
  session_id: ZodOptional<ZodString>;
  span_id: ZodOptional<ZodNullable<ZodString>>;
  status: ZodString;
  timestamp: ZodCoercedDate<unknown>;
  trace_id: ZodOptional<ZodNullable<ZodString>>;
  user_id: ZodOptional<ZodString>;
}, $strip>;

evento de execução do nó de relatório (AER → OE para registro).

NodeExecutionsQueryResponseSchema

const NodeExecutionsQueryResponseSchema: ZodObject<{
  count: ZodDefault<ZodNumber>;
  executions: ZodDefault<ZodArray<ZodRecord<ZodString, ZodUnknown>>>;
}, $strip>;

Resposta para query de execuções de nó (usada pelo proxy do API Gateway).

OE_DISPATCH_RETRY_MAX_WAIT_MS

const OE_DISPATCH_RETRY_MAX_WAIT_MS: 60000 = 60_000;

OE_DISPATCH_TAKEOVER_RETRY_DLAY_MS

const OE_DISPATCH_TAKEOVER_RETRY_DELAY_MS: 30000 = 30_000;

Aguarde após uma queda de conexão SSE para que a próxima tentativa possa ser feita após despachante_coração TTL (30s). Não reutilize o limite de 10s do HTTP Retry-After. Lockstep com Python.

OE_RETRYABLE_MAX_ATTEMPTS

const OE_RETRYABLE_MAX_ATTEMPTS: 3 = 3;

Novas tentativas na mesma etapa de /tool/execute (e do relé SSE) depois que o OE anuncia retryable=true e depois de uma desconexão do transporte SSE. 1 inicial + 2 extras; lockstep com Python.

oeStreamRetry

const oeStreamRetry: object;

Suspenda antes de uma nova tentativa de URL do mesmo SSE. Os testesespionam isso para evitar esperas de relógio de parede.

Declaração de tipo

Nome
Tipo

sleep()

(delayMs) => Promise <void>

OPENINFERence_Span_Kind

const OPENINFERENCE_SPAN_KIND: "openinference.span.kind" = openinferenceSpanKindAttr;

OpenInferenceSpanKind

const OpenInferenceSpanKind: object;

Tipos de extensão OpenInference, correspondendo ao OpenInferenceSpanKind do Python SDK.

Declaração de tipo

Nome
Tipo
Valor padrão

AGENT

"AGENT"

"AGENT"

CHAIN

"CHAIN"

"CHAIN"

TOOL

"TOOL"

"TOOL"

OperationPathSchema

const OperationPathSchema: GenMessage<OperationPath>;

Descreve a mensagem mongodb.agentic.workflow.v1.OperationPath. Use create(OperationPathSchema) para criar uma nova mensagem.

OperationPathSegmentSchema

const OperationPathSegmentSchema: GenMessage<OperationPathSegment>;

Descreve a mensagem mongodb.agentic.workflow.v1.OperationPathSegment. Use create(OperationPathSegmentSchema) para criar uma nova mensagem.

PendingInterruptSchema

const PendingInterruptSchema: ZodObject<{
  id: ZodString;
  value: ZodUnknown;
}, $strip>;

Resultam da execução do agente quando o agente é suspenso.

Contém a carga útil suspensa diretamente (independentemente de estrutura) em vez de envolver objetos Interrupt específicos da estrutura. Qualquer estado específico da estrutura necessário para ser retomado (id do checkpoint do LangGraph, correlação da chamada de função do ADK etc.) é executado de forma opaca em metadata — o AER nunca o inspeciona; o adaptador de framework grava na suspensão e lê de volta de RequestContext.metadata na retomada.

RuntimeMCPAuthConfigSchema

const RuntimeMCPAuthConfigSchema: ZodObject<{
  client_id_env: ZodDefault<ZodNullable<ZodString>>;
  client_name: ZodDefault<ZodNullable<ZodString>>;
  client_secret_env: ZodDefault<ZodNullable<ZodString>>;
  redirect_uri: ZodDefault<ZodNullable<ZodString>>;
  scope: ZodDefault<ZodNullable<ZodString>>;
  token_env: ZodDefault<ZodNullable<ZodString>>;
  token_url: ZodDefault<ZodNullable<ZodString>>;
  type: ZodDefault<ZodEnum<{
     bearer_env: "bearer_env";
     client_credentials: "client_credentials";
     none: "none";
     oauth: "oauth";
  }>>;
}, $strip>;

RuntimeMCPConfigSchema

const RuntimeMCPConfigSchema: ZodObject<{
  servers: ZodDefault<ZodRecord<ZodString, ZodObject<{
     allowed_tools: ZodDefault<ZodNullable<ZodArray<ZodString>>>;
     auth: ZodDefault<ZodObject<{
        client_id_env: ZodDefault<ZodNullable<...>>;
        client_name: ZodDefault<ZodNullable<...>>;
        client_secret_env: ZodDefault<ZodNullable<...>>;
        redirect_uri: ZodDefault<ZodNullable<...>>;
        scope: ZodDefault<ZodNullable<...>>;
        token_env: ZodDefault<ZodNullable<...>>;
        token_url: ZodDefault<ZodNullable<...>>;
        type: ZodDefault<ZodEnum<...>>;
     }, $strip>>;
     headers: ZodDefault<ZodRecord<ZodString, ZodString>>;
     timeout_seconds: ZodDefault<ZodNumber>;
     transport: ZodDefault<ZodLiteral<"streamable_http">>;
     url: ZodString;
  }, $strip>>>;
}, $strip>;

RuntimeMCPServerConfigSchema

const RuntimeMCPServerConfigSchema: ZodObject<{
  allowed_tools: ZodDefault<ZodNullable<ZodArray<ZodString>>>;
  auth: ZodDefault<ZodObject<{
     client_id_env: ZodDefault<ZodNullable<ZodString>>;
     client_name: ZodDefault<ZodNullable<ZodString>>;
     client_secret_env: ZodDefault<ZodNullable<ZodString>>;
     redirect_uri: ZodDefault<ZodNullable<ZodString>>;
     scope: ZodDefault<ZodNullable<ZodString>>;
     token_env: ZodDefault<ZodNullable<ZodString>>;
     token_url: ZodDefault<ZodNullable<ZodString>>;
     type: ZodDefault<ZodEnum<{
        bearer_env: "bearer_env";
        client_credentials: "client_credentials";
        none: "none";
        oauth: "oauth";
     }>>;
  }, $strip>>;
  headers: ZodDefault<ZodRecord<ZodString, ZodString>>;
  timeout_seconds: ZodDefault<ZodNumber>;
  transport: ZodDefault<ZodLiteral<"streamable_http">>;
  url: ZodString;
}, $strip>;

SecretsConfigSchema

const SecretsConfigSchema: ZodObject<{
  aer: ZodDefault<ZodArray<ZodString>>;
  disable_restriction: ZodDefault<ZodBoolean>;
  tools: ZodDefault<ZodRecord<ZodString, ZodArray<ZodString>>>;
}, $strip>;

SessionInfoSchema

const SessionInfoSchema: ZodObject<{
  created_at: ZodString;
  last_activity: ZodString;
  last_message_preview: ZodDefault<ZodString>;
  message_count: ZodDefault<ZodNumber>;
  project_id: ZodDefault<ZodString>;
  session_id: ZodString;
  user_id: ZodDefault<ZodString>;
  visibility: ZodDefault<ZodString>;
  workspace_id: ZodDefault<ZodString>;
}, $strip>;

Uma única entrada de sessão retornada por /query/sessions.

SessionMessageSchema

const SessionMessageSchema: ZodObject<{
  content: ZodString;
  id: ZodString;
  name: ZodOptional<ZodString>;
  role: ZodString;
  session_id: ZodString;
  timestamp: ZodString;
  tool_call_id: ZodOptional<ZodNullable<ZodString>>;
  tool_calls: ZodOptional<ZodNullable<ZodArray<ZodPipe<ZodObject<{
     args: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>;
     arguments: ZodOptional<ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>;
     id: ZodOptional<ZodString>;
     index: ZodOptional<ZodNumber>;
     name: ZodOptional<ZodString>;
     type: ZodOptional<ZodString>;
   }, $strip>, ZodTransform<LLMToolCall, {
     args?: JsonValue;
     arguments?: JsonValue;
     id?: string;
     index?: number;
     name?: string;
     type?: string;
  }>>>>>;
}, $strip>;

Uma única mensagem em uma sessão.

SessionMessagesQueryResponseSchema

const SessionMessagesQueryResponseSchema: ZodObject<{
  messages: ZodDefault<ZodArray<ZodObject<{
     content: ZodString;
     id: ZodString;
     name: ZodOptional<ZodString>;
     role: ZodString;
     session_id: ZodString;
     timestamp: ZodString;
     tool_call_id: ZodOptional<ZodNullable<ZodString>>;
     tool_calls: ZodOptional<ZodNullable<ZodArray<ZodPipe<ZodObject<..., ...>, ZodTransform<..., ...>>>>>;
  }, $strip>>>;
}, $strip>;

Resposta para query de mensagens de sessão (usada pelo proxy do API Gateway).

SessionsQueryResponseSchema

const SessionsQueryResponseSchema: ZodObject<{
  limit: ZodDefault<ZodNumber>;
  offset: ZodDefault<ZodNumber>;
  sessions: ZodDefault<ZodArray<ZodObject<{
     created_at: ZodString;
     last_activity: ZodString;
     last_message_preview: ZodDefault<ZodString>;
     message_count: ZodDefault<ZodNumber>;
     project_id: ZodDefault<ZodString>;
     session_id: ZodString;
     user_id: ZodDefault<ZodString>;
     visibility: ZodDefault<ZodString>;
     workspace_id: ZodDefault<ZodString>;
  }, $strip>>>;
  total_count: ZodDefault<ZodNumber>;
}, $strip>;

Resposta para query de lista de sessões (usada pelo proxy do API Gateway).

SKILLS_MIDDLEWORE_BEFORE_AGENT

const SKILLS_MIDDLEWARE_BEFORE_AGENT: "skills.middleware" = "skills.middleware";

StateSnapshotSchema

const StateSnapshotSchema: GenMessage<StateSnapshot>;

Descreve a mensagem mongodb.agentic.workflow.v1.StateSnapshot. Use create(StateSnapshotSchema) para criar uma nova mensagem.

StepActivityEntrySchema

const StepActivityEntrySchema: GenMessage<StepActivityEntry>;

Descreve a mensagem mongodb.agentic.workflow.v1.StepActivityEntry. Use create(StepActivityEntrySchema) para criar uma nova mensagem.

StepSuspensionEntrySchema

const StepSuspensionEntrySchema: GenMessage<StepSuspensionEntry>;

Descreve a mensagem mongodb.agentic.workflow.v1.StepSuspensionEntry. Use create(StepSuspensionEntrySchema) para criar uma nova mensagem.

StreamChunkSchema

const StreamChunkSchema: ZodObject<{
  chunk_type: ZodString;
  code: ZodOptional<ZodString>;
  content: ZodDefault<ZodString>;
  error: ZodOptional<ZodString>;
  execution_id: ZodOptional<ZodString>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodString>>;
  step_number: ZodOptional<ZodNumber>;
  tool_call_id: ZodOptional<ZodString>;
  tool_name: ZodOptional<ZodString>;
}, $strip>;

Um bloco da resposta de streaming do agente.

Usado para transmissão em tempo real de respostas do agente via SSE ou gRPC.

StreamingResultSchema

const StreamingResultSchema: ZodObject<{
  content: ZodDefault<ZodString>;
  messages: ZodDefault<ZodArray<ZodPipe<ZodObject<{
     additional_kwargs: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>>;
     content: ZodUnion<readonly [ZodString, ZodArray<ZodDiscriminatedUnion<..., ...>>]>;
     id: ZodOptional<ZodString>;
     is_error: ZodOptional<ZodBoolean>;
     name: ZodOptional<ZodString>;
     response_metadata: ZodOptional<ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<..., ...>>>>;
     role: ZodEnum<{
        assistant: "assistant";
        system: "system";
        tool: "tool";
        user: "user";
     }>;
     tool_call_id: ZodOptional<ZodString>;
     tool_calls: ZodOptional<ZodArray<ZodPipe<ZodObject<..., ...>, ZodTransform<..., ...>>>>;
   }, $loose>, ZodTransform<Message, {
   [x: string]: unknown;
     additional_kwargs?: Record<string, JsonValue>;
     content:   | string
        | (
        | {
        text: ...;
        type: ...;
      }
        | {
        mime_type?: ...;
        type: ...;
        url: ...;
      }
        | {
        filename?: ...;
        mime_type?: ...;
        type: ...;
        url: ...;
      })[];
     id?: string;
     is_error?: boolean;
     name?: string;
     response_metadata?: Record<string, JsonValue>;
     role: "user" | "assistant" | "tool" | "system";
     tool_call_id?: string;
     tool_calls?: LLMToolCall[];
  }>>>>;
  metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
}, $strip>;

Resultado da execução do agente para conclusão normal.

Retornado por _execute_via_agent_stream quando o agente termina sem suspender. O chamador usa conteúdo para a resposta final e mensagens para escrita de memória.

SuspenderPayloadSchema

const SuspendPayloadSchema: ZodObject<{
  suspend_context: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  suspend_reason: ZodString;
}, $strip>;

Carga útil retornada por uma ferramenta de agente para acionar a suspensão do ser humano no loop.

As ferramentas do agente sinalizam uma suspensão retornando uma string JSON contendo esses campos. O sinalizador __suspend__ é removido antes que a carga útil seja passada para o manipulador interrupt() do framework.

Exemplo de uso em uma ferramenta de agente :

import { suspendPayloadToJson } from '@mongodb-js/agent-engine-runner-shared'
return suspendPayloadToJson({
  suspend_reason: 'awaiting_human_review',
  suspend_context: { claim_id: 'C-123', task_id: 'T-456' },
})

TenantScopeSchema

const TenantScopeSchema: GenMessage<TenantScope>;

Descreve a mensagem mongodb.agentic.workflow.v1.TenantScope. Use create(TenantScopeSchema) para criar uma nova mensagem.

ToolAPIErrorSchema

const ToolAPIErrorSchema: ZodObject<{
  classification: ZodString;
  error_code: ZodOptional<ZodNullable<ZodString>>;
  http_status: ZodOptional<ZodNullable<ZodNumber>>;
  provider_type: ZodOptional<ZodNullable<ZodString>>;
  reason: ZodOptional<ZodNullable<ZodString>>;
  retryable: ZodBoolean;
}, $strip>;

ToolAuthorizationSchema

const ToolAuthorizationSchema: ZodObject<{
  expires_at: ZodOptional<ZodNullable<ZodNumber>>;
  token: ZodString;
}, $strip>;

Credenciais delegadas injetadas pelo OE para execução da ferramenta.

ToolDefinitionSchema

const ToolDefinitionSchema: ZodObject<{
  description: ZodDefault<ZodString>;
  is_local: ZodDefault<ZodBoolean>;
  name: ZodString;
  parameters: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  provider_type: ZodOptional<ZodNullable<ZodString>>;
  scopes: ZodDefault<ZodArray<ZodString>>;
}, $strip>;

Definição de uma ferramenta registrada.

ToolExecuteRequestSchema

const ToolExecuteRequestSchema: ZodObject<{
  arguments: ZodRecord<ZodString, ZodUnknown>;
  custom_headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
  execution_id: ZodString;
  is_local: ZodDefault<ZodBoolean>;
  kind: ZodOptional<ZodString>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  provider_type: ZodOptional<ZodNullable<ZodString>>;
  redact_fields: ZodDefault<ZodArray<ZodString>>;
  scopes: ZodDefault<ZodArray<ZodString>>;
  span_id: ZodOptional<ZodNullable<ZodString>>;
  step_number: ZodNumber;
  tool_call_id: ZodOptional<ZodString>;
  tool_name: ZodString;
  trace_id: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;

Solicitação para executar uma ferramenta (AER → OE para aprovação).

ToolExecuteResponseSchema

const ToolExecuteResponseSchema: ZodPreprocess<ZodObject<{
  cached_result: ZodOptional<ZodNullable<ZodUnknown>>;
  duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
  elicitation: ZodOptional<ZodNullable<ZodObject<{
     authorization_url: ZodString;
     created: ZodDefault<ZodBoolean>;
     elicitation_id: ZodString;
     message: ZodDefault<ZodString>;
  }, $strip>>>;
  error: ZodOptional<ZodNullable<ZodString>>;
  error_code: ZodOptional<ZodNullable<ZodString>>;
  from_cache: ZodDefault<ZodBoolean>;
  guardrail_meta: ZodOptional<ZodNullable<ZodObject<{
     guardrail_category: ZodString;
     guardrail_id: ZodString;
  }, $strip>>>;
  latest_step_number: ZodOptional<ZodNullable<ZodNumber>>;
  pod_name: ZodOptional<ZodNullable<ZodString>>;
  proceed: ZodBoolean;
  reason: ZodOptional<ZodNullable<ZodString>>;
  result: ZodOptional<ZodNullable<ZodUnknown>>;
  retryable: ZodDefault<ZodBoolean>;
  route_to: ZodOptional<ZodNullable<ZodString>>;
  status: ZodOptional<ZodNullable<ZodString>>;
  tool_api_error: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodString;
     error_code: ZodOptional<ZodNullable<ZodString>>;
     http_status: ZodOptional<ZodNullable<ZodNumber>>;
     provider_type: ZodOptional<ZodNullable<ZodString>>;
     reason: ZodOptional<ZodNullable<ZodString>>;
     retryable: ZodBoolean;
  }, $strip>>>;
}, $strip>>;

Reúna guardrail_meta a partir dos campos guardrail_id/guardrail_category planos que o formato de fio OE envia, para que os chamadores trabalhem com um único objeto estruturado . Espelha o validador de modelo _assemble_guardrail_meta do Python.

ToolFunctionRequestSchema

const ToolFunctionRequestSchema: ZodObject<{
  request: ZodObject<{
     arguments: ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>;
     authorization: ZodOptional<ZodObject<{
        expires_at: ZodOptional<ZodNullable<ZodNumber>>;
        token: ZodString;
     }, $strip>>;
     custom_headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
     execution_id: ZodString;
     metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
     oe_owner_url: ZodOptional<ZodNullable<ZodString>>;
     oe_url: ZodOptional<ZodString>;
     payload: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     platform_trace_id: ZodOptional<ZodNullable<ZodString>>;
     session_id: ZodString;
     step_number: ZodOptional<ZodNumber>;
     tool_call_id: ZodOptional<ZodString>;
     tool_name: ZodString;
     user_id: ZodOptional<ZodString>;
  }, $strip>;
  step: ZodNumber;
}, $strip>;

O envelope de invocação do modo de função entregue em /run/meta/request.

ToolPodExecuteRequestSchema

const ToolPodExecuteRequestSchema: ZodObject<{
  arguments: ZodRecord<ZodString, ZodType<JsonValue, unknown, $ZodTypeInternals<JsonValue, unknown>>>;
  authorization: ZodOptional<ZodObject<{
     expires_at: ZodOptional<ZodNullable<ZodNumber>>;
     token: ZodString;
  }, $strip>>;
  custom_headers: ZodOptional<ZodRecord<ZodString, ZodString>>;
  execution_id: ZodString;
  metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  oe_owner_url: ZodOptional<ZodNullable<ZodString>>;
  oe_url: ZodOptional<ZodString>;
  payload: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  platform_trace_id: ZodOptional<ZodNullable<ZodString>>;
  session_id: ZodString;
  step_number: ZodOptional<ZodNumber>;
  tool_call_id: ZodOptional<ZodString>;
  tool_name: ZodString;
  user_id: ZodOptional<ZodString>;
}, $strip>;

Solicite para executar uma ferramenta em um pod de ferramenta.

ToolPodExecuteResponseSchema

const ToolPodExecuteResponseSchema: ZodObject<{
  error: ZodOptional<ZodString>;
  kind: ZodOptional<ZodString>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  oob_suspend_supported: ZodOptional<ZodBoolean>;
  pod_name: ZodOptional<ZodString>;
  result: ZodOptional<ZodUnknown>;
  status: ZodString;
  tool_api_error: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodString;
     error_code: ZodOptional<ZodNullable<ZodString>>;
     http_status: ZodOptional<ZodNullable<ZodNumber>>;
     provider_type: ZodOptional<ZodNullable<ZodString>>;
     reason: ZodOptional<ZodNullable<ZodString>>;
     retryable: ZodBoolean;
  }, $strip>>>;
}, $strip>;

Resposta da execução do pod da ferramenta.

ToolResultRequestSchema

const ToolResultRequestSchema: ZodObject<{
  completion_tokens: ZodOptional<ZodNumber>;
  duration_ms: ZodNumber;
  error: ZodOptional<ZodString>;
  execution_id: ZodString;
  kind: ZodOptional<ZodString>;
  metadata: ZodDefault<ZodRecord<ZodString, ZodUnknown>>;
  model: ZodOptional<ZodString>;
  pod_name: ZodOptional<ZodString>;
  prompt_tokens: ZodOptional<ZodNumber>;
  result: ZodOptional<ZodUnknown>;
  span_id: ZodOptional<ZodNullable<ZodString>>;
  status: ZodString;
  step_number: ZodNumber;
  tool_api_error: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodString;
     error_code: ZodOptional<ZodNullable<ZodString>>;
     http_status: ZodOptional<ZodNullable<ZodNumber>>;
     provider_type: ZodOptional<ZodNullable<ZodString>>;
     reason: ZodOptional<ZodNullable<ZodString>>;
     retryable: ZodBoolean;
  }, $strip>>>;
  tool_call_id: ZodOptional<ZodString>;
  tool_name: ZodString;
  total_tokens: ZodOptional<ZodNumber>;
  trace_id: ZodOptional<ZodNullable<ZodString>>;
  workspace_id: ZodOptional<ZodString>;
}, $strip>;

Resultado da execução da ferramenta de relatório (AER → OE).

ToolsListResponseSchema

const ToolsListResponseSchema: ZodObject<{
  count: ZodOptional<ZodNumber>;
  tools: ZodArray<ZodRecord<ZodString, ZodUnknown>>;
}, $strip>;

Resposta de ferramentas registradas de listagem de endpoints /tools.

WorkflowDeclarationSchema

const WorkflowDeclarationSchema: GenMessage<WorkflowDeclaration>;

Descreve a mensagem mongodb.agentic.workflow.v1.WorkflowDeclaration. Use create(WorkflowDeclarationSchema) para criar uma nova mensagem.

WorkflowErrorCodeSchema

const WorkflowErrorCodeSchema: GenEnum<WorkflowErrorCode>;

Descreve o enumeração mongodb.agentic.workflow.v1.WorkflowErrorCode.

WorkflowErrorSchema

const WorkflowErrorSchema: GenMessage<WorkflowError>;

Descreve a mensagem mongodb.agentic.workflow.v1.WorkflowError. Use create(WorkflowErrorSchema) para criar uma nova mensagem.

WorkflowIdentitySchema

const WorkflowIdentitySchema: GenMessage<WorkflowIdentity>;

Descreve a mensagem mongodb.agentic.workflow.v1.WorkflowIdentity. Use create(WorkflowIdentitySchema) para criar uma nova mensagem.

WorkflowMessageSchema

const WorkflowMessageSchema: GenMessage<WorkflowMessage>;

Descreve a mensagem mongodb.agentic.workflow.v1.WorkflowMessage. Use create(WorkflowMessageSchema) para criar uma nova mensagem.

WORKSPACE_DIR

const WORKSPACE_DIR: string;

Funções

acumulateStreamUsage()

function accumulateStreamUsage(existing, incoming): LLMTokenUsage | undefined;

Dobre o uso de um chunk de stream em um snapshot em execução.

Fornecedores cumulativos repetem totais crescentes (10/1 e depois 10/2); a mesclagem last-wins mantém 10/2. Fornecedores de aditivos preenchem com zero o lado inalterado (18/1 e depois 0/4); esses deltas são somados.

Parâmetros

Parâmetro
Tipo

existing

`LLMTokenUsage <#llmtokenusage>`__ | undefined

incoming

unknown

Devoluções

`LLMTokenUsage <#llmtokenusage>`__ | undefined

atividadeRequiresReconstruction()

function activityRequiresReconstruction(activityId): boolean;

Parâmetros

Parâmetro
Tipo

activityId

string

Devoluções

boolean

addTokenUsage()

function addTokenUsage(existing, incoming): LLMTokenUsage | undefined;

Soma os deltas de uso aditivo no estilo LangChain em um snapshot cumulativo.

Parâmetros

Parâmetro
Tipo

existing

`LLMTokenUsage <#llmtokenusage>`__ | undefined

incoming

unknown

Devoluções

`LLMTokenUsage <#llmtokenusage>`__ | undefined

adiantamentoStepOrdinal()

function advanceStepOrdinal(committedStepOrdinal): number;

Parâmetros

Parâmetro
Tipo

committedStepOrdinal

number

Devoluções

number

alocateActivityOrdinal()

function allocateActivityOrdinal(key?): number;

Parâmetros

Parâmetro
Tipo

key?

string

Devoluções

number

applyToStage()

function appliesToStage(policy, stage): boolean;

Se policy se aplica a stage. As políticas inativas nunca se aplicam; um filtro de estágio vazio se aplica a todos os estágios; caso contrário, o estágio deve corresponder (insensível a maiúsculas e minúsculas e espaços em branco). Mirrors GuardrailRuntimePolicy.applies_to_stage.

Parâmetros

Parâmetro
Tipo
Descrição

policy

{ action: string; config: Record <string, `JsonValue <#jsonvalue>`__>; id: string; stage_filter: string []; status: string; type: string; }

policy.action

string

Ação solicitada quando a política é acionada.

policy.config

Record <string, `JsonValue <#jsonvalue>`__>

Configuração da política específica do avaliador.

policy.id

string

Identificador da política de guardrail.

policy.stage_filter

string []

Estágios de tempo de execução aos quais esta política se aplica; vazio significa todos os estágios.

policy.status

string

Status da política de proteção.

policy.type

string

Tipo de política de guardrail.

stage

"llm_input" | "llm_output" | "tool_input" | "tool_output"

Devoluções

boolean

anexaMongoTrancing()

function attachMongoTracing(collection): void;

Conecte a collection de armazenamento de rastreamento recuperada ao exportador Mongo lento registrado no momento da configuração. Chamado a partir do loop de repetição em segundo plano assim que uma conexão com falha se recupera. Idempotente — um no-op se já estiver conectado. Novos spans criados após essa rota de chamada para a loja; os spans emitidos enquanto o armazenamento estava inacessível não são recuperados retroativamente.

Parâmetros

Parâmetro
Tipo

collection

Collection

Devoluções

void

tryStartRequestFromExecute()

function attemptStartRequestFromExecute(
   request,
   sessionId,
   ownerId,
   appName,
   workflowVersion?,
   memoryEnabled?
): AttemptStartRequest | null;

Parâmetros

Parâmetro
Tipo
Valor padrão
Descrição

request

{ custom_headers?: Record <string, string>; execution_id: string; message: string; metadata?: Record <string, unknown>; org_id?: string; payload?: Record <string, unknown>; platform_api_owner_url?: string | null; platform_api_url: string; platform_trace_id?: string | null; previous_execution_cancelled: boolean; project_id?: string; resume: boolean; resume_data?: Record <string, unknown>; resume_from_step?: number; session_id?: string; suspend_generation?: number; user_id?: string; workspace_id?: string; }

undefined

request.custom_headers?

Record <string, string>

...

Cabeçalhos personalizados fornecidos pelo chamador.

request.execution_id

string

...

Identificador de execução único.

request.message

string

...

Mensagem do usuário. O padrão é vazio. A promoção de payload.message para uma mensagem de nível superior vazia acontece no AER (resolveInvocationParams), NÃO no nível do modelo - espelha o ExecuteRequest do Python. Mantê-lo fora do modelo permite que o AER rejeite uma mensagem fornecida em ambos os locais como um 400 limpo em vez de um 422 que repetiria a carga útil em registros.

request.metadata?

Record <string, unknown>

...

Estado de propriedade da estrutura opaca passado para o adaptador selecionado.

request.org_id?

string

...

ID da organização para isolamento multilocatário.

request.payload?

Record <string, unknown>

...

Entrada opaca fornecida pelo chamador encaminhada inalterada em cada despacho; payload.message preenche a mensagem de nível superior quando está vazio.

request.platform_api_owner_url?

string | null

...

URL do proprietário OE específico da réplica para fallback de chamada de resposta .

request.platform_api_url?

string

...

URL do OE para retornos de chamada.

request.platform_trace_id?

string | null

...

request.previous_execution_cancelled?

boolean

...

verdadeiro quando a execução anterior mais recente desta sessão foi cancelada (pod removido no meio da execução); o adaptador de framework isola as gravações parciais do checkpoint dessa execução antes de executar esta curva.

request.project_id?

string

...

ID do projeto para o escopo em nível de projeto.

request.resume?

boolean

...

Se esta é uma retomada após a SUSPEND.

request.resume_data?

Record <string, unknown>

...

Dados estruturados para injetar no currículo.

request.resume_from_step?

number

...

Etapa para retomar.

request.session_id?

string

...

ID da sessão; o adaptador AER usa isso como thread_id do LangGraph.

request.suspend_generation?

number

...

Geração de suspensão esperada por este despacho.

request.user_id?

string

...

ID de usuário para personalização.

request.workspace_id?

string

...

Identificador do espaço de trabalho para rastreamento de custos.

sessionId?

string

undefined

ownerId?

string

undefined

appName?

string

undefined

workflowVersion?

string

undefined

memoryEnabled?

boolean

false

Devoluções

`AttemptStartRequest <#attemptstartrequest>`__ | null

boundText()

function boundText(
   text,
   maxBytes?,
   maxLines?
): string;

Truncar text para no máximo maxLines linhas ou maxBytes UTF-8 bytes, qualquer que seja o limite atingido primeiro, anexando um marcador de truncamento quando qualquer limite for atingido.

Parâmetros

Parâmetro
Tipo
Valor padrão

text

string

undefined

maxBytes

number

TERMINATION_MESSAGE_MAX_BYTES

maxLines

number

TERMINATION_MESSAGE_MAX_LINES

Devoluções

string

buildActivityCommand()

function buildActivityCommand(args): ActivityCommand;

Parâmetros

Parâmetro
Tipo

args

{ activityOrdinal: number; attempt: `AttemptContext <#attemptcontext>`__; kind: `ActivityKind <#atividadetipo>`__; name: string; operationPath?: `OperationPath <#operationpath>'__; semanticInput: unknown; stepOrdinal?: number; }

args.activityOrdinal

number

args.attempt

`AttemptContext <#attemptcontext>`__

args.kind

`ActivityKind <#activitykind>`__

args.name

string

args.operationPath?

`OperationPath <#operationpath>'__

args.semanticInput

unknown

args.stepOrdinal?

number

Devoluções

`ActivityCommand <#atividadecommand>`__

buildResultPayload()

function buildResultPayload(result, executionId): Record<string, unknown>;

Codifique o resultado para um objeto seguro para JSON para o POST /tool/result.

Uma ferramenta pode retornar um valor que o codificador JSON não pode manipular (por exemplo, uma referência circular). Faça o downgrade de qualquer falha de código para um relatório de erro para que a OE ainda receba um sinal do terminal. Espelha o _result_ payload do Python.

Parâmetros

Parâmetro
Tipo
Descrição

result

{ completion_tokens?: number; duration_ms: number; error?: string; execution_id: string; kind?: string; metadata: Record <string, unknown>; model?: string; pod_name?: string; prompt_tokens?: number; result?: unknown; span_id?: string | null; status: string; step_number: number; tool_api_error?: | { classification: string; error_code?: string | null; http_status?: number | null; provider_type?: string | null; reason?: string | null; retryable: boolean; } | null; tool_call_id?: string; tool_name: string; total_tokens?: number; trace_id?: string | null; workspace_id?: string; }

result.completion_tokens?

number

Tokens de conclusão/saída usados.

result.duration_ms

number

Duração da execução em milissegundos.

result.error?

string

Mensagem de erro se falhar.

result.execution_id

string

Identificador de execução.

result.kind?

string

Tipo de observabilidade explícita.

result.metadata

Record <string, unknown>

Observability metadata.

result.model?

string

Nome do modelo LLM.

result.pod_name?

string

Nome do host/pod onde a ferramenta foi executada.

result.prompt_tokens?

number

Tokens de prompt/entrada usados.

result.result?

unknown

Resultado da ferramenta se for bem-sucedido.

result.span_id?

string | null

ID de extensão OTel ativo, para correlação de execução-log de OE.

result.status

string

Status da execução: sucesso, erro, suspenso, interrompido.

result.step_number

number

Número do passo.

result.tool_api_error?

| { classification: string; error_code?: string | null; http_status?: number | null; provider_type?: string | null; reason?: string | null; retryable: boolean; } | null

Classificação de falha da API externa estruturada.

result.tool_call_id?

string

ID de chamada de ferramenta LLM estável; une o registro de log de execução deste resultado à sua chamada e à mensagem da sessão.

result.tool_name

string

Nome da ferramenta.

result.total_tokens?

number

Total de tokens usados.

result.trace_id?

string | null

ID de rastreamento OTel ativo, para correlação de execução-log de OE.

result.workspace_id?

string

Identificador do espaço de trabalho.

executionId

string

Devoluções

Record <string, unknown>

callMcpTool()

function callMcpTool(binding, args): Promise<MCPToolResult>;

Execute uma ferramenta MCP remota e normalize seu resultado.

Parâmetros

Parâmetro
Tipo

binding

`MCPToolBinding <#mcptoolbinding>`__

args

Record <string, unknown>

Devoluções

Promise <`MCPToolResult <#mcptoolresult>`__>

captureException()

function captureException(exc, args?): void;

Capture uma exceção. Quando summary é fornecido, a mensagem de erro relatada é o resumo (editado) com o tipo/mensagem da exceção original preservado como extras no escopo — correspondendo ao _exception_for_capture do Python.

Parâmetros

Parâmetro
Tipo

exc

unknown

args

`CaptureExceptionArgs <#captureExceptionargs>`__

Devoluções

void

captureMessage()

function captureMessage(
   message,
   level?,
   extra?
): void;

Parâmetros

Parâmetro
Tipo
Valor padrão

message

string

undefined

level

SeverityLevel

"error"

extra

Record <string, unknown>

{}

Devoluções

void

checkDecision()

function checkDecision(policy): "allow" | "block" | "modify" | "require_review" | "log_only";

Resolva a decisão que uma política acionada solicita, de seu action (retornando para config.on_fail). Mirrors GuardrailRuntimePolicy.check_decision.

Parâmetros

Parâmetro
Tipo
Descrição

policy

{ action: string; config: Record <string, `JsonValue <#jsonvalue>`__>; id: string; stage_filter: string []; status: string; type: string; }

policy.action

string

Ação solicitada quando a política é acionada.

policy.config

Record <string, `JsonValue <#jsonvalue>`__>

Configuração da política específica do avaliador.

policy.id

string

Identificador da política de guardrail.

policy.stage_filter

string []

Estágios de tempo de execução aos quais esta política se aplica; vazio significa todos os estágios.

policy.status

string

Status da política de proteção.

policy.type

string

Tipo de política de guardrail.

Devoluções

"allow" | "block" | "modify" | "require_review" | "log_only"

childOperationBoundaryScope()

function childOperationBoundaryScope<T>(boundary, fn): T;

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

boundary

`ChildOperationBoundary <#childoperationboundary>'__

fn

() => T

Devoluções

T

clearWorkflowAdapter()

function clearWorkflowAdapter(): void;

Elimine a elegibilidade durável para o mais recente gráfico materializado.

Devoluções

void

closeSessionFinish()

function closeSessionFinish(): void;

Feche a trava de conclusão da sessão da execução atual.

Chamado a partir do finally do AER quando o quadro de execução terminar (cobre caminhos de sucesso, erro, política negada e suspensão). Depois disso, requestSessionFinish() relata “indisponível” em vez de promessa de uma versão em que nada entrará em ação — por exemplo um setTimeout ou promessa flutuante agendada durante a mudança, mas resolvida depois dela.

Devoluções

void

coerceTokenUsage()

function coerceTokenUsage(value): LLMTokenUsage | undefined;

Forçar um blob de uso do fornecedor a LLMTokenUsage ou indefinido.

Parâmetros

Parâmetro
Tipo

value

unknown

Devoluções

`LLMTokenUsage <#llmtokenusage>`__ | undefined

completedOutcome()

function completedOutcome(context, result): ActivityOutcome;

Parâmetros

Parâmetro
Tipo

context

`ActivityContext <#activitycontext>`__

result

unknown

Devoluções

`ActivityOutcome <#activityoutcome>`__

completeExecutionCommand()

function completeExecutionCommand(attempt, state): CompleteExecutionCommand;

Parâmetros

Parâmetro
Tipo

attempt

`AttemptContext <#attemptcontext>`__

state

`StateSnapshot <#statesnapshot>`__

Devoluções

`CompleteExecutionCommand <#completeexecutioncommand>`__

createSecureToolFunction()

function createSecureToolFunction(
   originalTool,
   toolName,
   allowDirect?,
   options?
): (kwargs?, config?) => Promise<unknown>;

Crie uma função de ferramenta agrupada que roteie o SecureToolWrapper.

O wrapper é procurado no contexto do AsyncLocalStorage no momento da chamada, para que a ferramenta possa ser construída antes que o contexto de execução exista.

A ferramenta registrada deve expor um método invoke para a execução local aprovada e o caminho de depuração de execução direta. A execução direta é UNSAFE e apenas para depuração.

Parâmetros

Parâmetro
Tipo
Valor padrão

originalTool

unknown

undefined

toolName

string

undefined

allowDirect

boolean

false

options

CreateSecureToolFunctionOptions

{}

Devoluções

(kwargs?, config?) => Promise <unknown>

currentAttemptContext()

function currentAttemptContext(): AttemptContext | null;

Devoluções

`AttemptContext <#attemptcontext>`__ | null

AtualOperationPath()

function currentOperationPath(): OperationPath;

Devoluções

`OperationPath <#operationpath>'__

currentPENDingChildOperationBatch()

function currentPendingChildOperationBatch(): readonly ChildOperationBoundary[];

Devoluções

readonly `ChildOperationBoundary <#childoperationboundary>`__ []

currentStepOrdinal()

function currentStepOrdinal(): number;

Devoluções

number

findMcpTools()

function discoverMcpTools(config): Promise<MCPToolBinding[]>;

Descubra ferramentas MCP remotas para todos os servidores configurados.

Espelha adaptadores comuns de cliente MCP: inicialize cada servidor, chame tools/list e exponha os esquemas retornados como ferramentas nativas de framework.

Parâmetros

Parâmetro
Tipo

config

{ servers: Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>; }

config.servers

Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>

Devoluções

Promise <`MCPToolBinding <#mcptoolbinding>`__ []>

emit()

function emit(event, data): Promise<void>;

Emita um chunk de determinado tipo de evento para o stream do cliente .

API de uso geral. Para o caso comum da etapa textual, prefira emitStep.

Parâmetros

Parâmetro
Tipo
Descrição

event

string

Identificador do tipo de chunk (por exemplo, "step"). Tipos de evento de infraestrutura reservados (done, error, text, subagent_start, subagent_end) rejeitam com um Error para evitar que o código da ferramenta feche prematuramente ou falsifique o fluxo. A verificação de evento reservado é acionada mesmo fora de um contexto de execução – um erro de programador vence o no-op. "custom_event" não é eventos personalizados do Atlas Agent Engine; aqueles exigem emit_custom_event e features.use_custom_parser em agent.yaml. O gateway descarta chunk_type: "custom_event" , a menos que esse recurso esteja ativado.

data

string

String de carga útil do evento. As falhas de transporte (incluindo uma resposta não2xx) são registradas na depuração e consumidas — a entrega do melhor esforço nunca deve abortar a função da ferramenta. Nenhum oplog fora de um contexto de execução.

Devoluções

Promise <void>

emitStep()

function emitStep(message): Promise<void>;

Emita uma etapa de progresso textual de dentro de uma função de ferramenta de execução.

wrapper de conveniência por volta de emit("step", message).

Parâmetros

Parâmetro
Tipo

message

string

Devoluções

Promise <void>

Exemplo

import { emitStep } from "@mongodb-js/agent-engine-runner-shared";
app.tool({ isLocal: false })(async function crawlWebsite(url: string) {
  await emitStep("Fetching page...");
  const html = await fetch(url);
  await emitStep(`Parsing links from ${url}...`);
  return parse(html);
});

encodeProtoJson()

function encodeProtoJson<T>(schema, message): string;

Codifique uma mensagem protobuf como uma string ProtoJSON usando nomes de campo de fio. Compartilhado para que os adaptadores de estrutura publiquem corpos JSON em formato de plataforma sem serialização manual .

Parâmetros de tipo

Type Parameter

T estende Message

Parâmetros

Parâmetro
Tipo

schema

GenMessage <T>

message

T

Devoluções

string

ensureUtc()

function ensureUtc(value): Date | undefined;

Normalize um valor (Data, string ISO ou nulo/indefinido) para uma Data UTC.

o MongoDB armazena datas ingênuas em UTC; esse assistente os reidrata como instâncias de Data adequadas para que os chamadores não combinem tipos de string e Data.

Espelha Python Execution._ensure_utc. JS Date não tem distinção ingênua/conhecida (toda data é internamente UTC ms-since-epoc), portanto, a versão TS exercita a mesma intenção de "normalizar entrada para uma data canônica" forçando strings ISO e passando instâncias de Date por inalterada.

Parâmetros

Parâmetro
Tipo

value

unknown

Devoluções

Date | undefined

entrypointScope()

function entrypointScope<T>(fn): T;

Marque a extensão dinâmica da chamada @app.entrypoint do usuário.

Framework-interno — o código do agente do usuário nunca deve chamar isso. Os usuários declaram apenas um ponto de entrada (app.entrypoint(fn)); o SDK do framework agrupa sua própria avaliação dessa função (durante a construção do gráfico AER e durante a preparação da ferramenta, repetida após a falha) neste assistente para que registerLlm() possa rejeitar chamadas app.llm() feitas fora do ponto de entrada. Os testes que chamam app.llm()/registerLlm() diretamente (ignorando app.entrypoint + getAgent()) o usam para simular essa avaliação de framework.

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

fn

() => T

Devoluções

T

avaliarGuardrailCheck()

function evaluateGuardrailCheck(request): object;

Avalie as políticas de proteção para um limite de tempo de execução.

Parâmetros

Parâmetro
Tipo
Descrição

request

{ context: { org_id: string; project_id: string; session_id?: string | null; user_id?: string | null; workspace_id?: string | null; }; execution_id: string; input: { metadata: Record <string, `JsonValue <#jsonvalue>`__>; text: string; }; policies: object []; stage: "llm_input" | "llm_output" | "tool_input" | "tool_output"; }

request.context

{ org_id: string; project_id: string; session_id?: string | null; user_id?: string | null; workspace_id?: string | null; }

Contexto de execução.

request.context.org_id

string

ID da organização.

request.context.project_id

string

ID do projeto.

request.context.session_id?

string | null

ID da sessão.

request.context.user_id?

string | null

ID do usuário.

request.context.workspace_id?

string | null

ID do espaço de trabalho.

request.execution_id

string

Identificador de execução.

request.input

{ metadata: Record <string, `JsonValue <#jsonvalue>`__>; text: string; }

Conteúdo para avaliar.

request.input.metadata

Record <string, `JsonValue <#jsonvalue>`__>

Metadados de tempo de execução, como modelo, nome da ferramenta ou origem.

request.input.text

string

Conteúdo de texto para avaliar.

request.policies

object []

Políticas selecionadas pela OE para avaliar.

request.stage

"llm_input" | "llm_output" | "tool_input" | "tool_output"

Estágio de tempo de execução que está sendo avaliado.

Devoluções

Nome
Tipo
Valor padrão
Descrição

allowed

boolean

Se a execução pode continuar.

decision

"allow" | "block" | "modify" | "require_review" | "log_only"

GuardrailCheckDecisionSchema

Decisão sobre guardrails.

evidence

object []

Evidencia de gatilho de política.

metadata

Record <string, `JsonValue <#jsonvalue>`__>

Metadados de resposta específicos do avaliador.

reason?

string | null

Motivo da decisão.

transformed_text?

string | null

Texto modificado quando a decisão é modificar, ou texto original para permitir/não-op.

triggered_policy_ids

string []

IDs de política que foram acionados.

executionFromPersistenceDoc()

function executionFromPersistenceDoc(doc): object;

Reidrate uma execução de um documento do MongoDB .

Usa valores padrão para campos opcionais para que os documentos criados antes da adição de novos campos ainda sejam desserializados com segurança.

Parâmetros

Parâmetro
Tipo

doc

Record <string, unknown>

Devoluções

Nome
Tipo
Valor padrão
Descrição

aer_url?

string

Endpoint HTTP AER para este agente; substitui o padrão AER_URL.

created_at

Date

error?

string

Mensagem de erro.

id

string

Identificador de execução único.

message

string

Mensagem original do usuário.

org_id?

string

ID da organização para isolamento multilocatário.

project_id?

string

ID do projeto para o escopo em nível de projeto.

result?

unknown

Resultado final.

session_id?

string

ID da sessão para correlação de rastreamento.

status

| "error" | "pending" | "running" | "suspended" | "resuming" | "completed" | "cancelled"

ExecutionStatusSchema

Status atual.

suspend_context?

Record <string, unknown>

Contexto para currículo.

suspend_reason?

string

Motivo da suspensão.

tool_url?

string

Endpoint HTTP da ferramenta para este agente; substitui o TOOL_URL padrão.

updated_at

Date

user_id?

string

ID de usuário para personalização.

workspace_id?

string

Identificador do espaço de trabalho para rastreamento de custos.

executionStepFromLogDoc()

function executionStepFromLogDoc(doc): object;

Reconstrua um ExecutionStep a partir de um documento execution_logs MongoDB .

A coleção execution_logs armazena eventos de início/resultado da ferramenta com campos: execution_id, step_number, ferramenta, entradas, status, saída, erro, duration_ms, timestamp. Isso mapeia esses campos de volta ao modelo ExecutionStep para reidratação do cache de etapas após a reinicialização do OE.

Parâmetros

Parâmetro
Tipo

doc

Record <string, unknown>

Devoluções

Nome
Tipo
Descrição

arguments

Record <string, unknown>

Argumentos passados.

duration_ms?

number

Duração da execução.

error?

string

Mensagem de erro.

execution_id

string

ID de execução principal.

id

string

Unique step identifier.

result?

unknown

Resultado da etapa.

status

string

Status da etapa: pendente, sucesso, erro.

step_number

number

Número de sequência do passo.

timestamp

Date

As strings ISO são forçadas a Date, correspondendo ao Pydantial.

tool_name

string

Nome da ferramenta ou operação.

executionToPersistenceDoc()

function executionToPersistenceDoc(exec, updatedAt?): Record<string, unknown>;

Converta uma execução em um documento de persistência do MongoDB .

updatedAt padrão para agora se omitido.

Parâmetros

Parâmetro
Tipo
Descrição

exec

{ aer_url?: string; created_at: Date; error?: string; id: string; message: string; org_id?: string; project_id?: string; result?: unknown; session_id?: string; status: | "error" | "pending" | "running" | "suspended" | "resuming" | "completed" | "cancelled"; suspend_context?: Record <string, unknown>; suspend_reason?: string; tool_url?: string; updated_at: Date; user_id?: string; workspace_id?: string; }

exec.aer_url?

string

Endpoint HTTP AER para este agente; substitui o padrão AER_URL.

exec.created_at?

Date

exec.error?

string

Mensagem de erro.

exec.id?

string

Identificador de execução único.

exec.message?

string

Mensagem original do usuário.

exec.org_id?

string

ID da organização para isolamento multilocatário.

exec.project_id?

string

ID do projeto para o escopo em nível de projeto.

exec.result?

unknown

Resultado final.

exec.session_id?

string

ID da sessão para correlação de rastreamento.

exec.status?

| "error" | "pending" | "running" | "suspended" | "resuming" | "completed" | "cancelled"

Status atual.

exec.suspend_context?

Record <string, unknown>

Contexto para currículo.

exec.suspend_reason?

string

Motivo da suspensão.

exec.tool_url?

string

Endpoint HTTP da ferramenta para este agente; substitui o TOOL_URL padrão.

exec.updated_at?

Date

exec.user_id?

string

ID de usuário para personalização.

exec.workspace_id?

string

Identificador do espaço de trabalho para rastreamento de custos.

updatedAt?

Date

Devoluções

Record <string, unknown>

explicitamenteFeatures()

function explicitFeatures(features): Record<string, boolean>;

Retornar apenas os sinalizadores explicitamente presentes em agent.yaml (campos omitir e não definir / null). AgentFeatureConfig.explicit() do Python - usado pelo anúncio de recurso do AER para enviar ao OE apenas os sinalizadores que o autor realmente definiu, antes que os padrões injetados pelo SDK (por exemplo, owner_callback_fallback) sejam colocados em camadas no topo.

Parâmetros

Parâmetro
Tipo
Descrição

features

{ deep_agent: boolean | null; durable_workflow: boolean | null; guardrails: boolean | null; memory: boolean | null; playground: boolean | null; use_custom_parser: boolean | null; }

features.deep_agent

boolean | null

Se o agente usa o chicote de agentes profundos (deepagents). Bloqueia o sistema de arquivos integrado + registro do manipulador de shell para que os locatários que não executam agentes profundos não obtenham nenhum sistema de arquivos/superfície de shell em seu Tool Pod. A chave permanece snake_case deep_agent porque agent.yaml é um artefato de linguagem cruzada compartilhado com o tempo de execução e a plataforma Python.

features.durable_workflow

boolean | null

Opte pelo fluxo de trabalho durável de propriedade de OE. Omitido ou falso significa que o agente permanece nos checkpoints nativos; somente um true explícito aceita. Quando definido, o OE usa esse sinalizador com o idioma anunciando para atribuir de forma fixa a autoridade de fluxo de trabalho da sessão.

features.guardrails

boolean | null

Se as grades de proteção são aplicadas a esse agente no tempo de execução. null (o padrão) significa omitido, permitindo que o tempo de execução volte ao comportamento legado .

features.memory

boolean | null

features.playground

boolean | null

Se a plataforma provisiona a interface do usuário do playground para o agente (nulo/verdadeiro = provisionado, comportamento de hoje). Quando falso — por exemplo, para agentes que não sejam de chat sem conversa com a visualização — nenhum playground é criado ou atendido; chamadores usam a API de chamada diretamente. Leia somente no momento da implantação/provisionamento — sem efeito no tempo de execução.

features.use_custom_parser

boolean | null

Opte pela modelagem de saída de streaming definida pelo autor. Quando verdadeiro, o adaptador executa o analisador de saída registrado e emite armações custom_event; off deixa o stream inalterado.

Devoluções

Record <string, boolean>

extractUsage()

function extractUsage(response, fallbackModel?): ExtractedUsage;

Extraia o uso de token do response_metadata de uma resposta LLM.

Lida com nomes de chaves variantes do provedor: - OpenAI: response_metadata.usage.{prompt_tokens, completion_tokens, total_tokens} - Atrópico: response_metadata.usage.{input_tokens, output_tokens} - Alguns provedores: response_metadata.token_usage.{...}

Retorna um objeto com as chaves prompt_tokens, completion_tokens, total_tokens, model. Todos os valores podem ser null se indisponíveis.

Simula o agent_engine_runner_shared.secure_wrapper.extract_usage 1 do Python:1.

Parâmetros

Parâmetro
Tipo
Valor padrão

response

unknown

undefined

fallbackModel

string | null

null

Devoluções

`ExtractedUsage <#extractedusage>'__

failedOutcome()

function failedOutcome(
   context,
   message,
   code?
): ActivityOutcome;

Parâmetros

Parâmetro
Tipo
Valor padrão

context

`ActivityContext <#activitycontext>`__

undefined

message

string

undefined

code

`WorkflowErrorCode <#work Bloscherorcode>`__

WorkflowErrorCode.OUTCOME_UNKNOWN

Devoluções

`ActivityOutcome <#activityoutcome>`__

fetchPlatform()

function fetchPlatform(
   url,
   init,
   fetchImpl?
): Promise<Response>;

Carregue o rastreamento ativo por uma RPC de plataforma sem gravar o transporte.

Parâmetros

Parâmetro
Tipo
Valor padrão

url

string

undefined

init

RequestInit

undefined

fetchImpl

{ (input, init?): Promise <Response>; (input, init?): Promise <Response>; }

fetch

Devoluções

Promise <Response>

filesystemDownload()

function filesystemDownload(args): Record<string, unknown>;

Faça o download dos bytes brutos de um arquivo codificados64para que o transporte JSON possa carregar conteúdo binário arbitrário. AgentEngineToolPodBackend.downloadFiles base64-decodifica isso para produzir os bytes de resposta.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Record <string, unknown>

filesystemEdit()

function filesystemEdit(args): Record<string, unknown>;

Localize e substitua texto em um arquivo, retornando o número de ocorrências substituídas. Quando replace_all é falso, a correspondência deve ser exclusiva — um old_string não exclusivo é rejeitado para que um chamador não possa corromper silenciosamente a região errada. Arquivos maiores que FILESYSTEM_READ_MAX_BYTES (antes ou depois da edição) são rejeitados para espelhar a proteção de memória do filesystem_read.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Record <string, unknown>

filesystemGlob()

function filesystemGlob(args): Promise<Record<string, unknown>>;

Combine os arquivos usando um padrão global no caminho (relativo ao espaço de trabalho, padrão "."). Suporta padrões ** recursivos. Limite por MAX_GLOB_MATCHES. Padrões absolutos e segmentos transversais .. são rejeitados para que não possam ignorar a sandbox; as correspondências retornadas também são filtradas por meio de isWithinReadableRoot para proteção em profundidade contra links simbólicos.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Promise <Record <string, unknown>>

filesystemGrep()

function filesystemGrep(args): Record<string, unknown>;

Pesquise o conteúdo do arquivo para uma substring literal (por BackendProtocol.grep, não um regex). Percorre a árvore sob o caminho (padrão "."); quando glob é fornecido, somente arquivos cujos nomes correspondem são pesquisados. Arquivos binários são ignorados. Limitado por MAX_agrep_matchees e MAX_greP_seconds, portanto, uma caminhada pela árvore profunda não pode pegar um trabalhador indefinidamente.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Record <string, unknown>

filesystemLs()

function filesystemLs(args): Record<string, unknown>;

Liste o conteúdo do diretório, classificado por nome. Quando o diretório tiver mais de MAX_LS_ENTRIES entradas, truncated=true e o subconjunto retornado for a ordem de leitura das primeiras entradas MAX_LS_ENTRIES (definido pelo sistema de arquivos) e, em seguida, classificado por caminho. A quebra antecipada é intencional – classificar todas as entradas primeiro eliminaria o limite de memória em diretórios com centenas de milhares de entradas.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Record <string, unknown>

filesystemRead()

function filesystemRead(args): Record<string, unknown>;

Leia o conteúdo do arquivo como texto com fatia baseada em linha (linhas [offset, offset+limit)). Rejeita arquivos maiores que FILESYSTEM_READ_MAX_BYTES antecipadamente, portanto, arquivos biologicamente grandes não podem esgotar a memória do pod.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Record <string, unknown>

filesystemWrite()

function filesystemWrite(args): Record<string, unknown>;

Escreva conteúdo em um novo arquivo, criando diretórios pai. De acordo com BackendProtocol.write, isso é somente criação: se o arquivo existir, a chamada falhará. Os agentes modificam arquivos existentes via filesystem_edit (que tem uma proteção de correspondência única).

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Record <string, unknown>

filterThinkingTokens()

function filterThinkingTokens(
   token,
   buffer,
   inside
): [string, string, boolean];

Filtre <think> blocos de um fluxo de blocos de token.

Acumula texto no buffer até que possamos determinar se o conteúdo está dentro de um bloco de reflexão. Retorna [streamable, newBuffer, inside] onde streamable é o texto seguro para enviar ao cliente.

Parâmetros

Parâmetro
Tipo

token

string

buffer

string

inside

boolean

Devoluções

[string, string, boolean]

finalizeCurrentStepCommand()

function finalizeCurrentStepCommand(attempt, state): FinalizeStepCommand;

Parâmetros

Parâmetro
Tipo

attempt

`AttemptContext <#attemptcontext>`__

state

`StateSnapshot <#statesnapshot>`__

Devoluções

`FinalizeStepCommand <#finalizestepcommand>`__

finalizeCurrentStepSuspensionsCommand()

function finalizeCurrentStepSuspensionsCommand(attempt, suspensions): FinalizeStepCommand;

Parâmetros

Parâmetro
Tipo

attempt

`AttemptContext <#attemptcontext>`__

suspensions

readonly `StepSuspensionEntry <#stepsuspensionentry>`__ []

Devoluções

`FinalizeStepCommand <#finalizestepcommand>`__

flushErrorReporting()

function flushErrorReporting(timeoutMs?): Promise<void>;

Parâmetros

Parâmetro
Tipo
Valor padrão

timeoutMs

number

2000

Devoluções

Promise <void>

formatLlmError()

function formatLlmError(error): string;

Renderize um erro de provedor LLM para exibição, sem texto JSON escapado.

Alguns SDKs de fornecedor anexam o corpo de erro da API bruto como um objeto no erro ou em seu cause (.details, .body). Os valores desse objeto geralmente são strings codificadas em JSON contendo novas linhas (por exemplo, uma carga útil de erro aninhada impressa de forma bonita), então a stringification String()/template-literal termina produzindo um repr que transforma as novas linhas em sequências literais \n. Decodifique qualquer valor de string codificado em JSON primeiro e re-serialize com JSON.stringify(..., null, 2) para que o resultado seja renderizado como JSON legível e recuado.

Parâmetros

Parâmetro
Tipo

error

unknown

Devoluções

string

getAllCustomHeaders()

function getAllCustomHeaders(): Record<string, string>;

Todos os cabeçalhos personalizados, incluindo entradas de a2a- internas à plataforma.

Devoluções

Record <string, string>

getCallAbortSignal()

function getCallAbortSignal(): AbortSignal | undefined;

O sinal de parada por chamada para a chamada de ferramenta roteada de retorno de chamada a bordo. Definido somente dentro de um corpo de ferramenta que declarava suporte à interrupção de chamada; um corpo administrativo verifica-o (ou encaminha-o para fetch etc.) para parar no próximo checkpoint. Indefinido em todos os outros lugares.

Devoluções

AbortSignal | undefined

getCheckpointWorkspaceId()

function getCheckpointWorkspaceId(): string;

Escopo do espaço de trabalho resolvido para leituras de checkpoint (corresponde ao caminho de gravação).

Retorna "" somente para tempos de execução locais sem escopo intencionalmente. Os AERs gerenciados carregam REQUIRE_PROJECT_SCOPED_DB e exigem App_ID; eles rejeitam deliberadamente o fallback de conexão se o App_ID estiver ausente.

Devoluções

string

getContentCaptureMode()

function getContentCaptureMode(): string;

Leia a política de captura de conteúdo de AGENTIC_PLATFORM_OTEL_CONTENT_CAPTURE. O padrão é "metadata-only"; qualquer valor diferente de "full" é tratado como "metadata-only", de modo que um erro de digitação não seja aberto.

Devoluções

string

getCurrentAuthorization()

function getCurrentAuthorization():
  | {
  expires_at?: number | null;
  token: string;
}
  | null;

autorização delegada para a execução atual, se o OE injetou uma.

Devoluções

Tipo Literal
{
  expires_at?: number | null;
  token: string;
}
Nome
Tipo
Descrição

expires_at?

number | null

Expiração do token como segundos Unix.

token

string

Token do portador para acesso à API de terceiros.

null

getCurrentCustomHeaders()

function getCurrentCustomHeaders(): Record<string, string>;

Cabeçalhos personalizados fornecidos pelo chamador, com entradas de a2a- internas da plataforma removidas — o código do agente nunca deve ver tokens A2A ou metadados de roteamento. O código interno da plataforma que precisa do conjunto completo (por exemplo, o cliente A2A ) deve chamar getAllCustomHeaders.

Devoluções

Record <string, string>

getCurrentExecutionId()

function getCurrentExecutionId(): string | null;

Devoluções

string | null

getCurrentExecutionMetadata()

function getCurrentExecutionMetadata(): Record<string, unknown>;

Devoluções

Record <string, unknown>

getCurrentLogOrigin()

function getCurrentLogOrigin(): string | null;

"customer" dentro de um limite de código de cliente, caso contrário, nulo.

Devoluções

string | null

getCurrentOeOwnerUrl()

function getCurrentOeOwnerUrl(): string | null;

URL de chamada de resposta do proprietário OE específico da réplica validado para a execução atual ou nulo quando nenhum foi encaminhado ou uma pré-tentativa de proprietário anterior já falhou (consulte reportOeOwnerUrlFailure). Os transportes com preferência do proprietário são enviados para aqui primeiro e retornam para getCurrentOeUrl em qualquer falha do proprietário.

Devoluções

string | null

getCurrentOeUrl()

function getCurrentOeUrl(): string | null;

Devoluções

string | null

getCurrentPayload()

function getCurrentPayload(): Record<string, unknown> | null;

O payload de invocação fornecido pelo chamador opaco para a execução atual (o corpo da solicitação além de message), ou nulo se nenhum tiver sido encaminhado.

Devoluções

Record <string, unknown> | null

getCurrentRequestId()

function getCurrentRequestId(): string | null;

Devoluções

string | null

getCurrentSessionId()

function getCurrentSessionId(): string | null;

Devoluções

string | null

getCurrentTraceContext()

function getCurrentTraceContext(): object;

Devoluções

object

Nome
Tipo

spanId

string | null

traceId

string | null

getCurrentTraceId()

function getCurrentTraceId(): string | null;

Devoluções

string | null

getCurrentUserId()

function getCurrentUserId(): string | null;

Devoluções

string | null

getCurrentWorkspaceId()

function getCurrentWorkspaceId(): string | null;

Devoluções

string | null

getCurrentWrapper()

function getCurrentWrapper(): unknown;

Devoluções

unknown

getEnv()

function getEnv(name, defaultValue?): string;

Obtenha a variável de ambiente com o padrão.

Parâmetros

Parâmetro
Tipo
Valor padrão

name

string

undefined

defaultValue

string

""

Devoluções

string

getEnvBool()

function getEnvBool(name, defaultValue?): boolean;

Obtenha a variável de ambiente booleana com padrão.

Parâmetros

Parâmetro
Tipo
Valor padrão

name

string

undefined

defaultValue

boolean

false

Devoluções

boolean

getEnvFloat()

function getEnvFloat(name, defaultValue): number;

Obtenha a variável de ambiente flutuante com padrão.

Parâmetros

Parâmetro
Tipo

name

string

defaultValue

number

Devoluções

number

getEnvInt()

function getEnvInt(name, defaultValue): number;

Obtenha a variável de ambiente inteira com padrão.

Parâmetros

Parâmetro
Tipo

name

string

defaultValue

number

Devoluções

number

getFetchOptionsWithTLS()

function getFetchOptionsWithTLS(url): RequestInit | undefined;

Obtenha opções de busca configuradas para a URL fornecida com suporte a mTLS.

Se url usar variáveis de ambiente de certificado HTTPS e TLS definidas (TLS_CERT_PATH, TLS_KEY_PATH, TLS_CA_CERT_PATH), retornará opções com um agente HTTPS configurado para mTLS. Para URLs HTTP ou quando os certificados não estão disponíveis, retorna indefinido (use o comportamento de busca padrão).

O agente HTTPS é armazenado em cache por URL base para o pool de conexões.

Desempenho: verifica o cache do agente VISUALIZAR a leitura dos arquivos de certificado para evitar o bloqueio do loop de eventos na E/S do sistema de arquivos para cada solicitação. Os arquivos de certificado são lidos apenas uma vez por URL base ao criar o agente, não em cada busca.

Rotação de certificados: no modo de contêiner (TLS_PATH), detecta automaticamente a rotação do cert-manager comparando o arquivo mtimes e invalida o agente em cache para que a próxima solicitação pegue certificados atualizados. No modo VM (TLS _PEM), as env vars são estáticas durante a vida útil do pod, portanto, a rotação requer a reinicialização do pod.

Parâmetros

Parâmetro
Tipo
Descrição

url

string

A URL do serviço de destino (http:// ou https://)

Devoluções

RequestInit | undefined

Buscar opções com agente ou indefinido para HTTP/no-TLS

Lança

Erro se HTTPS for usado, mas a configuração do TLS estiver incompleta

getInstrumentor()

function getInstrumentor(): Instrumentor | null;

Devoluções

`Instrumentor <#instrumentor>`__ | null

getLLMAdapterFactory()

function getLLMAdapterFactory(): LLMAdapterFactory;

Devoluções

`LLMAdapterFactory <#llmadapterfactory>`__

getLogger()

function getLogger(name?): Logger;

Retorne um registrador com o nome do módulo do chamador.

Espelha Python logging.getLogger(__name__). log4js mantém um registro global, portanto, uma reconfiguração setupLogging posterior é automaticamente visível para cada referência emitida anteriormente. A primeira chamada executa uma configuração padrão para que os padrões const logger = getLogger(__name__) de escopo de módulo funcionem sem um setupLogging explícito na inicialização.

Parâmetros

Parâmetro
Tipo

name?

string

Devoluções

Logger

getNamedLlm()

function getNamedLlm(llmId): unknown;

Parâmetros

Parâmetro
Tipo

llmId

string

Devoluções

unknown

getQueryPlugin()

function getQueryPlugin(): AERQueryPlugin | null;

Retorne o AERQueryPlugin registrado ou null se nenhum tiver sido registrado.

Devoluções

`AERQueryPlugin <#aerqueryplugin>`__ | null

getRequestedSuspend()

function getRequestedSuspend(): Record<string, unknown> | null;

A carga útil suspensa que a chamada da ferramenta atual solicitou por meio de suspendPayloadToJson ou nula se não o fez. O Pod da Ferramenta lê isso depois que a ferramenta retorna para decidir se deseja relatar status: "suspend".

Devoluções

Record <string, unknown> | null

getRequestTimeout()

function getRequestTimeout(): number;

Obtenha o tempo limite da solicitação HTTP do ambiente.

Utiliza RUNNER_REQUEST_TIMEOUT env var, padrão para 60.0 segundos.

Devoluções

number

getRuntimeMode()

function getRuntimeMode(): RuntimeMode;

Obtenha o modo de tempo de execução atual da variável de ambiente.

Devoluções

`RuntimeMode <#runtimemode>`__

RuntimeMode com base na variável de ambiente RUNNER_MODE.

Lança

Erro se RUNNER_MODE não estiver definido ou não for um modo válido .

getStoreDbName()

function getStoreDbName(): string;

Retorne o nome do banco de dados do plano de dados consolidado base (sem escopo).

Lê MDB_AGENTIC_STORE_DB do ambiente em cada chamada para que a configuração atrasada (por exemplo, carregando um arquivo.env após a importação) seja respeitada. Para o nome com escopo por projeto, use resolveStoreDbName.

Devoluções

string

getSuspendHandler()

function getSuspendHandler(): SuspendHandler | null;

Devoluções

`SuspendHandler <#suspendhandler>`__ | null

getToolReadTimeout()

function getToolReadTimeout(): number;

Obtenha o tempo limite de leitura da chamada da ferramenta do ambiente.

O OE mantém /tool/execute aberto até que o resultado da ferramenta retorne, de modo que isso limita o tempo de execução da ferramenta em vez da negociação. Ele corresponde ao prazo da ferramenta do próprio OE: um valor menor abandona uma ferramenta que a plataforma ainda está executando normalmente, deixando o SDK sem nenhum resultado a ser relatado.

Utiliza RUNNER_TOOL_READ_TIMEOUT env var, padrão para 600.0 segundos.

Devoluções

number

getTracePath()

function getTracePath(): string;

Resolva o caminho do arquivo de rastreamento no disco do env vars (mirrors Python).

Devoluções

string

getTracer()

function getTracer(name?): Tracer;

Parâmetros

Parâmetro
Tipo
Valor padrão

name

string

"runner-sdk"

Devoluções

Tracer

getWorkflowAdapter()

function getWorkflowAdapter(): WorkflowAdapter | null;

Devoluções

`WorkflowAdapter <#workflowadapter>`__ | null

hasNamedLlms()

function hasNamedLlms(): boolean;

Devoluções

boolean

initErrorReporting()

function initErrorReporting(args): Promise<boolean>;

Inicialize o relatório de erros do Sentry. No-op (retorna false) a menos que AGENTIC_SENTRY_ENABLED=1 e AGENTIC_SENTRY_DSN estejam definidos e @sentry/node esteja instalado. Marca cada evento com surface e, quando fornecido, component / mode.

Nunca oferece: um módulo ausente ou um Sentry.init com falha deixa os relatórios desativados em vez de propagar – ativar a observabilidade não deve se tornar um bloqueador de inicialização.

Parâmetros

Parâmetro
Tipo

args

`InitErrorReportingArgs <#initerrorreportingargs>`__

Devoluções

Promise <boolean>

installStructuredLogging()

function installStructuredLogging(args?): Logger;

Instale o registro estruturado na raiz do log4js.

Comporta-se como o install_structured_logging do Python SDK:

  • Idempotente: a reinstalação roteia o anexador por meio do stdout.write original com snapshot (armazenado em ORIGINAL_WRITE_SLOT), para que ele continue gravando no stdout real em vez de recursão por meio de uma gravação corrigida.

  • silenciosa bibliotecas HTTP barulhentas (consulte NOISY_LOGGER_NAMES) - equivalente ao bloco logging.getLogger("httpx").setLevel(WARNING) do Python.

  • Correções process.stdout.write / process.stderr.write (a menos que captureStdio: false) para que as gravações dispersas surjam como registros de registro estruturado marcados com source: "stdout" (INFO) ou source: "stderr" (WARNING). stderr não foi deliberadamente mapeado para ERROR - o Python teve que voltar atrás porque cada aviso de depreciação teria sido paginado em serviço.

Parâmetros

Parâmetro
Tipo

args

`InstallStructuredLoggingArgs <#installstructuredloggingargs>`__

Devoluções

Logger

interruptActivity()

function interruptedActivities(stepOrdinal): InterruptedActivity[];

Parâmetros

Parâmetro
Tipo

stepOrdinal

number

Devoluções

`InterruptedActivity <#interruptedactivity>`__ []

isConfiguredMcpSdkToolName()

function isConfiguredMcpSdkToolName(config, sdkToolName): boolean;

Retorna se sdkToolName pertence a um servidor MCP configurado.

Parâmetros

Parâmetro
Tipo

config

{ servers: Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>; }

config.servers

Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>

sdkToolName

string

Devoluções

boolean

isLlmCredentialRejection()

function isLlmCredentialRejection(error): boolean;

Verdadeiro quando um erro do provedor LLM é uma rejeitação de autenticação (HTTP 401/403).

Lê somente os campos de status do próprio SDK do provedor — status (nó openai / estilo de nó antrópico), status_code, response.status / response.status_code ( estilo fetch/axios) e um número inteiro code — andando pelo cause cadeia porque os adaptadores ocasionalmente lançam novamente. O texto nunca é correspondido: o chamador mapeia um resultado positivo no código de erro de credencial em nível de fio, e qualquer coisa não reconhecida retorna falso, de modo que a falha mantenha sua classificação genérica existente.

Parâmetros

Parâmetro
Tipo

error

unknown

Devoluções

boolean

isPlatformEnvVar()

function isPlatformEnvVar(name): boolean;

Retorne true se name corresponder a uma env var de propriedade da plataforma.

Visualização da API pública da mesma verificação de associação usada por tenantEnvVars.

Parâmetros

Parâmetro
Tipo

name

string

Devoluções

boolean

isRetryableError()

function isRetryableError(error): boolean;

Classifique as falhas do provedor antes que qualquer saída LLM seja exposta.

Parâmetros

Parâmetro
Tipo

error

unknown

Devoluções

boolean

isSessionFinishRequested()

function isSessionFinishRequested(): boolean;

Devoluções

boolean

jsonSafeMetadata()

function jsonSafeMetadata(value, depth?): Record<string, JsonValue> | undefined;

Copie os metadados do fornecedor em valores seguros para JSON ou indefinidos.

Parâmetros

Parâmetro
Tipo
Valor padrão

value

unknown

undefined

depth

number

0

Devoluções

Record <string, `JsonValue <#jsonvalue>`__> | undefined

loadRuntimeAgentConfig()

function loadRuntimeAgentConfig(configPath?, envVars?): RuntimeAgentConfig;

Carregue e valide agent.yaml para uso em tempo de execução.

Os arquivos ausentes são tratados como uma configuração vazia, portanto, os testes de unidade e o uso ad-hoc do SDK ainda podem construir App/TenantRuntime fora dos ambientes de tempo de execução gerados. Quando um arquivo existe, o tempo de execução valida os campos que ele possui diretamente (ponto de entrada/recursos) enquanto passa o bloco config de propriedade do aplicativo como dados brutos.

envVars é o mapeamento de substituição usado para resolver referências ${VAR} em caminhos YAML permitidos (atualmente mcp.servers.*.url). Passe o subconjunto de propriedade do locatário do ambiente do processo — via tenantEnvVars() — nunca process.env bruto, então o locatário agent.yaml não pode desreferenciar segredos de plataforma. Quando envVars é undefined e uma referência ${...} está presente em um caminho da lista de permissões, o carregador lança o carregador de forma que a configuração incorreta fique visível em vez de cair para new URL() com a string literal.

Parâmetros

Parâmetro
Tipo

configPath?

string

envVars?

Record <string, string>

Devoluções

`RuntimeAgentConfig <#runtimeagentconfig>`__

logCachedResult()

function logCachedResult(
   toolName,
   step,
   prefix?
): void;

Registre que um resultado em cache está sendo usado (cenário de repetição).

Parâmetros

Parâmetro
Tipo
Valor padrão

toolName

string

undefined

step

number

undefined

prefix

string

"TOOL"

Devoluções

void

logExecutionCallback()

function logExecutionCallback(
   executionId,
   status,
   result?,
   error?,
   suspendReason?,
   prefix?
): void;

Registre um chamada de resposta de execução (conclusão/ suspensão/erro).

Parâmetros

Parâmetro
Tipo
Valor padrão

executionId

string

undefined

status

string

undefined

result

unknown

null

error

string | null

null

suspendReason

string | null

null

prefix

string

"OE"

Devoluções

void

logExecutionStart()

function logExecutionStart(
   executionId,
   inputKeys,
   prefix?
): void;

Registre o início de uma execução.

Parâmetros

Parâmetro
Tipo
Valor padrão

executionId

string

undefined

inputKeys

string []

undefined

prefix

string

"OE"

Devoluções

void

logLLMMesages()

function logLLMMessages(
   messages,
   prefix?,
   countOnly?
): void;

Registre as mensagens de conversa do LLM em um formato consistente.

Parâmetros

Parâmetro
Tipo
Valor padrão
Descrição

messages

unknown []

undefined

Lista de dicionários de mensagens ou objetos de mensagem LangChain

prefix

string

"LLM"

Prefixo da linha de registro (por exemplo, "OE", "LLM", "AER")

countOnly

boolean

false

Se true, somente registre a contagem de mensagens (para o nível de informação)

Devoluções

void

logLLMResponse()

function logLLMResponse(
   result,
   step,
   prefix?
): void;

Registre uma resposta LLM em um formato consistente.

Parâmetros

Parâmetro
Tipo
Valor padrão
Descrição

result

unknown

undefined

Resposta LLM (dic ou AIMessage)

step

number

undefined

Número do passo

prefix

string

"LLM"

Prefixo da linha de registro

Devoluções

void

logPolicyBlocked()

function logPolicyBlocked(
   toolName,
   step,
   reason,
   prefix?
): void;

Registre que uma chamada de ferramenta foi bloqueada pela política.

Parâmetros

Parâmetro
Tipo
Valor padrão

toolName

string

undefined

step

number

undefined

reason

string

undefined

prefix

string

"TOOL"

Devoluções

void

logSection()

function logSection(): void;

Registre um separador de seção principal (para limites de execução).

Devoluções

void

logSeparator()

function logSeparator(): void;

Registre um separador de seção menor (para operações individuais).

Devoluções

void

logToolRequest()

function logToolRequest(
   toolName,
   args,
   step,
   prefix?,
   fieldsToRedact?
): void;

Registre uma solicitação de execução da ferramenta.

Parâmetros

Parâmetro
Tipo
Valor padrão
Descrição

toolName

string

undefined

Nome da ferramenta

args

Record <string, unknown>

undefined

Argumentos da ferramenta

step

number

undefined

Número do passo

prefix

string

"TOOL"

Prefixo da linha de registro

fieldsToRedact

somente leitura string []

[]

Política de campos sensíveis do catálogo. Os campos correspondentes omitem até mesmo seus metadados de tipo/comprimento; nenhum valor é registrado.

Devoluções

void

logToolResult()

function logToolResult(
   toolName,
   step,
   status,
   result?,
   error?,
   durationMs?,
   prefix?
): void;

Registre um resultado de execução da ferramenta.

Parâmetros

Parâmetro
Tipo
Valor padrão
Descrição

toolName

string

undefined

Nome da ferramenta

step

number

undefined

Número do passo

status

string

undefined

Status da execução (sucesso, erro, suspender, interrompido)

result

unknown

null

Resultado da ferramenta

error

string | null

null

Mensagem de erro se falhar

durationMs

number

0

Duração da execução em milissegundos

prefix

string

"TOOL"

Prefixo da linha de registro

Devoluções

void

getMcpClientCredentialsAuth()

function makeMcpClientCredentialsAuth(
   serverName,
   config,
   cacheDir?
): OAuthClientProvider;

Retornar um provedor OAuth de credenciais de cliente para um servidor MCP configurado.

cacheDir substitui mcpOauthCacheDir() — usado por testes e qualquer chamador que precise de um local de cache isolado em vez do diretório de cache compartilhado agentengine dev.

Parâmetros

Parâmetro
Tipo

serverName

string

config

{ allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }

config.allowed_tools

string [] | null

config.auth?

{ client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }

config.auth.client_id_env?

string | null

config.auth.client_name?

string | null

config.auth.client_secret_env?

string | null

config.auth.redirect_uri?

string | null

config.auth.scope?

string | null

config.auth.token_env?

string | null

config.auth.token_url?

string | null

config.auth.type?

"none" | "bearer_env" | "oauth" | "client_credentials"

config.headers?

Record <string, string>

config.timeout_seconds?

number

config.transport?

"streamable_http"

config.url?

string

cacheDir?

string

Devoluções

OAuthClientProvider

MakeMcpOauthAuth()

function makeMcpOauthAuth(
   serverName,
   config,
   cacheDir?
): OAuthClientProvider;

Retorne um provedor OAuth não interativo para um servidor MCP configurado.

cacheDir substitui mcpOauthCacheDir() — usado por testes e qualquer chamador que precise de um local de cache isolado em vez do diretório de cache compartilhado agentengine dev.

Parâmetros

Parâmetro
Tipo

serverName

string

config

{ allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }

config.allowed_tools

string [] | null

config.auth?

{ client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }

config.auth.client_id_env?

string | null

config.auth.client_name?

string | null

config.auth.client_secret_env?

string | null

config.auth.redirect_uri?

string | null

config.auth.scope?

string | null

config.auth.token_env?

string | null

config.auth.token_url?

string | null

config.auth.type?

"none" | "bearer_env" | "oauth" | "client_credentials"

config.headers?

Record <string, string>

config.timeout_seconds?

number

config.transport?

"streamable_http"

config.url?

string

cacheDir?

string

Devoluções

OAuthClientProvider

makeMcpSdkToolName()

function makeMcpSdkToolName(serverName, toolName): string;

Retorne o nome SDK prefixado do servidor para uma ferramenta MCP remota.

Parâmetros

Parâmetro
Tipo

serverName

string

toolName

string

Devoluções

string

getMcpToolCallable()

function makeMcpToolCallable(binding): (args) => Promise<MCPToolResult>;

Crie o callable assíncrono usado para invocar uma ferramenta MCP descoberta.

Parâmetros

Parâmetro
Tipo

binding

`MCPToolBinding <#mcptoolbinding>`__

Devoluções

(args) => Promise <`MCPToolResult <#mcptoolresult>`__>

materializeMcpOauthSecretCache()

function materializeMcpOauthSecretCache(__namedParameters?): Promise<number>;

Estabeleça o cache de tempo de execução gravável e decodifique segredos MCP OAuth nele.

Define AGENTIC_MCP_OAUTH_DIR (se não estiver definido) para que o leitor em mcp_oauth.ts resolva o mesmo diretório. Retorna o número de segredos materializados.

Parâmetros

Parâmetro
Tipo

__namedParameters

MaterializeOptions

Devoluções

Promise <number>

mcpOauthCacheDir()

function mcpOauthCacheDir(): string;

Diretório de cache, resolvido no momento da chamada — não uma constante em nível de módulo.

materializeMcpOauthSecretCache() (em mcp_oauth_secret.ts) define AGENTIC_MCP_OAUTH_DIR na inicialização. Uma const de tempo de importação congelada capturaria o valor anterior que é executado sempre que esse módulo for importado primeiro (por exemplo, por meio do barril do pacote ), para que o leitor e o gravador possam resolver em diretórios diferentes. A leitura do ambiente em cada chamada as mantém em passo a passo, independentemente da ordem de importação.

Devoluções

string

mcpOauthCacheName()

function mcpOauthCacheName(serverName, serverUrl): string;

Retorne um nome de base de cache livre de colisões com escopo para alias e endpoint. agente.yaml não impõe nenhum conjunto de caracteres em aliases, portanto, a exclusividade vem do hash do alias bruto sempre que o formulário legível perderia informações e do hash de endpoint que impede que o mesmo alias compartilhe credenciais em diferentes servidores MCP.

Parâmetros

Parâmetro
Tipo

serverName

string

serverUrl

string

Devoluções

string

mcpServerNetworkHosts()

function mcpServerNetworkHosts(config): string[];

Retorne os hosts de saída necessários para acessar um servidor MCP configurado.

Parâmetros

Parâmetro
Tipo

config

{ allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }

config.allowed_tools

string [] | null

config.auth

{ client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }

config.auth.client_id_env

string | null

config.auth.client_name

string | null

config.auth.client_secret_env

string | null

config.auth.redirect_uri

string | null

config.auth.scope

string | null

config.auth.token_env

string | null

config.auth.token_url

string | null

config.auth.type

"none" | "bearer_env" | "oauth" | "client_credentials"

config.headers

Record <string, string>

config.timeout_seconds

number

config.transport

"streamable_http"

config.url

string

Devoluções

string []

mesclarTokenUsage()

function mergeTokenUsage(existing, incoming): LLMTokenUsage | undefined;

Uso do fluxo de mesclagem campo a campo; campos não nulos de entrada vencem.

Parâmetros

Parâmetro
Tipo

existing

`LLMTokenUsage <#llmtokenusage>`__ | undefined

incoming

unknown

Devoluções

`LLMTokenUsage <#llmtokenusage>`__ | undefined

newDurabilityOwnerId()

function newDurabilityOwnerId(): string;

Devoluções

string

normalizeContent()

function normalizeContent(content): string;

Normalize o conteúdo da mensagem LLM para uma string.

O conteúdo do LLM pode ser: - Uma string (texto normal) - Uma lista (conteúdo multimodal com texto e outras partes) - nulo/indefinido ou vazio

Isso lida com casos em que o AIMessageChunk.content do LangChain é uma lista de blocos de conteúdo (por exemplo, de respostas multimodais da Gêmeos) em vez de uma string simples.

Parâmetros

Parâmetro
Tipo
Descrição

content

unknown

O conteúdo para normalizar (string, lista ou nulo/indefinido)

Devoluções

string

Uma representação de string do conteúdo

normalizeLLMPodInvokeResponse()

function normalizeLLMPodInvokeResponse(resp): object;

Sincronize usage e result.usage em um LLMPodInvokeResponse analisado, espelhando o model_validator _sync_usage_with_result do Python.

  • Se result.usage não estiver definido e usage estiver presente, retorna uma nova resposta cujo resultado carrega o uso de nível superior.

  • Se usage estiver desconfigurado e result.usage estiver presente, levanta esse result.usage para o nível superior.

Retorna a resposta (possivelmente com um result/usage recém-criado).

Parâmetros

Parâmetro
Tipo
Descrição

resp

{ duration_ms: number; error?: string; error_code?: string; pod_name: string; result?: { [key: string]: unknown; additional_kwargs?: Record <string, unknown>; content: string; id?: string; metadata?: Record <string, unknown>; name?: string; response_metadata?: Record <string, unknown>; tool_calls?: unknown []; usage?: Record <string, unknown>; }; status: string; usage?: `LLMTokenUsage <#llmtokenusage>`__; }

resp.duration_ms

number

Duração da execução em milissegundos.

resp.error?

string

Mensagem de erro se falhar.

resp.error_code?

string

Classificação de falha legível por máquina (por exemplo, llm_credential_rejected).

resp.pod_name

string

Nome do host/pod onde o LLM foi executado.

resp.result?

{ [key: string]: unknown; additional_kwargs?: Record <string, unknown>; content: string; id?: string; metadata?: Record <string, unknown>; name?: string; response_metadata?: Record <string, unknown>; tool_calls?: unknown []; usage?: Record <string, unknown>; }

Resultado LLM com conteúdo, tool_calls e uso.

resp.result.additional_kwargs?

Record <string, unknown>

resp.result.content

string

resp.result.id?

string

resp.result.metadata?

Record <string, unknown>

resp.result.name?

string

resp.result.response_metadata?

Record <string, unknown>

resp.result.tool_calls?

unknown []

resp.result.usage?

Record <string, unknown>

resp.status

string

Status de execução: sucesso, erro.

resp.usage?

`LLMTokenUsage <#llmtokenusage>`__

Token usage (input_tokens, output_tokens, total_tokens).

Devoluções

Nome
Tipo
Descrição

duration_ms

number

Duração da execução em milissegundos.

error?

string

Mensagem de erro se falhar.

error_code?

string

Classificação de falha legível por máquina (por exemplo, llm_credential_rejected).

pod_name

string

Nome do host/pod onde o LLM foi executado.

result?

object

Resultado LLM com conteúdo, tool_calls e uso.

result.additional_kwargs?

Record <string, unknown>

result.content

string

result.id?

string

result.metadata?

Record <string, unknown>

result.name?

string

result.response_metadata?

Record <string, unknown>

result.tool_calls?

unknown []

result.usage?

Record <string, unknown>

status

string

Status de execução: sucesso, erro.

usage?

`LLMTokenUsage <#llmtokenusage>`__

Token usage (input_tokens, output_tokens, total_tokens).

normalizeMcpToolResult()

function normalizeMcpToolResult(result): MCPToolResult;

Converta um MCP CallToolResult em um resultado JSON-safe, criando um resultado de erro.

Parâmetros

Parâmetro
Tipo

result

{ content?: unknown []; isError?: boolean; structuredContent?: unknown; }

result.content?

unknown []

result.isError?

boolean

result.structuredContent?

unknown

Devoluções

`MCPToolResult <#mcptoolresult>`__

normalizeOptionalStr()

function normalizeOptionalStr(value): string | null;

Apara um valor de metadados de ferramenta de string, recolhendo em branco/não string para nulo.

Compartilhados pelo código de encapsulamento da ferramenta dos SDKs da estrutura, os valores de metadados escritos como "" ou "" são tratados da mesma forma que ausentes, em vez de serem enviados ao OE como uma string de aparência não vazia, mas sem significado.

Parâmetros

Parâmetro
Tipo

value

unknown

Devoluções

string | null

normalizeToolCallArgs()

function normalizeToolCallArgs(args): string | null;

Normalize os argumentos de chamada de ferramenta transmitidos na carga útil da string de formato de fio.

Parâmetros

Parâmetro
Tipo

args

unknown

Devoluções

string | null

notaCheckpointWireWorkspaceId()

function noteCheckpointWireWorkspaceId(wireWorkspaceId?): void;

Lembre-se do fio workspace_id de /execute para leituras de query.

As rotas de query não carregam identificador de espaço de trabalho; quando APP_ID não está definido, o caminho de leitura retorna ao valor de fio observado mais recentemente.

Parâmetros

Parâmetro
Tipo

wireWorkspaceId?

string | null

Devoluções

void

observedActivityPositions()

function observedActivityPositions(stepOrdinal): ActivityPosition[];

Parâmetros

Parâmetro
Tipo

stepOrdinal

number

Devoluções

`ActivityPosition <#activityposition>`__ []

oeStreamRetryDelayMs()

function oeStreamRetryDelayMs(retryAfterMs?): number;

Respeite um SSE fornecido pelo servidor retry_after_ms, capped. Ausente significa tentar novamente imediatamente.

Parâmetros

Parâmetro
Tipo

retryAfterMs?

number | null

Devoluções

number

preallocateActivityOrdinals()

function preallocateActivityOrdinals(keys): number[];

Parâmetros

Parâmetro
Tipo

keys

somente leitura string []

Devoluções

number []

pré-alocarCriançasOperationOrdinals()

function preallocateChildOperationOrdinals(boundaries): number[];

Parâmetros

Parâmetro
Tipo

boundaries

readonly `ChildOperationBoundary <#childoperationboundary>`__ []

Devoluções

number []

projectScopingRequired()

function projectScopingRequired(): boolean;

Se um PROJECT_ID vazio deve falhar fechado (REQUIRE_PROJECT_SCOPED_DB).

O ECP marca esse sinalizador em pods de AER gerenciados (onde PROJECT_ID é sempre injetado), de modo que um PROJECT_ID vazio falhe fechado em vez de ser gravado silenciosamente no armazenamento sem escopo. O desenvolvimento de CLI local deixa o sinalizador por definir e usa o nome sem escopo.

Devoluções

boolean

citaçõesPathSegment()

function quotePathSegment(value): string;

Codifique por cento um segmento de caminho; rejeitar separadores e . / ...

Decodifique repetidamente antes de aspas as formas transversais codificadas, codificadas duas vezes e mistas não podem sobreviver a uma decodificação de roteamento posterior.

Parâmetros

Parâmetro
Tipo

value

string

Devoluções

string

recordCurrentMemoryMetadata()

function recordCurrentMemoryMetadata(args): void;

Anexe metadados de memória explícitos à etapa de execução atual, se houver. Muta o objeto de metadados no local (correspondendo ao comportamento Python).

Parâmetros

Parâmetro
Tipo

args

`RecordMemoryMetadataArgs <#recordmemorymetadataargs>`__

Devoluções

void

recordInterruptedActivity()

function recordInterruptedActivity(command, controlFlow): void;

Parâmetros

Parâmetro
Tipo

command

`ActivityCommand <#atividadecommand>`__

controlFlow

unknown

Devoluções

void

recordLatency()

function recordLatency<T>(
   operation,
   fn,
   labels?
): Promise<T>;

Execute fn e registre sua duração de relógio de parede como uma métrica de latência. Propagação de erros; sua duração ainda está registrada.

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

operation

string

fn

() => T | Promise <T>

labels

Record <string, string>

Devoluções

Promise <T>

recordObservedActivity()

function recordObservedActivity(position): void;

Parâmetros

Parâmetro
Tipo

position

`ActivityPosition <#activityposition>`__

Devoluções

void

recordReconstructedActivityInterrupt()

function recordReconstructedActivityInterrupt(activityId): number;

Parâmetros

Parâmetro
Tipo

activityId

string

Devoluções

number

recordSuspendRequest()

function recordSuspendRequest(payload): void;

Registre uma suspensão HITL planejada pelo autor para a chamada de ferramenta atual. Chamado apenas por suspendPayloadToJson, então a procedência do sinal é o código do autor da ferramenta, não os dados do resultado da ferramenta. Lê storage.getStore() diretamente, de modo que uma chamada fora de uma execução é um no-op em vez de mutar o fallback congelado.

Parâmetros

Parâmetro
Tipo

payload

Record <string, unknown>

Devoluções

void

redactFields()

function redactFields(data, fieldsToRedact): Record<string, unknown>;

Edite campos confidenciais de um registro de argumentos.

Retorna uma cópia com cada campo listado substituído por “[REDACTED]”; campos não listados passam inalterados e uma lista vazia retorna a entrada como está.

Parâmetros

Parâmetro
Tipo

data

Record <string, unknown>

fieldsToRedact

somente leitura string []

Devoluções

Record <string, unknown>

registrarBuiltinTools()

function registerBuiltinTools(runtime): void;

Registre todos os manipuladores de ferramentas integradas no tempo de execução (pesquisa de chamada + metadados para todos os manipuladores 8). Chamado por ToolServer.onStartup quando features.deep_agent está ativado.

Se um usuário @app.tool() registrar uma ferramenta com um nome integrado reservado, isso registrará um AVISO e o substituirá pelo integrado — sem o aviso, a colisão era silenciosa e aparecia somente quando o integrado era invocado.

Parâmetros

Parâmetro
Tipo

runtime

`ITenantRuntime <#itenantruntime>`__

Devoluções

void

registrarGuardrailPolicyEngine()

function registerGuardrailPolicyEngine(engine): void;

Parâmetros

Parâmetro
Tipo

engine

`GuardrailPolicyEngine <#guardrailpolicyengine>`__

Devoluções

void

registrarInstrumentor()

function registerInstrumentor(fn): void;

Parâmetros

Parâmetro
Tipo

fn

`Instrumentor <#instrumentor>`__

Devoluções

void

registrarLlm()

function registerLlm(llmId, llm): void;

Registre um LLM por id. Lança ID duplicado.

Os SDKs de framework chamam isso de app.llm() para cada LLM que o agente usa. O caso de conveniência sem nome-LLM é representado pelo registro sob o ID sentido "__default__"; , portanto, uma segunda chamada não nomeada gera o mesmo erro de ID duplicado que uma segunda chamada nomeada com o mesmo ID.

Parâmetros

Parâmetro
Tipo

llmId

string

llm

unknown

Devoluções

void

registrarLLMAdapterFactory()

function registerLLMAdapterFactory(factory): void;

Parâmetros

Parâmetro
Tipo

factory

`LLMAdapterFactory <#llmadapterfactory>`__

Devoluções

void

registerQueryPlugin()

function registerQueryPlugin(plugin): void;

Registre o AERQueryPlugin do adaptador de framework.

Mirror TenantRuntime.register_query_plugin do Python. As rotas /query/sessions do AER retornam 501 até que um plugin seja registrado.

Parâmetros

Parâmetro
Tipo

plugin

`AERQueryPlugin <#aerqueryplugin>`__

Devoluções

void

registrarRegexGuardrailPolicyEngine()

function registerRegexGuardrailPolicyEngine(): void;

Devoluções

void

registrarSuspendHandler()

function registerSuspendHandler(handler): void;

Parâmetros

Parâmetro
Tipo

handler

`SuspendHandler <#suspendhandler>`__

Devoluções

void

registrarWorkflowAdapter()

function registerWorkflowAdapter(name, version): void;

Declare que o gráfico materializado suporta roteamento de fluxo de trabalho durável OE.

Chame isso ou clearWorkflowAdapter em cada materialização getAgent() para que um gráfico inelegível posterior não possa reutilizar a identidade da solicitação anterior.

Parâmetros

Parâmetro
Tipo

name

string

version

string

Devoluções

void

reportOeOwnerUrlFailure()

function reportOeOwnerUrlFailure(): void;

Marque o URL do proprietário da execução atual como inutilizável. Unidirecional: depois disso, getCurrentOeOwnerUrl retorna nulo para o resto da execução, de modo que as gravações repetidas parem de pagar novamente o tempo limite de pré-tentativa contra um proprietário morto. Lê storage.getStore() diretamente (como recordSuspendRequest) de modo que uma chamada fora de uma execução seja um no-op em vez de mutar o fallback congelado.

Devoluções

void

reportOeResult()

function reportOeResult(args): Promise<void>;

Relatar um resultado de execução e exigir que a OE confirme a resolução.

Iniciado como a extensão ativa antes de getCurrentTraceContext() ser lido abaixo, então o rastreamento_id/span_id colocado no fio reflete essa extensão. Sem uma extensão aqui, um OE de reconhecimento lento (ou uma nova tentativa de acordo) é invisível: a extensão do nó da ferramenta ao redor parece mais lenta, sem registro de quantas tentativas aconteceram.

Parâmetros

Parâmetro
Tipo

args

`ReportOeResultArgs <#reportoeresultargs>`__

Devoluções

Promise <void>

requestOeApproval()

function requestOeApproval(args): Promise<{
  cached_result?: unknown;
  duration_ms?: number | null;
  elicitation?:   | {
     authorization_url: string;
     created: boolean;
     elicitation_id: string;
     message: string;
   }
     | null;
  error?: string | null;
  error_code?: string | null;
  from_cache: boolean;
  guardrail_meta?:   | {
     guardrail_category: string;
     guardrail_id: string;
   }
     | null;
  latest_step_number?: number | null;
  pod_name?: string | null;
  proceed: boolean;
  reason?: string | null;
  result?: unknown;
  retryable: boolean;
  route_to?: string | null;
  status?: string | null;
  tool_api_error?:   | {
     classification: string;
     error_code?: string | null;
     http_status?: number | null;
     provider_type?: string | null;
     reason?: string | null;
     retryable: boolean;
   }
     | null;
}>;

Solicite a aprovação da OE antes de executar uma chamada de ferramenta/LLM. Qualquer erro de HTTP ou de rede torna-se PolicyDeniedException — à prova de falhas.

Parâmetros

Parâmetro
Tipo

args

`RequestOeApprovalArgs <#requestoeapprovalargs>`__

Devoluções

Promise <{ cached_result?: unknown; duration_ms?: number | null; elicitation?: | { authorization_url: string; created: boolean; elicitation_id: string; message: string; } | null; error?: string | null; error_code?: string | null; from_cache: boolean; guardrail_meta?: | { guardrail_category: string; guardrail_id: string; } | null; latest_step_number?: number | null; pod_name?: string | null; proceed: boolean; reason?: string | null; result?: unknown; retryable: boolean; route_to?: string | null; status?: string | null; tool_api_error?: | { classification: string; error_code?: string | null; http_status?: number | null; provider_type?: string | null; reason?: string | null; retryable: boolean; } | null; }>

requestSessionFinish()

function requestSessionFinish(): SessionFinishStatus;

Registre que o agente considera esta sessão encerrada. Lê diretamente fora de storage.getStore() (não current()), portanto, uma chamada fora de uma execução relata "indisponível" sem nunca tocar no fallback EMPTY_STORE congelado. wrapper é nulo para contextos do Pod da Ferramenta / Função (consulte servidor/tool.ts, servidor/function.ts) - somente o AER mantém a trava de finalização, então esses contextos também devem relatar "indisponível" em vez de um sucesso enganoso.

Devoluções

`SessionFinishStatus <#sessionfinishstatus>`__

reinício do CheckpointWorkspaceState()

function resetCheckpointWorkspaceState(): void;

assistente de teste — redefine o estado do módulo entre os casos.

Devoluções

void

reinicializarHooks()

function resetHooks(): void;

Devoluções

void

reinicializarLlmRegistry()

function resetLlmRegistry(): void;

Devoluções

void

reinício do armazenamentoDbCache()

function resetStoreDbCache(): void;

Limpe os nomes de banco de dados de armazenamento resolvidos memoizados (test seam).

Devoluções

void

resolveCheckpointWorkspaceId()

function resolveCheckpointWorkspaceId(wireWorkspaceId?): string | null;

Resolva o escopo do espaço de trabalho usado para o checkpoint LangGraph thread_ids.

Parâmetros

Parâmetro
Tipo

wireWorkspaceId?

string | null

Devoluções

string | null

resolveConfiguredMcpToolBinding()

function resolveConfiguredMcpToolBinding(
   config,
   sdkToolName,
   mcpServerName,
   mcpToolName
): MCPToolBinding | null;

Mapeie um nome de ferramenta visível do SDK de volta para os metadados de chamada MCP configurados.

O AER descobre esquemas MCP remotos na inicialização e expõe nomes prefixados do servidor, como github__search_issues, ao LLM. Os Pods de ferramentas ignoram a descoberta da inicialização tools/list, portanto, a execução em tempo de chamada resolve esse nome SDK em relação a agent.yaml e chama o nome original da ferramenta MCP.

Parâmetros

Parâmetro
Tipo

config

{ servers: Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>; }

config.servers

Record <string, { allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }>

sdkToolName

string

mcpServerName

string

mcpToolName

string

Devoluções

`MCPToolBinding <#mcptoolbinding>`__ | null

resolveEfetiveDb()

function resolveEffectiveDb(
   client,
   base,
   projectId,
   opts?
): Promise<string>;

Resolva o base em relação ao cluster ativo via listDatabaseNames.

projectId vazio é lançado quando o escopo é necessário (required, padrão para projectScopingRequired), caso contrário avisa e retorna base. Uma falha de listagem gera um erro transitório que não pode criar um banco de dados concorrente de nome atual ao lado de um banco de legado existente. legacyBases são padrões anteriores cujos formulários com escopo de projeto e, em seguida, formulários simples, são aceitos antes que um novo banco de dados com escopo seja criado.

Parâmetros

Parâmetro
Tipo

client

ListsDatabaseNames

base

string

projectId

string

opts

{ label?: string; legacyBases?: string []; required?: boolean; }

opts.label?

string

opts.legacyBases?

string []

opts.required?

boolean

Devoluções

Promise <string>

resolveEntrypoint()

function resolveEntrypoint(): ResolvedEntrypoint;

Analise AGENT_ENTRYPOINT em { modulePath, exportName }.

Sai do processo com EXIT_NO_ENTRYPOINT se a env var não estiver definida ou estiver malformada — corresponde ao código de saída equivalente do Python _resolve_entrypoint. Exportado para que os testes possam gerar isso em um subprocesso e afirmar o código de saída / stderr.

Devoluções

`ResolvedEntrypoint <#resolvedentrypoint>`__

resolveImportTarget()

function resolveImportTarget(modulePath, agentRoot?): string;

Resolva um caminho de módulo AGENT_ENTRYPOINT para um valor que a import() dinâmica do nó possa carregar.

A plataforma faz o agent.yaml entrypoint literalmente em AGENT_ENTRYPOINT (o mesmo contrato do lançador do Python), de modo que o formato comum seja um caminho de módulo pontilhado no estilo Python - por exemplo, agent_pkg.main - que mapeia para a saída compilada do agente <agentRoot>/dist/agent_pkg/main.js. O nó ESM import() trata uma string pontilhada como um especificador de pacote simples e não consegue resolvê-la, portanto, a traduzimos aqui: pontos → separadores de caminho, no diretório dist/ compilado, com um sufixo .js, retornados como file:// URL (o formulário portátil para importar um caminho absoluto entre plataformas).

agentRoot O padrão é process.cwd(), que, no tempo de execução, é a raiz do pacote do agente : o Dockerfile gerado define WORKDIR como o destino de instalação e o CMD executa o iniciador a partir dali. É injetado para testes.

Um valor que já é diretamente importável — um caminho relativo, um caminho absoluto ou qualquer especificador com caminho (aquele que contenha um /) — é retornado inalterado, então um ponto de entrada pré-resolvido (ou um teste que passa por um arquivo absoluto caminho) ainda funciona e nunca é traduzido duas vezes. Um sinal de forma de caminho (não uma extensão de arquivo) é usado deliberadamente: um caminho de módulo pontilhado cujo segmento final é js/mjs/cjs (por exemplo, agent_pkg.cjs) ainda deve ser traduzido, não confundido com um arquivo já importável.

Parâmetros

Parâmetro
Tipo

modulePath

string

agentRoot

string

Devoluções

string

resolveListenHost()

function resolveListenHost(): string;

Resolva o host de escuta de APP_HOST, padronizando para "0.0.0.0".

Corresponde ao _resolve_listen_host do Python: o ECP carimbos APP_HOST por tipo de executor no momento da implementação ("::" para o modo vm, "0.0.0.0" para o modo container). Uma string vazia normaliza para o padrão — um shell que exporta APP_HOST="" não deve se vincular a "".

Devoluções

string

resolveMcpAuth()

function resolveMcpAuth(serverName, config): Promise<OAuthClientProvider | undefined>;

Resolva um fornecedor MCP SDK OAuth para o modo de autenticação configurado, se houver.

Parâmetros

Parâmetro
Tipo

serverName

string

config

{ allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }

config.allowed_tools

string [] | null

config.auth

{ client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }

config.auth.client_id_env

string | null

config.auth.client_name

string | null

config.auth.client_secret_env

string | null

config.auth.redirect_uri

string | null

config.auth.scope

string | null

config.auth.token_env

string | null

config.auth.token_url

string | null

config.auth.type

"none" | "bearer_env" | "oauth" | "client_credentials"

config.headers

Record <string, string>

config.timeout_seconds

number

config.transport

"streamable_http"

config.url

string

Devoluções

Promise <OAuthClientProvider | undefined>

resolveMcpHeaders()

function resolveMcpHeaders(serverName, config): Record<string, string>;

Resolva cabeçalhos para um servidor MCP remoto sem expor valores secretos na configuração.

Parâmetros

Parâmetro
Tipo

serverName

string

config

{ allowed_tools: string [] | null; auth: { client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }; headers: Record <string, string>; timeout_seconds: number; transport: "streamable_http"; url: string; }

config.allowed_tools

string [] | null

config.auth

{ client_id_env: string | null; client_name: string | null; client_secret_env: string | null; redirect_uri: string | null; scope: string | null; token_env: string | null; token_url: string | null; type: "none" | "bearer_env" | "oauth" | "client_credentials"; }

config.auth.client_id_env

string | null

config.auth.client_name

string | null

config.auth.client_secret_env

string | null

config.auth.redirect_uri

string | null

config.auth.scope

string | null

config.auth.token_env

string | null

config.auth.token_url

string | null

config.auth.type

"none" | "bearer_env" | "oauth" | "client_credentials"

config.headers

Record <string, string>

config.timeout_seconds

number

config.transport

"streamable_http"

config.url

string

Devoluções

Record <string, string>

resolveOeUrl()

function resolveOeUrl(requested, env?): string;

Retorna a URL base do OE a ser usada para chamadas de resposta durante uma execução.

O próprio OE_URL do executor ganha sempre que é configurado. Um valor de solicitação diferente é descartado e registrado em vez de honrado — ignorá-lo silenciosamente ocultaria uma tentativa de sequestro.

Quando OE_URL não está definido, o valor solicitado é usado. Esse é o agentengine dev local e o caminho do teste unitário, onde não existe nenhum ambiente de tempo de implantação e a solicitação é originada da própria pilha do desenvolvedor; um aviso é emitido para que a configuração mais fraca fique visível.

Parâmetros

Parâmetro
Tipo
Valor padrão

requested

string

undefined

env

ProcessEnv

process.env

Devoluções

string

resolveProjectScopedDb()

function resolveProjectScopedDb(
   base,
   projectId,
   existing,
   legacyBases?
): string;

Derivar o nome do banco de dados efetivo para base com escopo para projectId.

  1. projectId vazio -> retornam base inalterados.

  2. base já termina com _{projectId} -> retornar como está (idempotente).

  3. scoped = base + "_" + projectId:

    • scoped existe no cluster -> use-o.

    • mais um candidato a legacyBases com escopo existente -> use-o.

    • mais um candidato a legacyBases sem escopo existente -> use-o.

    • mais -> utilize scoped (fresco sistema).

O fallback sem escopo está limitado aos padrões de plataforma conhecidos. Os nomes de base e arbitrários atuais nunca são aceitos automaticamente.

Parâmetros

Parâmetro
Tipo
Valor padrão

base

string

undefined

projectId

string

undefined

existing

string []

undefined

legacyBases

string []

[]

Devoluções

string

resolveStoreDbName()

function resolveStoreDbName(client, base?): Promise<string>;

Retorne o nome do banco de dados de armazenamento com escopo por projeto, resolvido uma vez e armazenado em cache.

Aplica a mesma resolução que o OE usa (resolveEctiveDb) em relação ao cluster ativo, para que os gravadores do AER/SDK converjam para o mesmo banco de dados que o OE lê. base padroniza para getStoreDbName. Valores explícitos são retornados exatamente e ignoram a descoberta.

Parâmetros

Parâmetro
Tipo

client

MongoClient

base?

string

Devoluções

Promise <string>

runInstrumentor()

function runInstrumentor(): void;

Devoluções

void

runLauncher()

function runLauncher(): Promise<void>;

ponto de entrada invocado quando este arquivo é executado diretamente:

node /app/node_modules/@mongodb-js/agent-engine-runner-shared/dist/launcher.js

Sai do processo com o código de saída correspondente à categoria de falha (consulte EXIT_IMPORT_ERROR/EXIT_NO_ENTRYPOINT/EXIT_STARTUP_CRASH acima) em qualquer caminho de erro; resolve normalmente após a função de destino do usuário ou .run() retornar.

Devoluções

Promise <void>

runSerialActivity()

function runSerialActivity<T>(args): Promise<T>;

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo
Descrição

args

{ activityOrdinal: number; attempt?: `AttemptContext <#attemptcontext>`__; client: ActivityRuntimeClient; exclusive?: boolean; execute: (context) => T | Promise <T>; kind: `ActivityKind <#atividadetipo>`__; name: string; onActivityResolved?: `ActivityResolvedHook <#atividaderesolvedhook>`__ <T>; semanticInput: unknown; stepOrdinal?: number; }

args.activityOrdinal

number

args.attempt?

`AttemptContext <#attemptcontext>`__

args.client

ActivityRuntimeClient

args.exclusive?

boolean

Falso somente quando a estrutura tiver atribuído uma identidade de atividade estável.

args.execute

(context) => T | Promise <T>

args.kind

`ActivityKind <#activitykind>`__

args.name

string

args.onActivityResolved?

`ActivityResolvedHook <#atividaderesolvedhook>`__ <T>

args.semanticInput

unknown

args.stepOrdinal?

number

Devoluções

Promise <T>

runStreamingActivity()

function runStreamingActivity<T>(args): AsyncGenerator<T>;

Execute uma atividade durável em forma de gerador.

A repetição expande um resultado gravado de volta aos itens de transmissão sem executar o efeito. Um novo despacho produz itens ativos imediatamente e, em seguida, os envolve no único resultado terminal registrado pela OE. O fechamento do fluxo antecipado do terminal falha no despacho em vez de deixá-lo em operação.

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo
Descrição

args

{ activityOrdinal: number; attempt?: `AttemptContext <#attemptcontext>`__; client: ActivityRuntimeClient; exclusive?: boolean; execute: () => StreamingItems <T>; fold: (items) => unknown; kind: `ActivityKind <#atividadetipo>`__; name: string; onActivityResolved?: `ActivityResolvedHook <#atividaderesolvedhook>`__ <unknown>; replay: (result) => StreamingItems <T>; semanticInput: unknown; stepOrdinal?: number; }

args.activityOrdinal

number

args.attempt?

`AttemptContext <#attemptcontext>`__

args.client

ActivityRuntimeClient

args.exclusive?

boolean

Falso quando o chamador tiver atribuído uma identidade de atividade estável.

args.execute

() => StreamingItems <T>

args.fold

(items) => unknown

args.kind

`ActivityKind <#activitykind>`__

args.name

string

args.onActivityResolved?

`ActivityResolvedHook <#atividaderesolvedhook>`__ <unknown>

args.replay

(result) => StreamingItems <T>

args.semanticInput

unknown

args.stepOrdinal?

number

Devoluções

AsyncGenerator <T>

runWithAttemptContext()

function runWithAttemptContext<T>(attempt, fn): T;

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

attempt

`AttemptContext <#attemptcontext>`__

fn

() => T

Devoluções

T

runWithCallAbortSignal()

function runWithCallAbortSignal<T>(signal, fn): T;

Execute um corpo de ferramenta roteado com retorno de chamada com seu sinal de cancelamento por chamada anexado.

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

signal

AbortSignal

fn

() => T

Devoluções

T

runWithCustomerOrigin()

function runWithCustomerOrigin<T>(fn): T;

Marque a extensão dinâmica do código da ferramenta/ agente do cliente para atribuição de registro. Os escopos aninhados são não operacionais. A origem ausente não é classificada, não foi confirmada a autoria da plataforma.

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

fn

() => T

Devoluções

T

runWithExecutionContext()

function runWithExecutionContext<T>(args, fn): T;

Execute fn com um quadro de contexto de execução isolado.

storage.run cria um quadro filho que nunca altera o pai, portanto, a limpeza é automática mesmo que fn lance ou gere trabalho via setTimeout/Promise. Isso é equivalente ao set_execution_context(...) do Python seguido por uma tentativa/finalmente clear_execution_context(...).

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

args

`SetExecutionContextArgs <#setexecutioncontextargs>`__

fn

() => T

Devoluções

T

Exemplo

await runWithExecutionContext({ executionId, wrapper, oeUrl, userId }, async () => {
    await runAgentLogic()  // getCurrentUserId() works anywhere in this call chain
  })

runWithOperationPathResolver()

function runWithOperationPathResolver<T>(resolver, fn): T;

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

resolver

`OperationPathResolver <#operationpathresolver>'__

fn

() => T

Devoluções

T

runWithSuspendRequestContext()

function runWithSuspendRequestContext<T>(fn): T;

Execute uma chamada de ferramenta em processo com um marcador de suspensão isolado.

Parâmetros de tipo

Type Parameter

T

Parâmetros

Parâmetro
Tipo

fn

() => T

Devoluções

T

scrapCredentials()

function scrubCredentials(message): string;

Oculte as informações de usuário de qualquer URI mongodb:// / mongodb+srv:// incorporado em uma mensagem de erro de credencial (os erros de conexão e análise do driver refletem a string de conexão bruta).

A execução das informações do usuário é greedy até o ÚLTIMO '@' que um token em forma de host segue, portanto, as senhas que contêm um '@', espaço ou '/' sem escape ainda são totalmente ocultadas — o antigo padrão ://[^@\s]+@ interrompido no primeiro '@' e não poderia atravessar o espaço em branco, vazando a cauda da senha (ou todo o userinfo) para o coletor de registro centralizado. A execução é moderada para nunca cruzar o esquema de um segundo URI; quando o texto da mensagem após o URI contém seu próprio '@', a máscara pode se estender até ele — a redação excessiva é a direção de falha fechada, um vazamento não recuperável. Mantenha-se sincronizado com scrub_credentials no agent_engine_runner_shared/tracing/setup.py do Python.

Aceita unknown e coage: caminhos de erro entregam isso, independentemente do que uma rejeção carregue (arremessos de strings, objetos sem string message, indefinidos) — ele nunca deve se jogar, ou um armazenamento de rastreamento degradado se transforma em uma falha de inicialização.

Parâmetros

Parâmetro
Tipo

message

unknown

Devoluções

string

serializeInvokeLLMRequestArguments()

function serializeInvokeLLMRequestArguments(args): Record<string, unknown>;

Serialize InvokeLLMRequestArguments para a forma de fio snake_case, o equivalente ao model_dump(by_alias=True) do Python: - stop_sequences → stop (Pydantial serialization_alias="stop") e - cada mensagem é despejada camel→snake via serializeMessage.

Use isso ao enviar para um consumidor Python (OE/Pod de Ferramentas) que espera os campos de fio snake_case.

Parâmetros

Parâmetro
Tipo
Descrição

args

{ llm_id: string; messages: `Message <#message>`__ []; model: string; options?: `LLMInvocationOptions <#llmin preferenceoptions>`__; stop_sequences?: string []; stream: boolean; tool_choice?: `JsonValue <#jsonvalue>`__; tools?: `LLMToolSchema <#llmtoolschema>`__ []; }

args.llm_id

string

Identificador estável para a instância LLM registrada via app.llm({ llmId }); o pod de ferramentas resolve esse id em relação ao registro nomeado-LLM. As chamadas app.llm() sem nome são registradas sob o ID sentido "__default__". O padrão é "__default__" para compatibilidade com versões anteriores com chamadores que omitem esse campo.

args.messages

`Message <#message>`__ []

Conversation in sdk-coreMessage wire format.

args.model

string

Nome do modelo (por exemplo, `gpt-5.4-mini', 'gemini-3-flash-preview').

args.options?

`LLMInvocationOptions <#llmin preferenceoptions>`__

Opções explícitas de invocação de fornecedor/modelo (por exemplo, max_tokens).

args.stop_sequences?

string []

Pare as sequências encaminhadas ao provedor de LLM subjacente.

args.stream

boolean

Se o OE deve aprovar e rotear uma chamada invoca_llm de streaming real.

args.tool_choice?

`JsonValue <#jsonvalue>`__

Seleção forçada de ferramenta encaminhada para a chamada bind_tools do pod de ferramentas (por exemplo, um nome de função de withStructuredOutput). O LangChain traduz o valor em relação às ferramentas vinculadas.

args.tools?

`LLMToolSchema <#llmtoolschema>`__ []

Esquemas de ferramentas serializadas para bind_tools.

Devoluções

Record <string, unknown>

setActivityReconstructionIds()

function setActivityReconstructionIds(activityIds): void;

Parâmetros

Parâmetro
Tipo

activityIds

somente leitura string []

Devoluções

void

setPENDingChildOperationBatch()

function setPendingChildOperationBatch(boundaries): void;

Parâmetros

Parâmetro
Tipo

boundaries

readonly `ChildOperationBoundary <#childoperationboundary>`__ []

Devoluções

void

set TerminationLogPathForTest()

function setTerminationLogPathForTest(path): void;

Substituição somente de teste, espelhando setHomeDirForTest em error_reporting.ts.

Parâmetros

Parâmetro
Tipo

path

string

Devoluções

void

setupLogging()

function setupLogging(args?): Logger;

Configure o registrador raiz. Mirrors agent_engine_runner_shared.utils.setup_logging.

Quando STRUCTURED_LOGGING=true está definido, delega para installStructuredLogging para que toda a saída surja como JSON de linha única, correspondendo ao contrato do agente-log. O registro em disco não faz parte do modelo de produção — o Fluent Bit envia o container stdout para o S3, portanto, uma cópia duplicada não adiciona valor. A exceção é para o desenvolvimento local: quando AGENTIC_DEV_MODES está definido (somente para pilhas de composição de desenvolvimento), um coletor de arquivo giratório é anexado ao console/saída estruturada.

Ao contrário do setup_logging do Python, não precisamos descartar manualmente os manipuladores existentes antes de adicionar novamente o manipulador do console: log4js.configure substitui totalmente a configuração appenders/categories anterior em cada chamada, portanto, uma chamada repetida nunca acumula gravadores duplicados . Também não há nenhum risco de manipulador de proximidade de stdout/stderr contra o qual se proteger — o anexador stdout do log4js possui seu próprio caminho de gravação.

Parâmetros

Parâmetro
Tipo

args

`SetupLoggingArgs <#setuploggingargs>`__

Devoluções

Logger

setupTrating()

function setupTracing(args?): Promise<void>;

Parâmetros

Parâmetro
Tipo

args

`SetupTracingArgs <#setuptracingargs>`__

Devoluções

Promise <void>

shellExecute()

function shellExecute(args): Promise<Record<string, unknown>>;

Execute um comando shell e capture sua saída. De acordo com SandboxBackendProtocol.execute, otempo limite é null = "use o padrão do backend" (SHell_DEFAULT_TIMEOUT_SECONDS), e não "sem tempo limite".

Modelo de Ameaça: shell: true é intencional — os agentes precisam de pipes, redirecionamentos, globals. A sandbox é o próprio Pod da Ferramenta.

Lacuna de isolamento por sessão: ao contrário dos manipuladores do sistema de arquivos (que impõem o limite do espaço de trabalho por meio de verificações de realpath resolvePath() + isWithinWorkspace()), cwd aqui é apenas o diretório de trabalho padrão do shell gerado - o processo não é confinado ao sistema operacional, então Os caminhos ../absolute podem alcançar sessões de grupo ou caminhos de pod arbitrários. Trate como sessão compartilhada até que a sandbox do bucketwrap chegue. Não há porta de aprovação upstream na string de comando; trate o conteúdo como de autoria do agente. Isso significa que shell_execute NÃO corresponde ao isolamento do sistema de arquivos por sessão que os manipuladores fs impõem - um risco aceito e rastreado, não a validação de caminho local.

Tratamento de saída: stdout/stderr são drenados à medida que são transmitidos. Cada fluxo para de anexar quando SHell_OUTPUT_MAX_BYTES é capturado, mas o fluxo nunca é pausado, portanto, o filho nunca bloqueia em um pipe completo — um yes descontrolado executa até seu tempo limite sem OOMing o pod. A saída parcial é preservada no tempo limite. Os erros de estrutura (por exemplo, /bin/sh ausente) retornam exit_code = EXIT_CODE_FRAMEWORK_ERROR, diferente da seta de tempo limite.

Parâmetros

Parâmetro
Tipo

args

Record <string, unknown>

Devoluções

Promise <Record <string, unknown>>

shutdownTrating()

function shutdownTracing(): Promise<void>;

Devoluções

Promise <void>

snapshotLlmRegistry()

function snapshotLlmRegistry(): Map<string, unknown>;

Devolva uma cópia superficial do registro atual.

Devoluções

Map <string, unknown>

stripThinking()

function stripThinking(text): string;

Remova <think>...</think> blocos e <think> caudas não fechadas.

Parâmetros

Parâmetro
Tipo

text

string

Devoluções

string

subprocessOutputTail()

function subprocessOutputTail(exc): string;

O MAX_OUTPUT_TAIL_CHARS final do stdout+stderr de um subprocesso.

Parâmetros

Parâmetro
Tipo

exc

`SubprocessFailure <#subprocessfailure>`__

Devoluções

string

resumeSubprocessFailure()

function summarizeSubprocessFailure(exc): string;

Um resumo de uma linha de um subprocesso com falha: a etiqueta de comando e a linha mais significativa de sua saída, ou o código de saída quando nenhuma saída se destacar.

Parâmetros

Parâmetro
Tipo

exc

`SubprocessFailure <#subprocessfailure>`__

Devoluções

string

suspendPayloadToJson()

function suspendPayloadToJson(payload): string;

Serialize um SuspendPayload no marcador de fio de suspensão e registre uma solicitação de suspensão fora de banda no quadro de execução atual.

O Pod de Ferramentas honra a suspensão do sinal registrado — definido somente aqui, no código do próprio autor da ferramenta — não detectando o conteúdo do resultado da ferramenta, portanto, os dados não confiáveis que uma ferramenta transmite não podem mais forjar uma suspensão HITL. A string do marcador ainda é retornada inalterada para compatibilidade de conexão/replay.

Parâmetros

Parâmetro
Tipo
Descrição

payload

{ suspend_context: Record <string, unknown>; suspend_reason: string; }

payload.suspend_context

Record <string, unknown>

Contexto arbitrário que o revisor humano precisa tomar uma decisão.

payload.suspend_reason

string

Por que o agente está suspendendo (por exemplo, 'awaiting_Human_review').

Devoluções

string

tenantEnvVars()

function tenantEnvVars(source?): Record<string, string>;

Retorne o subconjunto de variáveis de ambiente de propriedade do locatário.

source padrão para process.env. Nomes em PLATFORM_ENV_VARS ou que correspondam a qualquer prefixo em PLATFORM_ENV_VAR_PREFIXES são excluídos, portanto, é seguro passar o resultado como o mapeamento de substituição para loadRuntimeAgentConfig({ envVars: ... }).

Parâmetros

Parâmetro
Tipo

source?

Record <string, string | undefined>

Devoluções

Record <string, string>

toolActivityKey()

function toolActivityKey(toolCallId): string;

Parâmetros

Parâmetro
Tipo

toolCallId

string

Devoluções

string

toolRedactFields()

function toolRedactFields(toolDefinitions, toolName): readonly string[];

Extraia a política redact_fields de uma ferramenta de sua definição registrada. A definição é um registro de metadados opaco (estrutura-SDK preenchido), portanto, os valores que não são de array de cadeia de caracteres se degradam para nenhuma supressão em vez de serem lançados.

Parâmetros

Parâmetro
Tipo

toolDefinitions

Record <string, Record <string, unknown>>

toolName

string | undefined

Devoluções

somente leitura string []

traingStatus()

function tracingStatus(): object;

Snapshot do exportador de rastreamento do banco de dados para /health. Espelha o tracing_status do Python: "attached" (o MongoDB abrange o processador ativo), "degraded" (URI de armazenamento configurado, mas inacessível na inicialização, tentando novamente) ou "disabled" (nenhum URI de armazenamento configurado, não uma degradação).

Devoluções

object

Nome
Tipo

database_exporter

string

unwrapActivityOutcome()

function unwrapActivityOutcome(outcome): unknown;

Parâmetros

Parâmetro
Tipo

outcome

`ActivityOutcome <#activityoutcome>`__

Devoluções

unknown

validateDurableMemoryIdentity()

function validateDurableMemoryIdentity(identity, userId): void;

Parâmetros

Parâmetro
Tipo

identity

`WorkflowIdentity <#workflowidentity>'__ | undefined

userId

string | null | undefined

Devoluções

void

valueToJson()

function valueToJson(value): unknown;

Parâmetros

Parâmetro
Tipo

value

Value | undefined

Devoluções

unknown

withExecutionSignal()

function withExecutionSignal(callSignal): AbortSignal;

Combine um AbortSignal por chamada (por exemplo, um tempo limite de solicitação/leitura) com o sinal de cancelamento da execução atual, se houver um definido. O sinal retornado é abortado quando qualquer um dos dois é acionado, portanto, um tempo limite de toda a execução cancela a busca de OE/LLM a bordo em vez de deixá-la para ser executada até seu próprio prazo. Retorna callSignal inalterado quando não há sinal de execução (por exemplo, uma chamada de pod de ferramenta fora de uma execução de AER). Espelha o efeito do asyncio.wait_for do Python que cancela a E/S a bordo no timeout.

Parâmetros

Parâmetro
Tipo

callSignal

AbortSignal

Devoluções

AbortSignal

withMetrics()

function withMetrics<A, R>(
   operation,
   fn,
   opts?
): (...args) => Promise<R>;

Envolva uma função para registrar a latência (e, opcionalmente, os erros).

Substituição do gravador Python @with_metrics(...). A função retornada preserva a assinatura original e aguarda qualquer promessa retornada para que o código assíncrono/sincronizado possa usar o mesmo wrapper.

Parâmetros de tipo

Type Parameter

A estende unknown []

R

Parâmetros

Parâmetro
Tipo

operation

string

fn

(… args) => R | Promise <R>

opts

{ recordErrors?: boolean; }

opts.recordErrors?

boolean

Devoluções

(… args) => Promise <R>

write TerminationMessage ()

function writeTerminationMessage(summary, err?): void;

Registre um resumo limitado e editado de um erro fatal de inicialização na mensagem de encerramento do container antes do processo ser encerrado, para que a verdadeira causa da falha sobreviva além do próprio stdout desse processo em ContainerStatus.LastTerminationState.Terminated.Message — o campo que o diagnóstico de falha da plataforma lê e a partir daí na linha do tempo de implementação voltada para o cliente.

Este é o código do cliente ( modo contêiner) portanto, diferentemente dos componentes da própria plataforma, o design mantém intencionalmente o nome, a mensagem e a pilha completos da exceção — redigido, não resumido —, pois esse detalhe é o que o cliente precisa para corrigir seu próprio agente. Melhor esforço: se a gravação falhar, nada será perdido além do que TerminationMessagePolicy: FallbackToLogsOnError já fornece.

Parâmetros

Parâmetro
Tipo

summary

string

err?

Error

Devoluções

void

Voltar
Agent-Engine- Runner-Shared
Próximo
Agent-engine-sdk
Avalie esta página