From c9aaec0da4ec05d60f8fb1ecd9846fd761d14e5d Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Sat, 1 Feb 2025 08:45:16 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- classes/Agent.html | 12 ++++++------ classes/AgentTester.html | 18 +++++++++--------- functions/convertTestResultsToFormat.html | 2 +- functions/generateAgentApiName.html | 2 +- functions/generateTestSpec.html | 2 +- types/AgentCreateConfig.html | 2 +- types/AgentCreateConfigV2.html | 2 +- types/AgentCreateResponse.html | 2 +- types/AgentCreateResponseV2.html | 2 +- types/AgentJobSpec.html | 2 +- types/AgentJobSpecCreateConfig.html | 2 +- types/AgentJobSpecCreateConfigV2.html | 2 +- types/AgentJobSpecCreateResponse.html | 2 +- types/AgentJobSpecV2.html | 2 +- types/AgentTestResultsResponse.html | 2 +- types/AgentTestStartResponse.html | 2 +- types/AgentTestStatusResponse.html | 2 +- types/AvailableDefinition.html | 2 +- types/DraftAgentTopics.html | 2 +- types/DraftAgentTopicsBody.html | 2 +- types/DraftAgentTopicsResponse.html | 2 +- types/SfAgent.html | 2 +- types/TestCaseResult.html | 2 +- types/TestStatus.html | 2 +- variables/AgentCreateLifecycleStages.html | 2 +- variables/AgentCreateLifecycleStagesV2.html | 2 +- variables/AgentTestCreateLifecycleStages.html | 2 +- 27 files changed, 40 insertions(+), 40 deletions(-) diff --git a/classes/Agent.html b/classes/Agent.html index 13d45df..1a1c7d4 100644 --- a/classes/Agent.html +++ b/classes/Agent.html @@ -1,19 +1,19 @@ Agent | @salesforce/agents

Class for creating Agents and agent specs.

-

Implements

Constructors

Implements

Constructors

  • Create an Agent instance

    -

    Parameters

    • connection: Connection<Schema>
    • project: SfProject

    Returns Agent

Methods

  • From an AgentCreateConfig, deploy the required metadata, call the connect/attach-agent-topics endpoint, and then retrieve +

    Parameters

    • connection: Connection<Schema>
    • project: SfProject

    Returns Agent

Methods

  • From an AgentCreateConfig, deploy the required metadata, call the connect/attach-agent-topics endpoint, and then retrieve the newly updated metadata back to the local project

    Parameters

    Returns Promise<AgentCreateResponse>

    Use the V2 APIs.

    -
  • Create an agent spec from provided data.

    +
  • Create an agent spec from provided data.

    +
  • Creates an agent from a configuration, optionally saving the agent in an org.

    +

Returns Promise<AgentJobSpecV2>

+
diff --git a/classes/AgentTester.html b/classes/AgentTester.html index 030e23c..088d61c 100644 --- a/classes/AgentTester.html +++ b/classes/AgentTester.html @@ -1,5 +1,5 @@ AgentTester | @salesforce/agents

AgentTester class to test Agents

-

Constructors

Constructors

Methods

cancel create list @@ -7,8 +7,8 @@ results start status -

Constructors

Methods

  • Cancel an in-progress test run

    -

    Parameters

    • jobId: string

    Returns Promise<{
        success: boolean;
    }>

  • Creates and deploys an AiEvaluationDefinition from a specification file.

    +

Constructors

