Debug / getTrainingStatus
TypeScript
Retrieve the status of a training session in a debug session.
Request parameters
{
/** The debug session's id. */
debugSessionId: string,
/** Training session identifier, as returned by the 'callTrain' function. */
trainingSessionId: string
}
Response
{
/** If successful. One of "result" and "error" will be present. */
result?: {
id: string,
createdAt: number,
metrics: {
name: string,
amount: number
}[],
status: {
state: 'running',
progress: number
} | {
state: 'completed',
finishedAt: number,
trainDuration: number
} | {
state: 'failed',
finishedAt: number,
trainDuration?: number,
failReason: {
code: 'unknown' | 'cancelled' | 'max_duration_exceeded'
} | {
code: 'exception',
exceptionDetails?: string
}
}
},
/** If failed */
error?: {
code: 'debug_session_not_found' | 'training_session_not_found' | 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
} | {
code: 'invalid_parameter',
parameterName: string,
reason: string
}
}
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.getTrainingStatus({
debugSessionId: /* Add debugSessionId here */,
trainingSessionId: /* Add trainingSessionId here */
})
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()