@agnocon/piece-camb-ai 0.1.7

package/src/lib/actions/create-transcription.ts

@@ -0,0 +1,132 @@
+import { createAction, Property, ApFile, DynamicPropsValue } from '@agnocon/pieces-framework';
+import { HttpMethod, httpClient, HttpMessageBody, HttpHeaders } from '@agnocon/pieces-common';
+import { cambaiAuth } from '../auth';
+import { API_BASE_URL, listSourceLanguagesDropdown, POLLING_INTERVAL_MS, LONG_MAX_POLLING_ATTEMPTS } from '../common';
+import FormData from 'form-data';
+import { listFoldersDropdown } from '../common';
+
+export const createTranscription = createAction({
+    auth: cambaiAuth,
+    name: 'create_transcription',
+    displayName: 'Create Transcription',
+    description: 'Creates a task to process speech into readable text.',
+    audience: 'both',
+    aiMetadata: { description: 'Transcribes speech from an audio/video source into text via Camb.AI, polling until the transcription task completes. The media can be supplied either as an uploaded file (max 20MB) or as a public file URL, selected via the media source mode; you must specify the spoken language. Use to convert recorded speech to text. Not idempotent: each call starts a new transcription task.', idempotent: false },
+    props: {
+        language: listSourceLanguagesDropdown,
+        source_type: Property.StaticDropdown({
+            displayName: 'Media Source',
+            description: 'Choose whether to upload a file or provide a URL.',
+            required: true,
+            defaultValue: 'file',
+            options: {
+                options: [
+                    { label: 'Upload File', value: 'file' },
+                    { label: 'File URL', value: 'url' },
+                ]
+            },
+        }),
+        media: Property.DynamicProperties({
+            auth: cambaiAuth,
+            displayName: 'Media',
+            required: true,
+            refreshers: ['source_type'],
+            props: async (context) => {
+                const sourceType = (context['source_type'] as unknown as string);
+                const fields: DynamicPropsValue = {};
+                if (sourceType === 'file') {
+                    fields['media_file'] = Property.File({
+                        displayName: 'Media File',
+                        description: 'The media file (e.g., MP3, WAV, MP4) to transcribe. Max size: 20MB.',
+                        required: true,
+                    });
+                } else if (sourceType === 'url') {
+                    fields['media_url'] = Property.ShortText({
+                        displayName: 'Media URL',
+                        description: 'A public URL to the media file to transcribe.',
+                        required: true,
+                    });
+                }
+                return fields;
+            }
+        }),
+        project_name: Property.ShortText({
+            displayName: 'Project Name',
+            description: 'A memorable name for your project to help organize tasks in your Camb.ai workspace.',
+            required: false,
+        }),
+        project_description: Property.LongText({
+            displayName: 'Project Description',
+            description: 'Provide details about your project\'s goals and specifications for documentation purposes.',
+            required: false,
+        }),
+        folder_id: listFoldersDropdown,
+    },
+    async run(context) {
+        const { auth } = context;
+        const { language, source_type, media, project_name, project_description, folder_id } = context.propsValue;
+
+        const formData = new FormData();
+        
+        formData.append('language', Number(language).toString());
+        if (project_name) formData.append('project_name', project_name);
+        if (project_description) formData.append('project_description', project_description);
+        if (folder_id) formData.append('folder_id', folder_id.toString());
+
+        if (source_type === 'url') {
+            if (!media['media_url']) throw new Error("Media URL is required when source is 'File URL'.");
+            formData.append('media_url', media['media_url'] as string);
+        } else {
+            if (!media['media_file']) throw new Error("Media File is required when source is 'Upload File'.");
+            const fileData = media['media_file'] as ApFile;
+            formData.append('media_file', fileData.data, fileData.filename);
+        }
+        
+
+        const requestBody = await formData.getBuffer();
+        const headers: HttpHeaders = {
+            'x-api-key': auth.secret_text,
+            ...formData.getHeaders(),
+        };
+
+        const initialResponse = await httpClient.sendRequest<{ task_id: string }>({
+            method: HttpMethod.POST,
+            url: `${API_BASE_URL}/transcribe`,
+            headers: headers,
+            body: requestBody, 
+        });
+        const taskId = initialResponse.body.task_id;
+        let run_id: string | null = null;
+
+        let attempts = 0;
+        while (attempts < LONG_MAX_POLLING_ATTEMPTS) {
+            const statusResponse = await httpClient.sendRequest<{ status: string; run_id?: string }>({
+                method: HttpMethod.GET,
+                url: `${API_BASE_URL}/transcribe/${taskId}`,
+                headers: { 'x-api-key': auth.secret_text },
+            });
+
+            if (statusResponse.body.status === 'SUCCESS') {
+                run_id = statusResponse.body.run_id ?? null;
+                break;
+            }
+            if (statusResponse.body.status === 'FAILED') {
+                throw new Error(`Transcription task failed: ${JSON.stringify(statusResponse.body)}`);
+            }
+            await new Promise(resolve => setTimeout(resolve, POLLING_INTERVAL_MS));
+            attempts++;
+        }
+
+        if (!run_id) {
+            throw new Error("Transcription task timed out or failed to return a task_id.");
+        }
+        const resultResponse = await httpClient.sendRequest<{ transcriptions: string[] }>({
+            method: HttpMethod.GET,
+            url: `${API_BASE_URL}/transcription-result/${run_id}`,
+            headers: { 'x-api-key': auth.secret_text },
+        });
+
+        return resultResponse.body;
+       
+    },
+});

