@salesforce/agents/lib/index.d.ts

Client side APIs for working with Salesforce agents

export { type BaseAgentConfig, type AgentPreviewStartResponse, type AgentPreviewSendResponse, type AgentPreviewEndResponse, type EndReason, type ApiStatus, type AgentJson, type AgentCompilationSuccess, type AgentScriptContent, type AgentCreateConfig, type AgentCreateResponse, type AgentJobSpec, type AgentJobSpecCreateConfig, type AgentOptions, type AgentTone, type AgentType, type BotMetadata, type BotVersionMetadata, type PreviewableAgent, type CompilationError, type DraftAgentTopics, type DraftAgentTopicsBody, type DraftAgentTopicsResponse, type AvailableDefinition, type AgentPreviewMessageLinks, type AgentPreviewMessage, type AgentPreviewError, type AgentPreviewStartOptions, type ContextVariable, AgentSource, type ScriptAgentType, type ProductionAgentType, type AgentTestResultsResponse, type AgentTestStartResponse, type AgentTestStatusResponse, type TestCaseResult, type TestStatus, type AgentTestConfig, type TestCase, type TestSpec, type MetadataMetric, type MetadataExpectation, type MetadataCustomEvaluation, type AiEvaluationDefinition, type NgtTestSpec, type NgtTestCase, type NgtTestCaseInput, type NgtTestCaseScorer, type NgtContextVar, type NgtConversationTurn, type AiTestingDefinition, type AiTestCase, type AiTestCaseInputXml, type AiTestCaseScorer, type AiConversationTurnXml, type AgentforceStudioTestStartResponse, type AgentforceStudioTestStatusResponse, type AgentforceStudioTestResultsResponse, type TestScorerResult, type AgentforceStudioTestCaseResult, type AgentTraceResponse, type AgentTraceStep, type PlannerResponse, type PlanStep, type UserInputStep, type LLMExecutionStep, type UpdateTopicStep, type EventStep, type FunctionStep, type ReasoningStep, type PlannerResponseStep, COMPILATION_API_EXIT_CODES, } from './types';
export { metric, findAuthoringBundle, readTranscriptEntries, determineTestRunner, detectTestRunnerFromId, type TestRunnerType, createPreviewSessionCache, validatePreviewSession, removePreviewSessionCache, getCachedPreviewSessionIds, getCurrentPreviewSessionId, listCachedPreviewSessions, listSessionTraces, readSessionTrace, readTurnIndex, type TraceFileInfo, type TurnIndex, type TurnIndexEntry, type SessionType, type PreviewSessionMeta, type CachedPreviewSessionInfo, type CachedPreviewSessionEntry, } from './utils';
export { Agent, AgentCreateLifecycleStages, type AgentInstance } from './agent';
export { AgentTester } from './agentTester';
export { AgentforceStudioTester, normalizeAgentforceStudioResults } from './agentforceStudioTester';
export { createAgentTester, type CreateAgentTesterOptions, type CreateAgentTesterResult } from './agentTesterFactory';
export { type NgtScorerName, type KnownNgtScorerName, type NgtScorerGrade, type NgtScorerEntry, NgtScorerCatalog, isNgtScorerName, } from './ngtScorerCatalog';
export { AgentTest, AgentTestCreateLifecycleStages, validateNgtSpec, convertToTestingMetadata, convertToNgtSpec, buildTestingMetadataXml, parseNgtMetadataXml, } from './agentTest';
export { ProductionAgent } from './agents/productionAgent';
export { ScriptAgent } from './agents/scriptAgent';
export { AgentBase } from './agents/agentBase';
export { convertTestResultsToFormat, humanFriendlyName } from './agentTestResults';
export { writeDebugLog } from './apexUtils';
export { applyStringReplacements, applyStringReplacementsToAgent, type ReplacementConfig, type ReplacementResult, } from './stringReplacements';
export { normalizePayload, normalizeMcpShorthand, autoCorrectFields, normalizeCamelCase, normalizeEvaluatorFields, convertShorthandRefs, injectDefaults, stripUnrecognizedFields, splitIntoBatches, type EvalPayload, type EvalTest, type EvalStep, } from './evalNormalizer';
export { formatResults, type EvalApiResponse, type EvalOutput, type EvalResult, type TestError, type TestResult, type ResultFormat, } from './evalFormatter';
export { isYamlTestSpec, parseTestSpec, translateTestSpec, translateTestCase } from './yamlSpecTranslator';
export { resolveAgent, executeBatches, buildResultSummary, type AgentEvalRunResult } from './agentEvalRunner';
export { AgentDataLibrary } from './agentDataLibrary';
export { type DataLibrarySummary, type DataLibraryDetail, type IndexingStatusResponse, type CreateLibraryInput, type UpdateLibraryInput, type UploadResult, type FileAddResult, type GroundingFileRef, type GroundingSource, type StageDetail, type SourceType, type RetrieverDetail, type RetrieverActionDetail, type StageArtifact, type FileListResponse, } from './dataLibraryTypes';
export { ApiCatalog } from './apiCatalog';
export { type McpServerType, type McpAuthType, type McpAssetKind, type McpConnectionStatus, type McpServerStatusFilter, type McpServerAuthorizationOutput, type McpServerAuthorizationInput, type McpServerOutput, type McpServerCollection, type McpServerCreateInput, type McpServerUpdateInput, type McpFetchedAsset, type McpServerCreateOutput, type McpServerFetchOutput, type McpServerAssetOutput, type McpServerAssetCollection, type McpServerAssetReplaceItem, type McpServerAssetReplaceInput, type ListMcpServersOptions, } from './apiCatalogTypes';