@salesforce/agents
Preparing search index...
index
Module index
References
Agent
→
Agent
AgentBase
→
AgentBase
AgentCompilationSuccess
→
AgentCompilationSuccess
AgentCreateConfig
→
AgentCreateConfig
AgentCreateLifecycleStages
→
AgentCreateLifecycleStages
AgentCreateResponse
→
AgentCreateResponse
AgentEvalRunResult
→
AgentEvalRunResult
AgentforceStudioTestCaseResult
→
AgentforceStudioTestCaseResult
AgentforceStudioTester
→
AgentforceStudioTester
AgentforceStudioTestResultsResponse
→
AgentforceStudioTestResultsResponse
AgentforceStudioTestStartResponse
→
AgentforceStudioTestStartResponse
AgentforceStudioTestStatusResponse
→
AgentforceStudioTestStatusResponse
AgentInstance
→
AgentInstance
AgentJobSpec
→
AgentJobSpec
AgentJobSpecCreateConfig
→
AgentJobSpecCreateConfig
AgentJson
→
AgentJson
AgentOptions
→
AgentOptions
AgentPreviewEndResponse
→
AgentPreviewEndResponse
AgentPreviewError
→
AgentPreviewError
AgentPreviewMessage
→
AgentPreviewMessage
AgentPreviewMessageLinks
→
AgentPreviewMessageLinks
AgentPreviewSendResponse
→
AgentPreviewSendResponse
AgentPreviewStartResponse
→
AgentPreviewStartResponse
AgentScriptContent
→
AgentScriptContent
AgentSource
→
AgentSource
AgentTest
→
AgentTest
AgentTestConfig
→
AgentTestConfig
AgentTestCreateLifecycleStages
→
AgentTestCreateLifecycleStages
AgentTester
→
AgentTester
AgentTestResultsResponse
→
AgentTestResultsResponse
AgentTestStartResponse
→
AgentTestStartResponse
AgentTestStatusResponse
→
AgentTestStatusResponse
AgentTone
→
AgentTone
AgentTraceResponse
→
AgentTraceResponse
AgentTraceStep
→
AgentTraceStep
AgentType
→
AgentType
AiEvaluationDefinition
→
AiEvaluationDefinition
ApiStatus
→
ApiStatus
applyStringReplacements
→
applyStringReplacements
applyStringReplacementsToAgent
→
applyStringReplacementsToAgent
autoCorrectFields
→
autoCorrectFields
AvailableDefinition
→
AvailableDefinition
BaseAgentConfig
→
BaseAgentConfig
BotMetadata
→
BotMetadata
BotVersionMetadata
→
BotVersionMetadata
buildResultSummary
→
buildResultSummary
CachedPreviewSessionEntry
→
CachedPreviewSessionEntry
CachedPreviewSessionInfo
→
CachedPreviewSessionInfo
COMPILATION_API_EXIT_CODES
→
COMPILATION_API_EXIT_CODES
CompilationError
→
CompilationError
convertShorthandRefs
→
convertShorthandRefs
convertTestResultsToFormat
→
convertTestResultsToFormat
createAgentTester
→
createAgentTester
CreateAgentTesterOptions
→
CreateAgentTesterOptions
CreateAgentTesterResult
→
CreateAgentTesterResult
createPreviewSessionCache
→
createPreviewSessionCache
detectTestRunnerFromId
→
detectTestRunnerFromId
determineTestRunner
→
determineTestRunner
DraftAgentTopics
→
DraftAgentTopics
DraftAgentTopicsBody
→
DraftAgentTopicsBody
DraftAgentTopicsResponse
→
DraftAgentTopicsResponse
EndReason
→
EndReason
EvalApiResponse
→
EvalApiResponse
EvalOutput
→
EvalOutput
EvalPayload
→
EvalPayload
EvalResult
→
EvalResult
EvalStep
→
EvalStep
EvalTest
→
EvalTest
EventStep
→
EventStep
executeBatches
→
executeBatches
findAuthoringBundle
→
findAuthoringBundle
formatResults
→
formatResults
FunctionStep
→
FunctionStep
getCachedPreviewSessionIds
→
getCachedPreviewSessionIds
getCurrentPreviewSessionId
→
getCurrentPreviewSessionId
humanFriendlyName
→
humanFriendlyName
injectDefaults
→
injectDefaults
isYamlTestSpec
→
isYamlTestSpec
listCachedPreviewSessions
→
listCachedPreviewSessions
listSessionTraces
→
listSessionTraces
LLMExecutionStep
→
LLMExecutionStep
MetadataCustomEvaluation
→
MetadataCustomEvaluation
MetadataExpectation
→
MetadataExpectation
MetadataMetric
→
MetadataMetric
metric
→
metric
normalizeAgentforceStudioResults
→
normalizeAgentforceStudioResults
normalizeCamelCase
→
normalizeCamelCase
normalizeEvaluatorFields
→
normalizeEvaluatorFields
normalizeMcpShorthand
→
normalizeMcpShorthand
normalizePayload
→
normalizePayload
parseTestSpec
→
parseTestSpec
PlannerResponse
→
PlannerResponse
PlannerResponseStep
→
PlannerResponseStep
PlanStep
→
PlanStep
PreviewableAgent
→
PreviewableAgent
PreviewSessionMeta
→
PreviewSessionMeta
ProductionAgent
→
ProductionAgent
ProductionAgentType
→
ProductionAgentType
readSessionTrace
→
readSessionTrace
readTranscriptEntries
→
readTranscriptEntries
readTurnIndex
→
readTurnIndex
ReasoningStep
→
ReasoningStep
removePreviewSessionCache
→
removePreviewSessionCache
ReplacementResult
→
ReplacementResult
resolveAgent
→
resolveAgent
ResultFormat
→
ResultFormat
ScriptAgent
→
ScriptAgent
ScriptAgentType
→
ScriptAgentType
SessionType
→
SessionType
splitIntoBatches
→
splitIntoBatches
stripUnrecognizedFields
→
stripUnrecognizedFields
TestCase
→
TestCase
TestCaseResult
→
TestCaseResult
TestError
→
TestError
TestResult
→
TestResult
TestRunnerType
→
TestRunnerType
TestScorerResult
→
TestScorerResult
TestSpec
→
TestSpec
TestStatus
→
TestStatus
TraceFileInfo
→
TraceFileInfo
translateTestCase
→
translateTestCase
translateTestSpec
→
translateTestSpec
TurnIndex
→
TurnIndex
TurnIndexEntry
→
TurnIndexEntry
UpdateTopicStep
→
UpdateTopicStep
UserInputStep
→
UserInputStep
validatePreviewSession
→
validatePreviewSession
writeDebugLog
→
writeDebugLog
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
References
Agent
Agent
Base
Agent
Compilation
Success
Agent
Create
Config
Agent
Create
Lifecycle
Stages
Agent
Create
Response
Agent
Eval
Run
Result
Agentforce
Studio
Test
Case
Result
Agentforce
Studio
Tester
Agentforce
Studio
Test
Results
Response
Agentforce
Studio
Test
Start
Response
Agentforce
Studio
Test
Status
Response
Agent
Instance
Agent
Job
Spec
Agent
Job
Spec
Create
Config
Agent
Json
Agent
Options
Agent
Preview
End
Response
Agent
Preview
Error
Agent
Preview
Message
Agent
Preview
Message
Links
Agent
Preview
Send
Response
Agent
Preview
Start
Response
Agent
Script
Content
Agent
Source
Agent
Test
Agent
Test
Config
Agent
Test
Create
Lifecycle
Stages
Agent
Tester
Agent
Test
Results
Response
Agent
Test
Start
Response
Agent
Test
Status
Response
Agent
Tone
Agent
Trace
Response
Agent
Trace
Step
Agent
Type
Ai
Evaluation
Definition
Api
Status
apply
String
Replacements
apply
String
Replacements
To
Agent
auto
Correct
Fields
Available
Definition
Base
Agent
Config
Bot
Metadata
Bot
Version
Metadata
build
Result
Summary
Cached
Preview
Session
Entry
Cached
Preview
Session
Info
COMPILATION_
API_
EXIT_
CODES
Compilation
Error
convert
Shorthand
Refs
convert
Test
Results
To
Format
create
Agent
Tester
Create
Agent
Tester
Options
Create
Agent
Tester
Result
create
Preview
Session
Cache
detect
Test
Runner
From
Id
determine
Test
Runner
Draft
Agent
Topics
Draft
Agent
Topics
Body
Draft
Agent
Topics
Response
End
Reason
Eval
Api
Response
Eval
Output
Eval
Payload
Eval
Result
Eval
Step
Eval
Test
Event
Step
execute
Batches
find
Authoring
Bundle
format
Results
Function
Step
get
Cached
Preview
Session
Ids
get
Current
Preview
Session
Id
human
Friendly
Name
inject
Defaults
is
Yaml
Test
Spec
list
Cached
Preview
Sessions
list
Session
Traces
LLM
Execution
Step
Metadata
Custom
Evaluation
Metadata
Expectation
Metadata
Metric
metric
normalize
Agentforce
Studio
Results
normalize
Camel
Case
normalize
Evaluator
Fields
normalize
Mcp
Shorthand
normalize
Payload
parse
Test
Spec
Planner
Response
Planner
Response
Step
Plan
Step
Previewable
Agent
Preview
Session
Meta
Production
Agent
Production
Agent
Type
read
Session
Trace
read
Transcript
Entries
read
Turn
Index
Reasoning
Step
remove
Preview
Session
Cache
Replacement
Result
resolve
Agent
Result
Format
Script
Agent
Script
Agent
Type
Session
Type
split
Into
Batches
strip
Unrecognized
Fields
Test
Case
Test
Case
Result
Test
Error
Test
Result
Test
Runner
Type
Test
Scorer
Result
Test
Spec
Test
Status
Trace
File
Info
translate
Test
Case
translate
Test
Spec
Turn
Index
Turn
Index
Entry
Update
Topic
Step
User
Input
Step
validate
Preview
Session
write
Debug
Log
@salesforce/agents
Loading...