From f590fa4153b73f103ead10fa68cd67fcd3ab001b Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Mon, 6 Jan 2025 21:25:53 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- classes/Agent.html | 8 ++++---- classes/AgentTester.html | 14 +++++++------- functions/humanFormat.html | 2 +- functions/jsonFormat.html | 2 +- functions/junitFormat.html | 2 +- functions/tapFormat.html | 2 +- types/AgentCreateConfig.html | 2 +- types/AgentCreateResponse.html | 2 +- types/AgentJobSpec.html | 2 +- types/AgentJobSpecCreateConfig.html | 2 +- types/AgentJobSpecCreateResponse.html | 2 +- types/AgentTestDetailsResponse.html | 2 +- types/AgentTestStartResponse.html | 2 +- types/AgentTestStatusResponse.html | 2 +- types/SfAgent.html | 2 +- types/TestCaseResult.html | 2 +- types/TestStatus.html | 2 +- variables/AgentCreateLifecycleStages.html | 2 +- 18 files changed, 27 insertions(+), 27 deletions(-) diff --git a/classes/Agent.html b/classes/Agent.html index c5df103..d697e43 100644 --- a/classes/Agent.html +++ b/classes/Agent.html @@ -1,10 +1,10 @@ Agent | @salesforce/agents

Class Agent

Class for creating Agents and agent specs.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Methods

create createSpec

Constructors

constructor

  • new Agent(connection, project): Agent

  • Create an Agent instance

    -

    Parameters

    • connection: Connection<Schema>
    • project: SfProject

    Returns Agent

Methods

create

  • create(config): Promise<AgentCreateResponse>

  • 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

create

  • create(config): Promise<AgentCreateResponse>

  • 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>

createSpec

createSpec

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns Promise<AgentJobSpec>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/AgentTester.html b/classes/AgentTester.html index 5d9e9fb..12f450f 100644 --- a/classes/AgentTester.html +++ b/classes/AgentTester.html @@ -1,16 +1,16 @@ AgentTester | @salesforce/agents

Class AgentTester

AgentTester class to test Agents

-

Constructors

constructor +

Constructors

constructor

Methods

cancel details poll start status -

Constructors

constructor

Methods

cancel

  • cancel(jobId): Promise<{
        success: boolean;
    }>

  • Cancel an in-progress test run

    -

    Parameters

    • jobId: string

    Returns Promise<{
        success: boolean;
    }>

details

poll

start

  • start(nameOrId, type?): Promise<AgentTestStartResponse>

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

    +

Constructors

constructor

Methods

cancel

  • cancel(jobId): Promise<{
        success: boolean;
    }>

  • Cancel an in-progress test run

    +

    Parameters

    • jobId: string

    Returns Promise<{
        success: boolean;
    }>

details

poll

start

  • start(nameOrId, type?): Promise<AgentTestStartResponse>

  • 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.

    -

status

Settings

Member Visibility

On This Page

Constructors
Methods
+

status

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/functions/humanFormat.html b/functions/humanFormat.html index a7b53c8..20cd063 100644 --- a/functions/humanFormat.html +++ b/functions/humanFormat.html @@ -1 +1 @@ -humanFormat | @salesforce/agents

Function humanFormat

Settings

Member Visibility
+humanFormat | @salesforce/agents

Function humanFormat

Settings

Member Visibility
diff --git a/functions/jsonFormat.html b/functions/jsonFormat.html index 96a67af..d58edad 100644 --- a/functions/jsonFormat.html +++ b/functions/jsonFormat.html @@ -1 +1 @@ -jsonFormat | @salesforce/agents

Function jsonFormat

Settings

Member Visibility
+jsonFormat | @salesforce/agents

Function jsonFormat

Settings

Member Visibility
diff --git a/functions/junitFormat.html b/functions/junitFormat.html index 30014cc..9ef7a3e 100644 --- a/functions/junitFormat.html +++ b/functions/junitFormat.html @@ -1 +1 @@ -junitFormat | @salesforce/agents

Function junitFormat

Settings

Member Visibility
+junitFormat | @salesforce/agents

Function junitFormat

Settings

Member Visibility
diff --git a/functions/tapFormat.html b/functions/tapFormat.html index 9941e79..baffa25 100644 --- a/functions/tapFormat.html +++ b/functions/tapFormat.html @@ -1 +1 @@ -tapFormat | @salesforce/agents

Function tapFormat

Settings

Member Visibility
+tapFormat | @salesforce/agents

Function tapFormat

Settings

Member Visibility
diff --git a/types/AgentCreateConfig.html b/types/AgentCreateConfig.html index 2107fb1..3766b50 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/AgentCreateResponse.html b/types/AgentCreateResponse.html index 746470a..10d7f98 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/AgentJobSpec.html b/types/AgentJobSpec.html index 5827e59..fef109b 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/AgentJobSpecCreateConfig.html b/types/AgentJobSpecCreateConfig.html index 35ce766..a0e6b6b 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/AgentJobSpecCreateResponse.html b/types/AgentJobSpecCreateResponse.html index b55e13c..4e340f6 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/AgentTestDetailsResponse.html b/types/AgentTestDetailsResponse.html index dd03a66..0b2556d 100644 --- a/types/AgentTestDetailsResponse.html +++ b/types/AgentTestDetailsResponse.html @@ -1 +1 @@ -AgentTestDetailsResponse | @salesforce/agents

