Follow

SDA - Changes to Annotation Tools' Job Report

As a result of the recent SDA upgrade, the job report of annotation tools has also been updated. This update affects all jobs using annotation tools, regardless of whether SDA has been set up for your team.

 

Change One

Previously, the output column of most annotation tools were URLs that point to the annotation results. After the update, the output column now contain json objects containing the URLs as well as a few metadata fields. Below is an example of the updated output:

 {"type":"audio_transcription","valueRef":"jobs/1756256/annotations/1bc9311e-1205-46bf-8afd-c005e28b70d1.json","url":"https://requestor-proxy.appen.com/v1/redeem_token?token=xMHOg2A/K+hcG1lRO4aZ2mmRwJIoV0q3ZgEJUAdq2N8jghbJ8KHelkcIZQlY9IIOa2QNW5KZaqkh6dAVzq0rt0z85ywsvloTiIEpAN3ax/GR0yGPmgPzU53ouQksaG+seXH9PPoLA21ilUXPhWgMQ7O6wHpJ4YxFQhB74XZCdQqzbKrl2iaPQsSfE3Ahuo1fbhGwFKPRDq9nru8vq3Qalc5x1AuHg10qW5JPh6MJtGOcY04L1iaoDN6QPprRDCt47u+I++lgm6ils6Kt2oILrSzWbOyw6BVwK7vIqPVkW0A3CYyAj/hHgOi4v+0qPTU735xPROo0GvSfg6p6XQ==--kwDu0HkOgyfCMytE--tgLpI/Z3NS/na2RWdB1LNg==&version=297"}

 

“type”: indicates the type of annotation tool

“valueRef”: the file reference that the platform uses to read data. This ref can be passed on from one job to another and will not expire

“url”: the URL that points to the annotation result. Different from the URLs in the current report, this URL requires user authentication. For example, the URL wouldn’t work if you open it in a new Incognito window. More details can be found in the “Change Two” section.

Some annotation tool’s output can also contain a “metadata” field. This field is designed to work with Workflows for routing purpose in the future.

 

Change Two

Previously, the URLs in the output column did not require authentication. You could open these links without having logged into your account. After the update, the URLs in the report now require authentication.

If you have scripts that operate on the output URLs, you will need to make the changes below to keep your script working:

To call - replace your requestor proxy hostname to api-gateway:

https://requestor-proxy.appen.com/v1/redeem_token?token=gSz/nU4ULsQjpetkA5l5V1ZXgt04exBEVr2DsgiqIsyvAd1QvnkiG9MQVhQXgGZmEpSS1E0EJd17QB4DNju1w8js45FOZq2xiV8zPdmKkgdjphrDRl3E8topXMp0PydXUkV32zre1HJnp4dN0M8ZyDu5V+hlVJ2wbuz83qh3+raRWU510imK53HVn/RTlplqld4lDdlWeR8aMljf/88RQpvuFhJk6ckixhZclOSi21Iq5POEn1xeJKcxzjY4TzCpQvFQYEGsKS4VEq+J9eVUxvDRUHoZxDRwv02Nc9Jg/ggbXEH7sxXPnA6zf3RVYlb8ZQ==--s5tHd/9d1AG1dASD--FtLuDsqPS8pa2CH7/p66Bg==&version=285

to this, and add the api key at the end:

https://api-beta.appen.com/v1/redeem_token?token=gSz/nU4ULsQjpetkA5l5V1ZXgt04exBEVr2DsgiqIsyvAd1QvnkiG9MQVhQXgGZmEpSS1E0EJd17QB4DNju1w8js45FOZq2xiV8zPdmKkgdjphrDRl3E8topXMp0PydXUkV32zre1HJnp4dN0M8ZyDu5V+hlVJ2wbuz83qh3+raRWU510imK53HVn/RTlplqld4lDdlWeR8aMljf/88RQpvuFhJk6ckixhZclOSi21Iq5POEn1xeJKcxzjY4TzCpQvFQYEGsKS4VEq+J9eVUxvDRUHoZxDRwv02Nc9Jg/ggbXEH7sxXPnA6zf3RVYlb8ZQ==--s5tHd/9d1AG1dASD--FtLuDsqPS8pa2CH7/p66Bg==&version=285&key=YOUR_API_KEY

Was this article helpful?
5 out of 5 found this helpful


Have more questions? Submit a request
Powered by Zendesk