package/src/lib/actions/create-translation.ts

@@ -0,0 +1,115 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { HttpMethod, httpClient } from '@agnocon/pieces-common';
+import { cambaiAuth } from '../auth';
+import { API_BASE_URL, listSourceLanguagesDropdown, listTargetLanguagesDropdown ,POLLING_INTERVAL_MS,MAX_POLLING_ATTEMPTS} from '../common';
+
+export const createTranslation = createAction({
+    auth: cambaiAuth,
+    name: 'create_translation',
+    displayName: 'Create Translation',
+    description: 'Translate text from a source language to a target language.',
+    audience: 'both',
+    aiMetadata: { description: 'Translates text from a source language to a target language via Camb.AI, polling until the translation task completes. Each input line is treated as a separate segment to translate, and both languages are chosen from Camb.AI dropdowns; optionally tune formality, gender, and target audience age. Use for text translation only (not audio — use Create Transcription for speech-to-text). Not idempotent: each call starts a new translation task.', idempotent: false },
+    props: {
+        texts: Property.LongText({
+            displayName: 'Text to Translate',
+            description: 'The text to be translated. You can enter multiple lines; each line will be treated as a separate text segment.',
+            required: true,
+        }),
+        source_language: listSourceLanguagesDropdown,
+        target_language: listTargetLanguagesDropdown,
+        formality: Property.StaticDropdown({
+            displayName: 'Formality',
+            description: 'Adjust the formality level to match your context.',
+            required: false,
+            options: {
+                options: [
+                    { label: 'Formal', value: 1 },
+                    { label: 'Informal', value: 2 },
+                ]
+            }
+        }),
+        gender: Property.StaticDropdown({
+            displayName: 'Gender',
+            description: 'Specify grammatical gender preferences when relevant in the target language.',
+            required: false,
+            options: {
+                options: [
+                    { label: 'Male', value: 1 },
+                    { label: 'Female', value: 2 },
+                    { label: 'Neutral', value: 0 },
+                    { label: 'Unspecified', value: 9 },
+                ],
+            }
+        }),
+        age: Property.Number({
+            displayName: 'Audience Age',
+            description: 'Helps adjust vocabulary and expressions to be age-appropriate.',
+            required: false,
+        }),
+        project_name: Property.ShortText({
+            displayName: 'Project Name',
+            description: 'A memorable name for your project to help organize tasks in your Camb.ai workspace.',
+            required: false,
+        }),
+    },
+    async run(context) {
+        const { auth } = context;
+        const { texts, source_language, target_language, formality, gender, age, project_name } = context.propsValue;
+
+        const payload: Record<string, unknown> = {
+            texts: texts.split('\n').filter(line => line.trim().length > 0),
+            source_language: Number(source_language),
+            target_language: Number(target_language),
+        };
+        if (formality !== undefined) payload['formality'] = formality;
+        if (gender !== undefined) payload['gender'] = gender;
+        if (age) payload['age'] = age;
+        if (project_name) payload['project_name'] = project_name;
+
+        const initialResponse = await httpClient.sendRequest<{ task_id: string }>({
+            method: HttpMethod.POST,
+            url: `${API_BASE_URL}/translate`,
+            headers: { 'x-api-key': auth.secret_text, 'Content-Type': 'application/json' },
+            body: payload,
+        });
+        const taskId = initialResponse.body.task_id;
+        let run_id: string | null = null;
+        
+        let attempts = 0;
+        while (attempts < MAX_POLLING_ATTEMPTS) {
+            const statusResponse = await httpClient.sendRequest<{ status: string; run_id?: string }>({
+                method: HttpMethod.GET,
+                url: `${API_BASE_URL}/translate/${taskId}`,
+                headers: { 'x-api-key': auth.secret_text },
+            });
+          
+            if (statusResponse.body.status === 'SUCCESS') {
+
+                run_id = statusResponse.body.run_id ?? null;
+                break;
+            }
+            if (statusResponse.body.status === 'ERROR' || statusResponse.body.status === 'FAILED') {
+
+                throw new Error(`Translation task failed: ${JSON.stringify(statusResponse.body)}`);
+            }
+            await new Promise(resolve => setTimeout(resolve, POLLING_INTERVAL_MS));
+            attempts++;
+        }
+        
+
+        if (!run_id) {
+            throw new Error("Translation task timed out or failed to return a task_id.");
+        }
+
+        const resultResponse = await httpClient.sendRequest<{ translations: string[] }>({
+            method: HttpMethod.GET,
+            url: `${API_BASE_URL}/translation-result/${run_id}`,
+            headers: { 'x-api-key': auth.secret_text },
+        }); 
+
+        return resultResponse.body;
+
+        
+    },
+});