Type Alias AgentTestDetailsResponse

AgentTestDetailsResponse: {
    endTime?: string;
    errorMessage?: string;
    startTime: string;
    status: TestStatus;
    subjectName: string;
    testSet: {
        name: string;
        testCases: TestCaseResult[];
    };
}

Settings

Member Visibility
+AgentTestDetailsResponse | @salesforce/agents

Type Alias AgentTestDetailsResponse

AgentTestDetailsResponse: {
    endTime?: string;
    errorMessage?: string;
    startTime: string;
    status: TestStatus;
    subjectName: string;
    testSet: {
        name: string;
        testCases: TestCaseResult[];
    };
}

Settings

Member Visibility
diff --git a/types/AgentTestStartResponse.html b/types/AgentTestStartResponse.html index ca77e3f..3fec2a1 100644 --- a/types/AgentTestStartResponse.html +++ b/types/AgentTestStartResponse.html @@ -1 +1 @@ -AgentTestStartResponse | @salesforce/agents

Type Alias AgentTestStartResponse

AgentTestStartResponse: {
    aiEvaluationId: string;
    status: TestStatus;
}

Settings

Member Visibility
+AgentTestStartResponse | @salesforce/agents

Type Alias AgentTestStartResponse

AgentTestStartResponse: {
    aiEvaluationId: string;
    status: TestStatus;
}

Settings

Member Visibility
diff --git a/types/AgentTestStatusResponse.html b/types/AgentTestStatusResponse.html index 4ee5366..c3b97bf 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;
}

Settings

Member Visibility
+AgentTestStatusResponse | @salesforce/agents

Type Alias AgentTestStatusResponse

AgentTestStatusResponse: {
    endTime?: string;
    errorMessage?: string;
    startTime: string;
    status: TestStatus;
}

Settings

Member Visibility
diff --git a/types/SfAgent.html b/types/SfAgent.html index ee5e1a3..6a2637a 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/TestCaseResult.html b/types/TestCaseResult.html index 47bb992..1289ac3 100644 --- a/types/TestCaseResult.html +++ b/types/TestCaseResult.html @@ -1 +1 @@ -TestCaseResult | @salesforce/agents

Type Alias TestCaseResult

TestCaseResult: {
    endTime?: string;
    expectationResults: {
        actualValue: string;
        endTime?: string;
        errorCode?: string;
        errorMessage?: string;
        expectedValue: string;
        metricExplainability: string;
        metricLabel: "Accuracy" | "Precision";
        name: string;
        result: "Passed" | "Failed";
        score: number;
        startTime: string;
        status: TestStatus;
    }[];
    generatedData: {
        actionsSequence: string[];
        inputTokensCount: string;
        outcome: "Success" | "Failure";
        outputTokensCount: string;
        topic: string;
        type: "AGENT";
    };
    number: string;
    startTime: string;
    status: TestStatus;
    utterance: string;
}

Settings

Member Visibility
+TestCaseResult | @salesforce/agents

Type Alias TestCaseResult

TestCaseResult: {
    endTime?: string;
    expectationResults: {
        actualValue: string;
        endTime?: string;
        errorCode?: string;
        errorMessage?: string;
        expectedValue: string;
        metricExplainability: string;
        metricLabel: "Accuracy" | "Precision";
        name: string;
        result: "Passed" | "Failed";
        score: number;
        startTime: string;
        status: TestStatus;
    }[];
    generatedData: {
        actionsSequence: string[];
        inputTokensCount: string;
        outcome: "Success" | "Failure";
        outputTokensCount: string;
        topic: string;
        type: "AGENT";
    };
    number: string;
    startTime: string;
    status: TestStatus;
    utterance: string;
}

Settings

Member Visibility
diff --git a/types/TestStatus.html b/types/TestStatus.html index cee7268..ce70ffb 100644 --- a/types/TestStatus.html +++ b/types/TestStatus.html @@ -1 +1 @@ -TestStatus | @salesforce/agents

Type Alias TestStatus

TestStatus:
    | "NEW"
    | "IN_PROGRESS"
    | "COMPLETED"
    | "ERROR"

Settings

Member Visibility
+TestStatus | @salesforce/agents

Type Alias TestStatus

TestStatus:
    | "NEW"
    | "IN_PROGRESS"
    | "COMPLETED"
    | "ERROR"

Settings

Member Visibility
diff --git a/variables/AgentCreateLifecycleStages.html b/variables/AgentCreateLifecycleStages.html index 4ce5c7c..ded597e 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

-

Settings

Member Visibility
+

Settings

Member Visibility