Class Scorers

Hierarchy

APIResource
- Scorers

Index

Constructors

Properties

Methods

create retrieve update list validate

Constructors

constructor

new Scorers(client: Runloop): Scorers
Parameters
- client: Runloop
Returns Scorers
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body: ScorerCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<ScorerCreateResponse>
Create a custom scenario scorer.
Parameters
- body: ScorerCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScorerCreateResponse>
- Defined in src/resources/scenarios/scorers.ts:13

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ScorerRetrieveResponse>
Retrieve Scenario Scorer.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScorerRetrieveResponse>
- Defined in src/resources/scenarios/scorers.ts:20

update

update(
    id: string,
    body: ScorerUpdateParams,
    options?: RequestOptions<unknown>,
): APIPromise<ScorerUpdateResponse>
Update a scenario scorer.
Parameters
- id: string
- body: ScorerUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScorerUpdateResponse>
- Defined in src/resources/scenarios/scorers.ts:27

list

list(
    query?: ScorerListParams,
    options?: RequestOptions<unknown>,
): PagePromise<
    ScorerListResponsesScenarioScorersCursorIDPage,
    ScorerListResponse,
>
List all Scenario Scorers matching filter.
Parameters
- Optionalquery: ScorerListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ScorerListResponsesScenarioScorersCursorIDPage, ScorerListResponse>
- Defined in src/resources/scenarios/scorers.ts:38
list(
    options?: RequestOptions<unknown>,
): PagePromise<
    ScorerListResponsesScenarioScorersCursorIDPage,
    ScorerListResponse,
>
List all Scenario Scorers matching filter.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ScorerListResponsesScenarioScorersCursorIDPage, ScorerListResponse>
- Defined in src/resources/scenarios/scorers.ts:42

validate

validate(
    id: string,
    body: ScorerValidateParams,
    options?: RequestOptions<unknown>,
): APIPromise<ScorerValidateResponse>
Validate a scenario scorer.
Parameters
- id: string
- body: ScorerValidateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScorerValidateResponse>
- Defined in src/resources/scenarios/scorers.ts:61