Dataset / getNeedsReviewEntries
TypeScript
Retrieve entries from the 'needs review' folder of a dataset.
Request parameters
{
/** The dataset's id. */
datasetId: string,
/** Which entries to fetch. Either an array of indexes or a start/end range. */
entries: number[] | {
start: number,
end: number
},
/**
* If specified, the operation will only be performed if the current dataset versionId is equal to the specified
* string.
*/
datasetVersionId?: string
}
Response
{
/** If successful. One of "result" and "error" will be present. */
result?: {
keys: {
name: string,
data: {
index: number,
data: DecthingsTensor
}[]
}[]
},
/** If failed */
error?: {
code: 'dataset_not_found' | 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
} | {
code: 'incorrect_version_id',
/** The correct current dataset version ID, which should be used instead. */
datasetVersionId: string
} | {
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.dataset.getNeedsReviewEntries({
datasetId: /* Add datasetId here */,
entries: /* Add entries 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()