Methods

  • Cancel an in-progress test run

    +

    Parameters

    • jobId: string

    Returns Promise<{
        success: boolean;
    }>

  • Creates and deploys an AiEvaluationDefinition from a specification file.

    Parameters

    • specFilePath: string

      The path to the specification file to create the definition from

    • options: {
          confirmationCallback?: ((spec: TestSpec) => Promise<boolean>);
          outputDir: string;
          preview?: boolean;
      }

      Configuration options for creating the definition

      • OptionalconfirmationCallback?: ((spec: TestSpec) => Promise<boolean>)

        Optional callback function to confirm overwriting existing definitions

        @@ -22,12 +22,12 @@

      When a definition with the same name already exists and is not confirmed to be overwritten

      When deployment fails

      -
  • Starts an AI evaluation run based on the provided name or ID.

    +
  • Starts an AI evaluation run based on the provided name or ID.

    Parameters

    • nameOrId: string

      The name or ID of the AI evaluation definition.

    • type: "name" | "id" = 'name'

      Specifies whether the provided identifier is a 'name' or 'id'. Defaults to 'name'. If 'name' is provided, nameOrId is treated as the name of the AiEvaluationDefinition. If 'id' is provided, nameOrId is treated as the unique ID of the AiEvaluationDefinition.

    Returns Promise<AgentTestStartResponse>

    A promise that resolves to an object containing the ID of the started AI evaluation run.

    -
+
diff --git a/functions/convertTestResultsToFormat.html b/functions/convertTestResultsToFormat.html index c761582..f71e7b1 100644 --- a/functions/convertTestResultsToFormat.html +++ b/functions/convertTestResultsToFormat.html @@ -1 +1 @@ -convertTestResultsToFormat | @salesforce/agents

Function convertTestResultsToFormat

  • Parameters

    Returns Promise<string>

+convertTestResultsToFormat | @salesforce/agents

Function convertTestResultsToFormat

  • Parameters

    Returns Promise<string>

diff --git a/functions/generateAgentApiName.html b/functions/generateAgentApiName.html index 8246009..8efe6d3 100644 --- a/functions/generateAgentApiName.html +++ b/functions/generateAgentApiName.html @@ -1,2 +1,2 @@ generateAgentApiName | @salesforce/agents

Function generateAgentApiName

Generate an API name from an agent name. Matches what the UI does.

-
  • Parameters

    • agentName: string

    Returns string

+
diff --git a/functions/generateTestSpec.html b/functions/generateTestSpec.html index 2ccd77e..bdf151c 100644 --- a/functions/generateTestSpec.html +++ b/functions/generateTestSpec.html @@ -1,2 +1,2 @@ generateTestSpec | @salesforce/agents

Function generateTestSpec

  • Generate a test spec file from a TestSpec object

    -

    Parameters

    • spec: TestSpec
    • outputFile: string

    Returns Promise<void>

+

Parameters

Returns Promise<void>

diff --git a/types/AgentCreateConfig.html b/types/AgentCreateConfig.html index 167e1db..b920bc6 100644 --- a/types/AgentCreateConfig.html +++ b/types/AgentCreateConfig.html @@ -1,3 +1,3 @@ AgentCreateConfig | @salesforce/agents

Type Alias AgentCreateConfig

AgentCreateConfig: AgentJobSpecCreateConfig & {
    jobSpec: AgentJobSpec;
}

The parameters used to generate an agent in an org.

NOTE: This is likely to change with planned serverside APIs.

