Debug / getDebugSessions
TypeScript
Retrieve information about running debug sessions. If the requested session wasn't returned, it means it doesn't exist (or you don't have access to it).
Request parameters
{
/** Which sessions to fetch. If unspecified, all sessions will be fetched. */
debugSessionIds?: string[]
}Response
{
/** If successful. One of "result" and "error" will be present. */
result?: {
debugSessions: {
id: string,
startedAt: number,
modelId: string,
parameterDefinitions: ParameterDefinitions,
trainingSessions: {
id: string,
createdAt: number,
state: 'starting' | 'running' | 'completed' | 'failed'
}[],
executionLocation: {
type: 'persistentLauncher',
persistentLauncherId: string,
spec: LauncherSpec
} | {
type: 'temporaryLauncher',
spec: LauncherSpec
}
}[]
},
/** If failed */
error?: {
code: 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
} | {
code: 'invalid_parameter',
parameterName: string,
reason: string
}
}Where "ParameterDefinitions" is defined as:
export type ParameterDefinitions = {
createState: DecthingsParameterDefinition,
train: DecthingsParameterDefinition,
evaluateInput: DecthingsParameterDefinition,
evaluateOutput: DecthingsParameterDefinition
}Example
Following the installation guide to setup the Decthings API for TypeScript. Add your parameters to the following code and run it in Node.js, or in a browser by using a bundler.
The code reads your API key from file. Create an API key and save it to the file "auth.txt". Keep your key safe!
import * as fs from 'fs'
import { DecthingsClient } from '@decthings/api-client'
let apiKey = fs.readFileSync('./auth.txt').toString().trim()
let client = new DecthingsClient({ apiKey })
async function main() {
try {
let response = await client.debug.getDebugSessions()
if (result.error) {
// Decthings sent us an error
console.log(response.error)
} else {
// Success!
console.log(response.result)
}
}
catch (e) {
// Client throws an error on connection issues. The function may or may not have succeded
console.log(e)
}
}
main()