AI Prompt Provider

The AI Prompt Provider module is designed to streamline the process of generating prompts for both custom and natively supported AI providers.

AI Prompt Provider Module Read more on the Crowdin Developer Portal.

Sample

index.js

const crowdinModule = require('@crowdin/app-project-module');
const {PromptActions} = require("@crowdin/app-project-module/out/modules/ai-prompt-provider/types");

const configuration = {
  baseUrl: 'https://123.ngrok.io',
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  name: 'Sample App',
  identifier: 'sample-app',
  description: 'Sample App description',
  dbFolder: __dirname,
  imagePath: __dirname + '/' + 'logo.png',
  aiPromptProvider: {
    actions: [PromptActions.PRE_TRANSLATE],
    allowRetryOnQaIssues: false,
    formSchema: {
      type: "object",
      properties: {
        firstOption: {
          title: "Option 1",
          type: "string"
        }
      },
      required: ['firstOption']
    },
    compile: async function({ options, payload, client, context, requestData }) {
      return 'Prompt text compiled based on options and payload';
    }
  }
};

crowdinModule.createApp(configuration);

Configuration

Parameter	Description
actions	An array of supported prompt actions. If not provided, all actions are supported. Available action types: pre_translate, assist, qa_check, custom:type-of-action.
allowRetryOnQaIssues	If false, disables auto-retry on QA issues in the user interface. Default: true.
formSchema	React JSON Schema for the form.
status	Optional handler that returns prompt status info (used providers, configuration state, errors/warnings). When provided, a statusUrl is automatically exposed in the manifest.

compile Function

Used to generate prompts based on the options and payload provided.

Parameters

• options - Options selected by the user.
• payload - Data provided by the AI provider.
• client - Crowdin API client.
• context - Context object.

Return Value

The function should return the prompt text.

status Function

Optional handler that returns prompt status information. When provided, Crowdin will call this endpoint to display real-time status for external prompts.

Parameters

• options - Options selected by the user.
• aiPromptId - The ID of the AI prompt.
• client - Crowdin API client.
• context - Context object.

Return Value

The function should return an object with the following properties:

Property	Type	Description
usedAiProviderIds	number[]	IDs of AI providers used by the prompt.
isConfigured	boolean	Whether the prompt is fully configured.
errors	Array<{ code: string; message: string }>	List of errors, if any.
warnings	Array<{ code: string; message: string }>	List of warnings, if any.

Example

index.js

const configuration = {
  // ... other configuration
  aiPromptProvider: {
    compile: async ({ options, payload }) => {
      return 'Prompt text';
    },
    status: async ({ options, aiPromptId, client, context }) => {
      return {
        usedAiProviderIds: [1, 2],
        isConfigured: true,
        errors: [],
        warnings: [],
      };
    }
  }
};

Multiple Prompt Providers

You can register multiple AI prompt providers in a single app by providing an array:

index.js

const { PromptActions } = require('@crowdin/app-project-module/out/modules/ai-prompt-provider/types');

const configuration = {
  // ... other configuration
  aiPromptProvider: [
    {
      name: 'Translation Prompt',
      actions: [PromptActions.PRE_TRANSLATE],
      compile: async ({ options, payload }) => {
        return 'Translate the following text: ' + payload;
      }
    },
    {
      name: 'QA Prompt',
      actions: [PromptActions.QA_CHECK],
      compile: async ({ options, payload }) => {
        return 'Check the quality of the following translation: ' + payload;
      }
    }
  ]
};