import app from "../../scale_ai.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";
export default {
key: "scale_ai-create-text-annotation-task",
name: "Create Text Annotation Task",
description: "Create a text annotation task. [See the documentation](https://docs.scale.com/reference/text-collection)",
type: "action",
version: "0.0.2",
props: {
app,
project: {
propDefinition: [
app,
"project",
],
},
batch: {
propDefinition: [
app,
"batch",
],
},
instruction: {
propDefinition: [
app,
"instruction",
],
},
callbackUrl: {
propDefinition: [
app,
"callbackUrl",
],
},
title: {
type: "string",
label: "Title",
description: "The title of the task to be shown to scalers.",
optional: true,
},
description: {
type: "string",
label: "Description",
description: "The description of the task to be shown to scalers.",
optional: true,
},
responsesRequired: {
type: "integer",
label: "Responses Required",
description: "The number of responses required for the task to build consensus before returning the callback response. Upper bound of 100.",
optional: true,
},
priority: {
propDefinition: [
app,
"priority",
],
},
uniqueId: {
propDefinition: [
app,
"uniqueId",
],
},
clearUniqueIdOnError: {
type: "boolean",
label: "Clear Unique ID on Error",
description: "If set to be true, if a task errors out after being submitted, the **Unique ID** on the task will be unset. This param allows workflows where you can re-submit the same **Unique ID** to recover from errors automatically.",
optional: true,
},
numberOfFields: {
type: "integer",
label: "Number of Fields",
description: "The number of fields to be labeled",
default: 1,
reloadProps: true,
},
numberOfAttachments: {
type: "integer",
label: "Number of Attachments",
description: "The number of attachments to be labeled",
default: 1,
reloadProps: true,
},
},
methods: {
choiceFieldsPropsMapper(prefix) {
const {
[`${prefix}label`]: label,
[`${prefix}value`]: value,
[`${prefix}hint`]: hint,
} = this;
return {
label,
value,
hint,
};
},
getChoiceFieldPropDefinitions({
prefix, label,
} = {}) {
return {
[`${prefix}label`]: {
type: "string",
label: `${label} - Label`,
description: "The label of the choice.",
},
[`${prefix}value`]: {
type: "string",
label: `${label} - Value`,
description: "The value of the choice.",
},
[`${prefix}hint`]: {
type: "string",
label: `${label} - Hint`,
description: "The hint of the choice.",
optional: true,
},
};
},
fieldsPropsMapper(prefix) {
const {
[`${prefix}type`]: type,
[`${prefix}fieldId`]: fieldId,
[`${prefix}title`]: title,
[`${prefix}numberOfChoices`]: numberOfChoices,
choiceFieldsPropsMapper,
} = this;
return {
type,
field_id: fieldId,
title,
choices: utils.getFieldsProps({
numberOfFields: numberOfChoices,
fieldName: "choice",
prefix,
propsMapper: choiceFieldsPropsMapper,
}),
};
},
getFieldsPropDefinitions({
prefix,
label,
} = {}) {
const {
[`${prefix}numberOfChoices`]: numberOfChoices,
getChoiceFieldPropDefinitions,
} = this;
return {
[`${prefix}type`]: {
type: "string",
label: `${label} - Type`,
description: "The type of field to be labeled.",
optional: true,
options: Object.values(constants.FIELD_CHOICE_TYPE),
},
[`${prefix}fieldId`]: {
type: "string",
label: `${label} - Field ID`,
description: "A unique identifier for the field.",
optional: true,
},
[`${prefix}title`]: {
type: "string",
label: `${label} - Title`,
description: "The title of the field.",
optional: true,
},
[`${prefix}numberOfChoices`]: {
type: "integer",
label: `${label} - Number of Choices`,
description: "The number of choices for the field.",
optional: true,
default: 1,
reloadProps: true,
},
...utils.getAdditionalProps({
numberOfFields: numberOfChoices,
fieldName: "choice",
prefix,
label,
getPropDefinitions: getChoiceFieldPropDefinitions,
}),
};
},
attachmentsPropsMapper(prefix) {
const {
[`${prefix}type`]: type,
[`${prefix}content`]: content,
} = this;
return {
type,
content,
};
},
getAttachmentsPropDefinitions({
prefix,
label,
} = {}) {
return {
[`${prefix}type`]: {
type: "string",
label: `${label} - Type`,
description: "The type of attachment. See [TextCollectionAttachment](https://docs.scale.com/reference/textcollectionattachment). One of `pdf`, `image`, `text`, `video`, `website`, or `audio`.",
optional: true,
options: Object.values(constants.ATTACHMENT_TYPE),
},
[`${prefix}content`]: {
type: "string",
label: `${label} - Content`,
description: "The content of the attachment. See [TextCollectionAttachment](https://docs.scale.com/reference/textcollectionattachment).",
optional: true,
},
};
},
createTextAnnotationTask(args = {}) {
return this.app.post({
path: "/task/textcollection",
...args,
});
},
},
async additionalProps() {
const {
numberOfFields,
numberOfAttachments,
getFieldsPropDefinitions,
getAttachmentsPropDefinitions,
} = this;
const fields = utils.getAdditionalProps({
numberOfFields,
fieldName: "field",
getPropDefinitions: getFieldsPropDefinitions,
});
const attachments = utils.getAdditionalProps({
numberOfFields: numberOfAttachments,
fieldName: "attachment",
getPropDefinitions: getAttachmentsPropDefinitions,
});
return {
...fields,
...attachments,
};
},
async run({ $: step }) {
const {
createTextAnnotationTask,
project,
batch,
instruction,
callbackUrl,
title,
description,
responsesRequired,
priority,
uniqueId,
clearUniqueIdOnError,
numberOfFields,
fieldsPropsMapper,
numberOfAttachments,
attachmentsPropsMapper,
} = this;
const response = await createTextAnnotationTask({
step,
data: {
project,
batch,
instruction,
callback_url: callbackUrl,
title,
description,
responses_required: responsesRequired,
priority,
unique_id: uniqueId,
clear_unique_id_on_error: clearUniqueIdOnError,
fields: utils.getFieldsProps({
numberOfFields,
fieldName: "field",
propsMapper: fieldsPropsMapper,
}),
attachments: utils.getFieldsProps({
numberOfFields: numberOfAttachments,
fieldName: "attachment",
propsMapper: attachmentsPropsMapper,
}),
},
});
step.export("$summary", `Successfully created text annotation task with ID \`${response.task_id}\``);
return response;
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.