Class ScriptAgent

constructor

• new ScriptAgent(options: ScriptAgentOptions): ScriptAgent

  Parameters

  • options: ScriptAgentOptions

  Returns ScriptAgent

preview

compile

• compile(): Promise<CompileAgentScriptResponse>
  Beta

  Compiles AgentScript returning agent JSON when successful, otherwise the compile errors are returned.

  Returns Promise<CompileAgentScriptResponse>

  Promise The raw API response

endSession

• endSession(): Promise<AgentPreviewEndResponse>

  Ending is not required this will save all the transcripts to disc

  Returns Promise<AgentPreviewEndResponse>

  AgentPreviewEndResponse

getAgentIdForStorage

• getAgentIdForStorage(): string

  Get the agent ID to use for storage/transcript purposes

  Returns string

getHistoryFromDisc

• getHistoryFromDisc(
      sessionId?: string,
  ): Promise<
      {
          metadata: PreviewMetadata
          | null;
          traces: PlannerResponse[];
          transcript: TranscriptEntry[];
      },
  >

  Parameters

  • OptionalsessionId: string

  Returns Promise<
      {
          metadata: PreviewMetadata
          | null;
          traces: PlannerResponse[];
          transcript: TranscriptEntry[];
      },
  >

getTrace

• getTrace(planId: string): Promise<PlannerResponse>

  Parameters

  • planId: string

  Returns Promise<PlannerResponse>

publish

• publish(skipMetadataRetrieve?: boolean): Promise<PublishAgent>
  Beta

  Publish an AgentJson representation to the org

  Parameters

  • OptionalskipMetadataRetrieve: boolean

  Returns Promise<PublishAgent>

  The publish response

refreshContent

• refreshContent(): Promise<void>

  Returns Promise<void>

StaticcreateAuthoringBundle

• createAuthoringBundle(
      options: {
          agentSpec?: ExtendedAgentJobSpec;
          bundleApiName: string;
          outputDir?: string;
          project: SfProject;
      },
  ): Promise<void>
  Beta

  Creates an AiAuthoringBundle directory, .script file, and -meta.xml file

  Parameters

  • options: {
        agentSpec?: ExtendedAgentJobSpec;
        bundleApiName: string;
        outputDir?: string;
        project: SfProject;
    }

    { project: SfProject; bundleApiName: string; outputDir?: string; agentSpec?: ExtendedAgentJobSpec; }

  Returns Promise<void>

  Promise