package/src/lib/auth.ts

@@ -0,0 +1,34 @@
+import { PieceAuth } from '@agnocon/pieces-framework';
+import { httpClient, HttpMethod } from '@agnocon/pieces-common';
+import { API_BASE_URL } from './common';
+
+export const cambaiAuth = PieceAuth.SecretText({
+    displayName: "API Key",
+    description: `
+    To get your API key, please follow these steps:
+    1. Log in to your [CAMB.AI Studio](https://camb.ai/studio/) account.
+    2. Navigate to your workspace's API Keys dashboard.
+    3. Create a new key if you haven't already.
+    4. Copy the API key and paste it here.
+    `,
+    required: true,
+    validate: async ({ auth }) => {
+        try {
+            await httpClient.sendRequest({
+                method: HttpMethod.GET,
+                url: `${API_BASE_URL}/source-languages`,
+                headers: {
+                    'x-api-key': auth,
+                }
+            });
+            return {
+                valid: true,
+            };
+        } catch (e) {
+            return {
+                valid: false,
+                error: 'Invalid API Key.',
+            };
+        }
+    }
+});

package/src/lib/common/index.ts

@@ -0,0 +1,165 @@
+import { Property } from "@agnocon/pieces-framework";
+import { HttpMethod, httpClient } from "@agnocon/pieces-common";
+import { cambaiAuth } from '../auth';
+
+
+export const API_BASE_URL = "https://client.camb.ai/apis";
+export const POLLING_INTERVAL_MS = 5000;
+export const LONG_POLLING_INTERVAL_MS = 10000;
+export const MAX_POLLING_ATTEMPTS = 10;
+export const LONG_MAX_POLLING_ATTEMPTS = 120;
+
+type Voice = {
+    id: number;
+    voice_name: string;
+};
+
+type Folder = {
+    folder_id: number;
+    folder_name: string;
+};
+
+type Language = {
+    id: number;
+    language: string;
+    short_name: string;
+};
+
+
+export const listVoicesDropdown = Property.Dropdown({
+    auth: cambaiAuth,
+    displayName: 'Voice',
+    description: 'Select the voice to generate the speech.',
+    required: true,
+    refreshers: [],
+    options: async ({ auth }) => {
+        if (!auth) {
+            return {
+                disabled: true,
+                options: [],
+                placeholder: 'Please authenticate first',
+            };
+        }
+        const response = await httpClient.sendRequest<Voice[]>({
+            method: HttpMethod.GET,
+            url: `${API_BASE_URL}/list-voices`,
+            headers: {
+                'x-api-key': auth.secret_text,
+            },
+        });
+        const voices = response.body ?? [];
+        return {
+            disabled: false,
+            options: voices.map((voice) => ({
+                label: voice.voice_name,
+                value: voice.id,
+            })),
+        };
+    },
+});
+
+
+export const listSourceLanguagesDropdown = Property.Dropdown({
+    auth: cambaiAuth,
+    displayName: 'Source Language',
+    description: 'Select the original language of the input text.',
+    required: true,
+    refreshers: [],
+    options: async ({ auth }) => {
+        if (!auth) {
+            return {
+                disabled: true,
+                options: [],
+                placeholder: 'Please authenticate first',
+            };
+        }
+        const response = await httpClient.sendRequest<Language[]>({
+            method: HttpMethod.GET,
+            url: `${API_BASE_URL}/source-languages`,
+            headers: {
+                'x-api-key': auth.secret_text,
+            },
+        });
+        const languages = response.body ?? [];
+        return {
+            disabled: false,
+            options: languages.map((lang) => ({
+                label: `${lang.language} (${lang.short_name})`,
+                value: lang.id,
+            })),
+        };
+    },
+});
+
+
+export const listTargetLanguagesDropdown = Property.Dropdown({
+    displayName: 'Target Language',
+    description: 'Select the language to translate the text into.',
+    auth: cambaiAuth,
+    required: true,
+    refreshers: [],
+    options: async ({ auth }) => {
+        if (!auth) {
+            return {
+                disabled: true,
+                options: [],        
+                placeholder: 'Please authenticate first',
+            };
+        }
+        const response = await httpClient.sendRequest<Language[]>({
+            method: HttpMethod.GET,
+            url: `${API_BASE_URL}/target-languages`,
+            headers: {
+                'x-api-key': auth.secret_text,
+            },
+        });
+        const languages = response.body ?? [];
+        return {
+            disabled: false,
+            options: languages.map((lang) => ({
+                label: `${lang.language} (${lang.short_name})`,
+                value: lang.id,
+            })),
+        };
+    },
+});
+
+export const listFoldersDropdown = Property.Dropdown({
+    displayName: 'Folder',
+    auth: cambaiAuth,
+    description: 'Select the folder to save the task in.',
+    required: false,
+    refreshers: [],
+    options: async ({ auth }) => {
+        if (!auth) {
+            return {
+                disabled: true,
+                options: [],
+                placeholder: 'Please authenticate first',
+            };
+        }
+        try {
+            const response = await httpClient.sendRequest<Folder[]>({
+                method: HttpMethod.GET,
+                url: `${API_BASE_URL}/folders`, 
+                headers: {
+                    'x-api-key': auth.secret_text,
+                },
+            });
+            const folders = response.body ?? [];
+            return {
+                disabled: false,
+                options: folders.map((folder) => ({
+                    label: folder.folder_name,
+                    value: folder.folder_id,
+                })),
+            };
+        } catch (error) {
+            return {
+                disabled: true,
+                options: [],
+                placeholder: "Could not load folders."
+            }
+        }
+    },
+});