-
+
diff --git a/types/AgentCreateConfigV2.html b/types/AgentCreateConfigV2.html index 467cb3e..828e8c3 100644 --- a/types/AgentCreateConfigV2.html +++ b/types/AgentCreateConfigV2.html @@ -20,4 +20,4 @@
  • OptionalsaveAgent?: boolean

    Whether to persist the agent creation in the org (true) or preview what would be created (false).

    Default: false

    -
  • +
    diff --git a/types/AgentCreateResponse.html b/types/AgentCreateResponse.html index 2d179cc..5898e9b 100644 --- a/types/AgentCreateResponse.html +++ b/types/AgentCreateResponse.html @@ -1,2 +1,2 @@ AgentCreateResponse | @salesforce/agents

    Type Alias AgentCreateResponse

    AgentCreateResponse: {
        errorMessage?: string;
        isSuccess: boolean;
    }

    The response from the attach-agent-topics API.

    -
    +
    diff --git a/types/AgentCreateResponseV2.html b/types/AgentCreateResponseV2.html index ea2829e..b2f325c 100644 --- a/types/AgentCreateResponseV2.html +++ b/types/AgentCreateResponseV2.html @@ -1,3 +1,3 @@ AgentCreateResponseV2 | @salesforce/agents

    Type Alias AgentCreateResponseV2

    AgentCreateResponseV2: {
        agentDefinition: {
            agentDescription: string;
            sampleUtterances: string[];
            topics: [{
                actions: [{
                    actionDescription: string;
                    actionName: string;
                    exampleOutput: string;
                    inputs: [{
                        inputDataType: string;
                        inputDescription: string;
                        inputName: string;
                    }];
                    outputs: [{
                        outputDataType: string;
                        outputDescription: string;
                        outputName: string;
                    }];
                }];
                classificationDescription: string;
                instructions: string[];
                scope: string;
                topic: string;
            }];
        };
        agentId?: {
            botId: string;
            botVersionId: string;
            plannerId: string;
        };
        errorMessage?: string;
        isSuccess: boolean;
    }

    Type declaration

    • agentDefinition: {
          agentDescription: string;
          sampleUtterances: string[];
          topics: [{
              actions: [{
                  actionDescription: string;
                  actionName: string;
                  exampleOutput: string;
                  inputs: [{
                      inputDataType: string;
                      inputDescription: string;
                      inputName: string;
                  }];
                  outputs: [{
                      outputDataType: string;
                      outputDescription: string;
                      outputName: string;
                  }];
              }];
              classificationDescription: string;
              instructions: string[];
              scope: string;
              topic: string;
          }];
      }
      • agentDescription: string
      • sampleUtterances: string[]
      • topics: [{
            actions: [{
                actionDescription: string;
                actionName: string;
                exampleOutput: string;
                inputs: [{
                    inputDataType: string;
                    inputDescription: string;
                    inputName: string;
                }];
                outputs: [{
                    outputDataType: string;
                    outputDescription: string;
                    outputName: string;
                }];
            }];
            classificationDescription: string;
            instructions: string[];
            scope: string;
            topic: string;
        }]
    • OptionalagentId?: {
          botId: string;
          botVersionId: string;
          plannerId: string;
      }

      If the agent was created with saveAgent=true, these are the IDs that make up an agent; Bot, BotVersion, and GenAiPlanner metadata.

      -
      • botId: string
      • botVersionId: string
      • plannerId: string
    • OptionalerrorMessage?: string
    • isSuccess: boolean
    +
  • OptionalerrorMessage?: string
  • isSuccess: boolean
  • diff --git a/types/AgentJobSpec.html b/types/AgentJobSpec.html index 539877c..e5fd2a9 100644 --- a/types/AgentJobSpec.html +++ b/types/AgentJobSpec.html @@ -1,3 +1,3 @@ AgentJobSpec | @salesforce/agents

    Type Alias AgentJobSpec

    AgentJobSpec: [{
        jobDescription: string;
        jobTitle: string;
    }]

    An agent job spec is a list of job titles and descriptions to be performed by the agent.

    -
    +
    diff --git a/types/AgentJobSpecCreateConfig.html b/types/AgentJobSpecCreateConfig.html index af1ce16..1369e11 100644 --- a/types/AgentJobSpecCreateConfig.html +++ b/types/AgentJobSpecCreateConfig.html @@ -1,2 +1,2 @@ AgentJobSpecCreateConfig | @salesforce/agents

    Type Alias AgentJobSpecCreateConfig

    AgentJobSpecCreateConfig: {
        companyDescription: string;
        companyName: string;
        companyWebsite?: string;
        name: string;
        role: string;
        type: "customer" | "internal";
    }

    The parameters used to generate an agent spec.

    -
    +
    diff --git a/types/AgentJobSpecCreateConfigV2.html b/types/AgentJobSpecCreateConfigV2.html index 9e6f2f2..df2c40f 100644 --- a/types/AgentJobSpecCreateConfigV2.html +++ b/types/AgentJobSpecCreateConfigV2.html @@ -5,4 +5,4 @@
  • OptionalmaxNumOfTopics?: number

    The maximum number of topics to create in the spec. Default is 10.

  • OptionalpromptTemplateName?: string

    Developer name of the prompt template.

    -
  • role: string
  • +
  • role: string
  • diff --git a/types/AgentJobSpecCreateResponse.html b/types/AgentJobSpecCreateResponse.html index 759e942..b7ae23f 100644 --- a/types/AgentJobSpecCreateResponse.html +++ b/types/AgentJobSpecCreateResponse.html @@ -1,2 +1,2 @@ AgentJobSpecCreateResponse | @salesforce/agents

    Type Alias AgentJobSpecCreateResponse

    AgentJobSpecCreateResponse: {
        errorMessage?: string;
        isSuccess: boolean;
        jobSpecs?: AgentJobSpec;
    }

    The response from the agent-job-spec API.

    -
    +
    diff --git a/types/AgentJobSpecV2.html b/types/AgentJobSpecV2.html index 8af8cd4..f8891e9 100644 --- a/types/AgentJobSpecV2.html +++ b/types/AgentJobSpecV2.html @@ -1 +1 @@ -AgentJobSpecV2 | @salesforce/agents

    Type Alias AgentJobSpecV2

    AgentJobSpecV2: AgentJobSpecCreateConfigV2 & {
        topics: DraftAgentTopics;
    }
    +AgentJobSpecV2 | @salesforce/agents

    Type Alias AgentJobSpecV2

    AgentJobSpecV2: AgentJobSpecCreateConfigV2 & {
        topics: DraftAgentTopics;
    }
    diff --git a/types/AgentTestResultsResponse.html b/types/AgentTestResultsResponse.html index e68ce5e..c0b5133 100644 --- a/types/AgentTestResultsResponse.html +++ b/types/AgentTestResultsResponse.html @@ -1 +1 @@ -AgentTestResultsResponse | @salesforce/agents

    Type Alias AgentTestResultsResponse

    AgentTestResultsResponse: {
        endTime?: string;
        errorMessage?: string;
        startTime: string;
        status: TestStatus;
        subjectName: string;
        testSet: {
            name: string;
            testCases: TestCaseResult[];
        };
    }
    +AgentTestResultsResponse | @salesforce/agents

    Type Alias AgentTestResultsResponse

    AgentTestResultsResponse: {
        endTime?: string;
        errorMessage?: string;
        startTime: string;
        status: TestStatus;
        subjectName: string;
        testSet: {
            name: string;
            testCases: TestCaseResult[];
        };
    }
    diff --git a/types/AgentTestStartResponse.html b/types/AgentTestStartResponse.html index 5ba6289..2d1f2d2 100644 --- a/types/AgentTestStartResponse.html +++ b/types/AgentTestStartResponse.html @@ -1 +1 @@ -AgentTestStartResponse | @salesforce/agents

    Type Alias AgentTestStartResponse

    AgentTestStartResponse: {
        aiEvaluationId: string;
        status: TestStatus;
    }
    +AgentTestStartResponse | @salesforce/agents

    Type Alias AgentTestStartResponse

    AgentTestStartResponse: {
        aiEvaluationId: string;
        status: TestStatus;
    }
    diff --git a/types/AgentTestStatusResponse.html b/types/AgentTestStatusResponse.html index c4f863d..0435d92 100644 --- a/types/AgentTestStatusResponse.html +++ b/types/AgentTestStatusResponse.html @@ -1 +1 @@ -AgentTestStatusResponse | @salesforce/agents

    Type Alias AgentTestStatusResponse

    AgentTestStatusResponse: {
        endTime?: string;
        errorMessage?: string;
        startTime: string;
        status: TestStatus;
    }
    +AgentTestStatusResponse | @salesforce/agents

    Type Alias AgentTestStatusResponse

    AgentTestStatusResponse: {
        endTime?: string;
        errorMessage?: string;
        startTime: string;
        status: TestStatus;
    }
    diff --git a/types/AvailableDefinition.html b/types/AvailableDefinition.html index d7c277b..4398df6 100644 --- a/types/AvailableDefinition.html +++ b/types/AvailableDefinition.html @@ -1 +1 @@ -AvailableDefinition | @salesforce/agents

    Type Alias AvailableDefinition

    AvailableDefinition: Omit<FileProperties, "manageableState" | "namespacePrefix">
    +AvailableDefinition | @salesforce/agents

    Type Alias AvailableDefinition

    AvailableDefinition: Omit<FileProperties, "manageableState" | "namespacePrefix">
    diff --git a/types/DraftAgentTopics.html b/types/DraftAgentTopics.html index 95eaffe..974e96b 100644 --- a/types/DraftAgentTopics.html +++ b/types/DraftAgentTopics.html @@ -1 +1 @@ -DraftAgentTopics | @salesforce/agents

    Type Alias DraftAgentTopics

    DraftAgentTopics: [{
        description: string;
        name: string;
    }]
    +DraftAgentTopics | @salesforce/agents

    Type Alias DraftAgentTopics

    DraftAgentTopics: [{
        description: string;
        name: string;
    }]
    diff --git a/types/DraftAgentTopicsBody.html b/types/DraftAgentTopicsBody.html index c122ce5..3755ad2 100644 --- a/types/DraftAgentTopicsBody.html +++ b/types/DraftAgentTopicsBody.html @@ -1,2 +1,2 @@ DraftAgentTopicsBody | @salesforce/agents

    Type Alias DraftAgentTopicsBody

    DraftAgentTopicsBody: {
        agentType: "customer" | "internal";
        generationInfo: {
            customizedInfo?: {
                groundingContext?: string;
                promptTemplateName: string;
            };
            defaultInfo: {
                companyDescription: string;
                companyName: string;
                companyWebsite?: string;
                role: string;
            };
        };
        generationSettings: {
            maxNumOfTopics?: number;
        };
    }

    The request body to send to the draft-agent-topics API.

    -
    +
    diff --git a/types/DraftAgentTopicsResponse.html b/types/DraftAgentTopicsResponse.html index 2dbff27..165aa49 100644 --- a/types/DraftAgentTopicsResponse.html +++ b/types/DraftAgentTopicsResponse.html @@ -1,2 +1,2 @@ DraftAgentTopicsResponse | @salesforce/agents

    Type Alias DraftAgentTopicsResponse

    DraftAgentTopicsResponse: {
        errorMessage?: string;
        isSuccess: boolean;
        topicDrafts: DraftAgentTopics;
    }

    The response from the draft-agent-topics API.

    -
    +
    diff --git a/types/SfAgent.html b/types/SfAgent.html index 39a2c14..fc9e742 100644 --- a/types/SfAgent.html +++ b/types/SfAgent.html @@ -1,2 +1,2 @@ SfAgent | @salesforce/agents

    Type Alias SfAgent

    SfAgent: {
        create(config: AgentCreateConfig): Promise<AgentCreateResponse>;
        createSpec(config: AgentJobSpecCreateConfig): Promise<AgentJobSpec>;
    }

    An interface for working with Agents.

    -
    +
    diff --git a/types/TestCaseResult.html b/types/TestCaseResult.html index 44aee28..44e575c 100644 --- a/types/TestCaseResult.html +++ b/types/TestCaseResult.html @@ -1 +1 @@ -TestCaseResult | @salesforce/agents

    Type Alias TestCaseResult

    TestCaseResult: {
        endTime?: string;
        generatedData: {
            actionsSequence: string[];
            outcome: string;
            topic: string;
        };
        inputs: {
            utterance: string;
        };
        startTime: string;
        status: TestStatus;
        testResults: {
            actualValue: string;
            endTime?: string;
            errorCode?: string;
            errorMessage?: string;
            expectedValue: string;
            metricExplainability: string;
            metricLabel: "Accuracy" | "Precision";
            name: string;
            result: "PASS" | "FAILURE";
            score: number;
            startTime: string;
            status: TestStatus;
        }[];
    }
    +TestCaseResult | @salesforce/agents

    Type Alias TestCaseResult

    TestCaseResult: {
        endTime?: string;
        generatedData: {
            actionsSequence: string[];
            outcome: string;
            topic: string;
        };
        inputs: {
            utterance: string;
        };
        startTime: string;
        status: TestStatus;
        testResults: {
            actualValue: string;
            endTime?: string;
            errorCode?: string;
            errorMessage?: string;
            expectedValue: string;
            metricExplainability: string;
            metricLabel: "Accuracy" | "Precision";
            name: string;
            result: "PASS" | "FAILURE";
            score: number;
            startTime: string;
            status: TestStatus;
        }[];
    }
    diff --git a/types/TestStatus.html b/types/TestStatus.html index f473c5a..ece95ef 100644 --- a/types/TestStatus.html +++ b/types/TestStatus.html @@ -1 +1 @@ -TestStatus | @salesforce/agents

    Type Alias TestStatus

    TestStatus:
        | "NEW"
        | "IN_PROGRESS"
        | "COMPLETED"
        | "ERROR"
        | "TERMINATED"
    +TestStatus | @salesforce/agents

    Type Alias TestStatus

    TestStatus:
        | "NEW"
        | "IN_PROGRESS"
        | "COMPLETED"
        | "ERROR"
        | "TERMINATED"
    diff --git a/variables/AgentCreateLifecycleStages.html b/variables/AgentCreateLifecycleStages.html index db73c07..74f81ff 100644 --- a/variables/AgentCreateLifecycleStages.html +++ b/variables/AgentCreateLifecycleStages.html @@ -1,2 +1,2 @@ AgentCreateLifecycleStages | @salesforce/agents

    Variable AgentCreateLifecycleStagesConst

    AgentCreateLifecycleStages: {
        CreatingLocally: string;
        CreatingRemotely: string;
        DeployingMetadata: string;
        RetrievingMetadata: string;
    } = ...

    Events emitted during Agent.create() for consumers to listen to and keep track of progress

    -
    +
    diff --git a/variables/AgentCreateLifecycleStagesV2.html b/variables/AgentCreateLifecycleStagesV2.html index e559a07..48a698b 100644 --- a/variables/AgentCreateLifecycleStagesV2.html +++ b/variables/AgentCreateLifecycleStagesV2.html @@ -1 +1 @@ -AgentCreateLifecycleStagesV2 | @salesforce/agents

    Variable AgentCreateLifecycleStagesV2Const

    AgentCreateLifecycleStagesV2: {
        Creating: string;
        Previewing: string;
        Retrieving: string;
    } = ...
    +AgentCreateLifecycleStagesV2 | @salesforce/agents

    Variable AgentCreateLifecycleStagesV2Const

    AgentCreateLifecycleStagesV2: {
        Creating: string;
        Previewing: string;
        Retrieving: string;
    } = ...
    diff --git a/variables/AgentTestCreateLifecycleStages.html b/variables/AgentTestCreateLifecycleStages.html index d8081fb..98031d2 100644 --- a/variables/AgentTestCreateLifecycleStages.html +++ b/variables/AgentTestCreateLifecycleStages.html @@ -1 +1 @@ -AgentTestCreateLifecycleStages | @salesforce/agents

    Variable AgentTestCreateLifecycleStagesConst

    AgentTestCreateLifecycleStages: {
        CreatingLocalMetadata: string;
        DeployingMetadata: string;
        Done: string;
        Waiting: string;
    } = ...
    +AgentTestCreateLifecycleStages | @salesforce/agents

    Variable AgentTestCreateLifecycleStagesConst

    AgentTestCreateLifecycleStages: {
        CreatingLocalMetadata: string;
        DeployingMetadata: string;
        Done: string;
        Waiting: string;
    } = ...