Skip to content

Commit

Permalink
docs(ai-setup-wizard): AI Setup Wizard
Browse files Browse the repository at this point in the history
  • Loading branch information
rohalskyy committed Jan 8, 2025
1 parent 7d377db commit c667134
Show file tree
Hide file tree
Showing 15 changed files with 219 additions and 7 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: AI Fine-tuning
description: Refine AI models with fine-tuning for improved localization results
slug: ai-fine-tuning
sidebar:
order: 2
order: 3
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
Expand Down
106 changes: 106 additions & 0 deletions src/content/docs/crowdin/translation-process/ai-setup-wizard.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
title: AI Setup Wizard
description: Quickly configure AI features in Crowdin using the AI Setup Wizard
slug: ai-setup-wizard
sidebar:
order: 2
---

import { Image } from 'astro:assets';
import { Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
import ReadMore from '~/components/ReadMore.astro';
import { Icon } from 'astro-icon/components';
import QuestionAnswer from '~/components/QuestionAnswer.astro';
import features from '!/crowdin/translation-process/ai_setup_wizard_features.png';
import providers from '!/crowdin/translation-process/ai_setup_wizard_providers.png';
import summary from '!/crowdin/translation-process/ai_setup_wizard_summary.png';

The AI Setup Wizard simplifies and speeds up the configuration of Crowdin AI, allowing you to leverage AI-powered translations that adapt to various levels of context. With just a few steps, you can enable AI Pre-translate to apply these translations to your content or use AI as an assistant in the Editor for translation, proofreading, and more.

Designed to get you started quickly, the wizard guides you through selecting needed features, configuring providers, and automatically creating AI prompts for the selected features.

<ReadMore>
To further customize settings, read more about [configuring AI prompts](/crowdin-ai/#configuring-ai).
</ReadMore>

## When to Use the AI Setup Wizard

You’ll see a **Start Using Crowdin AI Right Now!** banner if you haven’t configured your prompts yet. Click the **AI Setup Wizard** button to begin configuring Crowdin AI.

If you’ve dismissed the banner, you can still access the wizard using the following URL (replace `{your-crowdin-username}` with your actual Crowdin username):

```
https://crowdin.com/profile/{your-crowdin-username}/ai/wizard
```

## Selecting AI Features

On the **Features** step, select the AI functionalities you'd like to enable in your Crowdin projects:

* **AI Pre-translate** &ndash; Automatically pre-translate strings with contextual awareness.
* **AI in Editor** &ndash; Provides translators with AI-powered assistance.
* *Show AI Suggestions:* Displays AI suggestions along with TM and MT suggestions.
<Aside>
Enabling AI suggestions may increase token usage, depending on your provider.
</Aside>

Once you select the needed features, Crowdin will create AI prompts for them. You can adjust these prompts later in the **AI > Prompts** settings if needed.

<Image src={features} alt="Selecting AI Features" />

## Configuring AI Providers

On the **Provider Setup** step, choose an AI provider and configure the credentials:

<Steps>
1. Select a provider from the **AI Provider** drop-down menu.
2. Click <Icon name="mdi:plus" class="inline-icon" /> to explore and add more providers from the [Crowdin Store](https://store.crowdin.com/) if needed.
3. Choose how to manage your credentials:
* **I have my own API key** &ndash; Recommended for enhanced privacy and ownership.
* **Managed by Crowdin** &ndash; Ideal for testing or smaller volumes.
<Aside>This option requires a sufficient [account balance](/crowdin-managed-services/#adding-funds-to-account-balance). You can add funds during setup or manage your balance later in **Account Settings > Billing > Crowdin Managed Services**.</Aside>
</Steps>

After selecting and configuring your provider, click **Continue** to proceed to the final step.

<Image src={providers} alt="Configuring AI Providers" />

## Setup Summary

The final step provides a summary of the AI features and settings configured for your projects:

* **Pre-translate with AI** &ndash; Available in the Pre-translate menu and the Editor.
* **AI in the Editor** &ndash; Enables the AI Assistant for translators working on strings.
* **AI Suggestions** &ndash; Available in the Editor along with TM and MT suggestions.

To complete the setup, click **Got It!**.

<Image src={summary} alt="Finalizing Setup" />

### Add Context for Better Translations

AI performs best when provided with sufficient contextual information. Crowdin supports multiple levels of context to improve translation accuracy:

* **String level** &ndash; Includes terminology, context, and TM data.
* **File level** &ndash; Includes descriptions, file names, and the file's overall context.
* **Project level** &ndash; Includes a high-level description of the ongoing project.

## Best Practices for Setting Up Crowdin AI

Follow these best practices to optimize your Crowdin AI setup and ensure smooth operation:

* **Adjust Settings to Your Needs** &ndash; You can revisit the AI settings anytime to enable or disable features, switch providers, or modify prompts.
* **Monitor Usage and Costs** &ndash; If using a managed AI service, track your balance and billing to avoid disruptions. <ReadMore>Read more about [Using Crowdin Managed Services](/crowdin-managed-services/#using-crowdin-managed-services).</ReadMore>
* **Enhance Security** &ndash; For better control over data privacy and ownership, consider using your own API key.

## Q&A

<QuestionAnswer title="Which AI features do I have to enable?">
You can pick and choose which features best suit your workflow. Some teams only need AI Pre-translate, while others want AI assistant and suggestions in the Editor as well.
</QuestionAnswer>
<QuestionAnswer title="Can I modify the prompts later?">
Absolutely. You can [edit or replace](/crowdin-ai/#editing-ai-prompts) your initial prompts anytime within the **AI > Prompts** page.
</QuestionAnswer>
<QuestionAnswer title="Can I try Crowdin AI using the Managed by Crowdin option and later switch to my own credentials?">
Yes. You can start with the Managed by Crowdin option to test AI features and later switch to using your own API key. Simply [update your credentials](/crowdin-ai/#configuring-ai-providers) within the **AI > Providers** page.
</QuestionAnswer>
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Offline Translation
description: Downloading and uploading files for offline translation
slug: offline-translation
sidebar:
order: 5
order: 6
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Ordering Professional Translations
description: Order professional translations from vendors directly in Crowdin
slug: ordering-professional-translations
sidebar:
order: 4
order: 5
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Pre-Translation
description: Speed up the translation process and ease the work of translators
slug: pre-translation
sidebar:
order: 3
order: 4
---

import { Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: AI Fine-tuning
description: Refine AI models with fine-tuning for improved localization results
slug: enterprise/ai-fine-tuning
sidebar:
order: 2
order: 3
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
Expand Down
106 changes: 106 additions & 0 deletions src/content/docs/enterprise/translation-process/ai-setup-wizard.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
title: AI Setup Wizard
description: Quickly configure AI features in Crowdin Enterprise using the AI Setup Wizard
slug: enterprise/ai-setup-wizard
sidebar:
order: 2
---

import { Image } from 'astro:assets';
import { Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
import ReadMore from '~/components/ReadMore.astro';
import { Icon } from 'astro-icon/components';
import QuestionAnswer from '~/components/QuestionAnswer.astro';
import features from '!/enterprise/translation-process/ai_setup_wizard_features.png';
import providers from '!/enterprise/translation-process/ai_setup_wizard_providers.png';
import summary from '!/enterprise/translation-process/ai_setup_wizard_summary.png';

The AI Setup Wizard simplifies and speeds up the configuration of Crowdin AI, allowing you to leverage AI-powered translations that adapt to various levels of context. With just a few steps, you can enable AI Pre-translate to apply these translations to your content or use AI as an assistant in the Editor for translation, proofreading, and more.

Designed to get you started quickly, the wizard guides you through selecting needed features, configuring providers, and automatically creating AI prompts for the selected features.

<ReadMore>
To further customize settings, read more about [configuring AI prompts](/enterprise/crowdin-ai/#configuring-ai).
</ReadMore>

## When to Use the AI Setup Wizard

You’ll see a **Start Using Crowdin AI Right Now!** banner if you haven’t configured your prompts yet. Click the **AI Setup Wizard** button to begin configuring Crowdin AI.

If you’ve dismissed the banner, you can still access the wizard using the following URL (replace `{your-crowdin-username}` with your actual Crowdin Enterprise username):

```
https://crowdin.com/profile/{your-crowdin-username}/ai/wizard
```

## Selecting AI Features

On the **Features** step, select the AI functionalities you'd like to enable in your Crowdin Enterprise projects:

* **AI Pre-translate** &ndash; Automatically pre-translate strings with contextual awareness.
* **AI in Editor** &ndash; Provides translators with AI-powered assistance.
* *Show AI Suggestions:* Displays AI suggestions along with TM and MT suggestions.
<Aside>
Enabling AI suggestions may increase token usage, depending on your provider.
</Aside>

Once you select the needed features, Crowdin Enterprise will create AI prompts for them. You can adjust these prompts later in the **AI > Prompts** settings if needed.

<Image src={features} alt="Selecting AI Features" />

## Configuring AI Providers

On the **Provider Setup** step, choose an AI provider and configure the credentials:

<Steps>
1. Select a provider from the **AI Provider** drop-down menu.
2. Click <Icon name="mdi:plus" class="inline-icon" /> to explore and add more providers from the [Crowdin Store](https://store.crowdin.com/) if needed.
3. Choose how to manage your credentials:
* **I have my own API key** &ndash; Recommended for enhanced privacy and ownership.
* **Managed by Crowdin** &ndash; Ideal for testing or smaller volumes.
<Aside>This option requires a sufficient [account balance](/enterprise/crowdin-managed-services/#adding-funds-to-account-balance). You can add funds during setup or manage your balance later in **Organization Settings > Billing > Crowdin Managed Services**.</Aside>
</Steps>

After selecting and configuring your provider, click **Continue** to proceed to the final step.

<Image src={providers} alt="Configuring AI Providers" />

## Setup Summary

The final step provides a summary of the AI features and settings configured for your projects:

* **Pre-translate with AI** &ndash; Available in the Pre-translate menu and the Editor.
* **AI in the Editor** &ndash; Enables the AI Assistant for translators working on strings.
* **AI Suggestions** &ndash; Available in the Editor along with TM and MT suggestions.

To complete the setup, click **Got It!**.

<Image src={summary} alt="Finalizing Setup" />

### Add Context for Better Translations

AI performs best when provided with sufficient contextual information. Crowdin supports multiple levels of context to improve translation accuracy:

* **String level** &ndash; Includes terminology, context, and TM data.
* **File level** &ndash; Includes descriptions, file names, and the file's overall context.
* **Project level** &ndash; Includes a high-level description of the ongoing project.

## Best Practices for Setting Up Crowdin AI

Follow these best practices to optimize your Crowdin AI setup and ensure smooth operation:

* **Adjust Settings to Your Needs** &ndash; You can revisit the AI settings anytime to enable or disable features, switch providers, or modify prompts.
* **Monitor Usage and Costs** &ndash; If using a managed AI service, track your balance and billing to avoid disruptions. <ReadMore>Read more about [Using Crowdin Managed Services](/enterprise/crowdin-managed-services/#using-crowdin-managed-services).</ReadMore>
* **Enhance Security** &ndash; For better control over data privacy and ownership, consider using your own API key.

## Q&A

<QuestionAnswer title="Which AI features do I have to enable?">
You can pick and choose which features best suit your workflow. Some teams only need AI Pre-translate, while others want AI assistant and suggestions in the Editor as well.
</QuestionAnswer>
<QuestionAnswer title="Can I modify the prompts later?">
Absolutely. You can [edit or replace](/enterprise/crowdin-ai/#editing-ai-prompts) your initial prompts anytime within the **AI > Prompts** page.
</QuestionAnswer>
<QuestionAnswer title="Can I try Crowdin AI using the Managed by Crowdin option and later switch to my own credentials?">
Yes. You can start with the Managed by Crowdin option to test AI features and later switch to using your own API key. Simply [update your credentials](/enterprise/crowdin-ai/#configuring-ai-providers) within the **AI > Providers** page.
</QuestionAnswer>
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Offline Translation
description: Downloading and uploading files for offline translation
slug: enterprise/offline-translation
sidebar:
order: 4
order: 5
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Pre-Translation
description: Speed up the translation process and ease the work of translators
slug: enterprise/pre-translation
sidebar:
order: 3
order: 4
---

import { Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
Expand Down

0 comments on commit c667134

Please sign in to comment.