import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
const response = await client.scenarios.scorers.validate('id', { scoring_context: {} });
console.log(response.name);{
"name": "<string>",
"scoring_context": {},
"scoring_result": {
"score": 123,
"scoring_function_name": "<string>",
"output": "<string>",
"state": "unknown"
},
"environment_parameters": {
"blueprint_id": "<string>",
"snapshot_id": "<string>",
"launch_parameters": {
"launch_commands": [
"<string>"
],
"resource_size_request": "X_SMALL",
"keep_alive_time_seconds": 123,
"available_ports": [
123
],
"after_idle": {
"idle_time_seconds": 123,
"on_idle": "shutdown"
},
"custom_cpu_cores": 123,
"custom_gb_memory": 123,
"custom_disk_size": 123,
"architecture": "x86_64",
"user_parameters": {
"username": "<string>",
"uid": 123
},
"required_services": [
"<string>"
]
},
"working_directory": "<string>"
}
}Validate a scenario scorer.
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
const response = await client.scenarios.scorers.validate('id', { scoring_context: {} });
console.log(response.name);{
"name": "<string>",
"scoring_context": {},
"scoring_result": {
"score": 123,
"scoring_function_name": "<string>",
"output": "<string>",
"state": "unknown"
},
"environment_parameters": {
"blueprint_id": "<string>",
"snapshot_id": "<string>",
"launch_parameters": {
"launch_commands": [
"<string>"
],
"resource_size_request": "X_SMALL",
"keep_alive_time_seconds": 123,
"available_ports": [
123
],
"after_idle": {
"idle_time_seconds": 123,
"on_idle": "shutdown"
},
"custom_cpu_cores": 123,
"custom_gb_memory": 123,
"custom_disk_size": 123,
"architecture": "x86_64",
"user_parameters": {
"username": "<string>",
"uid": 123
},
"required_services": [
"<string>"
]
},
"working_directory": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The Scorer ID.
Json context that gets passed to the custom scorer
The Environment in which the Scenario will run.
Show child attributes
Use the blueprint with matching ID.
Use the snapshot with matching ID.
Optional launch parameters to apply to the devbox environment at launch.
Show child attributes
Set of commands to be run at launch time, before the entrypoint process is run.
Manual resource configuration for Devbox. If not set, defaults will be used.
X_SMALL, SMALL, MEDIUM, LARGE, X_LARGE, XX_LARGE, CUSTOM_SIZE Time in seconds after which Devbox will automatically shutdown. Default is 1 hour. Maximum is 48 hours (172800 seconds).
A list of ports to make available on the Devbox. Only ports made available will be surfaced to create tunnels via the 'createTunnel' API.
Configure Devbox lifecycle based on idle activity. If after_idle is set, Devbox will ignore keep_alive_time_seconds.
Show child attributes
After idle_time_seconds, on_idle action will be taken.
Action to take after Devbox becomes idle.
shutdown, suspend custom resource size, number of cpu cores, must be multiple of 2. Min is 1, max is 16.
custom memory size, number in GiB, must be a multiple of 2. Min is 2GiB, max is 64GiB.
custom disk size, number in GiB, must be a multiple of 2. Min is 2GiB, max is 64GiB.
The target architecture for the Devbox. If unset, defaults to x86_64.
x86_64, arm64 Specify the user for execution on Devbox. If not set, default user will be used.
A list of ContainerizedService names to be started when a Devbox is created. A valid ContainerizedService must be specified in Blueprint to be started.
The working directory where the agent is expected to fulfill the scenario. Scoring functions also run from the working directory.
OK
Name of the custom scorer.
Json context that gets passed to the custom scorer
Result of the scoring function.
Show child attributes
Final score for the given scoring function.
Scoring function name that ran.
Log output of the scoring function.
The state of the scoring function application.
unknown, complete, error The Environment in which the Scenario will run.
Show child attributes
Use the blueprint with matching ID.
Use the snapshot with matching ID.
Optional launch parameters to apply to the devbox environment at launch.
Show child attributes
Set of commands to be run at launch time, before the entrypoint process is run.
Manual resource configuration for Devbox. If not set, defaults will be used.
X_SMALL, SMALL, MEDIUM, LARGE, X_LARGE, XX_LARGE, CUSTOM_SIZE Time in seconds after which Devbox will automatically shutdown. Default is 1 hour. Maximum is 48 hours (172800 seconds).
A list of ports to make available on the Devbox. Only ports made available will be surfaced to create tunnels via the 'createTunnel' API.
Configure Devbox lifecycle based on idle activity. If after_idle is set, Devbox will ignore keep_alive_time_seconds.
Show child attributes
After idle_time_seconds, on_idle action will be taken.
Action to take after Devbox becomes idle.
shutdown, suspend custom resource size, number of cpu cores, must be multiple of 2. Min is 1, max is 16.
custom memory size, number in GiB, must be a multiple of 2. Min is 2GiB, max is 64GiB.
custom disk size, number in GiB, must be a multiple of 2. Min is 2GiB, max is 64GiB.
The target architecture for the Devbox. If unset, defaults to x86_64.
x86_64, arm64 Specify the user for execution on Devbox. If not set, default user will be used.
A list of ContainerizedService names to be started when a Devbox is created. A valid ContainerizedService must be specified in Blueprint to be started.
The working directory where the agent is expected to fulfill the scenario. Scoring functions also run from the working directory.
Was this page helpful?