-
Notifications
You must be signed in to change notification settings - Fork 174
docs: AI Setup Wizard #188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+59.3 KB
src/assets/screenshots/crowdin/translation-process/ai_setup_wizard_features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+51 KB
src/assets/screenshots/crowdin/translation-process/ai_setup_wizard_providers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+79.2 KB
src/assets/screenshots/crowdin/translation-process/ai_setup_wizard_summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+58.7 KB
src/assets/screenshots/enterprise/translation-process/ai_setup_wizard_features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+43.6 KB
...assets/screenshots/enterprise/translation-process/ai_setup_wizard_providers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+75.8 KB
src/assets/screenshots/enterprise/translation-process/ai_setup_wizard_summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
src/content/docs/crowdin/translation-process/ai-setup-wizard.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| ## Selecting AI Features | ||
|
|
||
| On the **Features** step, select the AI functionalities you'd like to enable in your Crowdin projects: | ||
|
|
||
| * **AI Pre-translate** – Automatically pre-translate strings with contextual awareness. | ||
| * **AI in Editor** – Provides translators with AI-powered assistance. | ||
| * *Show AI Suggestions:* Displays AI suggestions along with TM and MT suggestions. | ||
| <Aside type="caution"> | ||
| 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** – Recommended for enhanced privacy and ownership. | ||
| * **Managed by Crowdin** – 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** – Available in the Pre-translate menu and the Editor. | ||
| * **AI in the Editor** – Enables the AI Assistant for translators working on strings. | ||
| * **AI Suggestions** – 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** – Includes terminology, context, and TM data. | ||
| * **File level** – Includes descriptions, file names, and the file's overall context. | ||
| * **Project level** – 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** – You can revisit the AI settings anytime to enable or disable features, switch providers, or modify prompts. | ||
| * **Monitor Usage and Costs** – 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** – 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> | ||
| <QuestionAnswer title="How can I access the AI Setup Wizard if I dismissed the banner?"> | ||
| 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 | ||
| ``` | ||
| </QuestionAnswer> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
src/content/docs/enterprise/translation-process/ai-setup-wizard.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| ## Selecting AI Features | ||
|
|
||
| On the **Features** step, select the AI functionalities you'd like to enable in your Crowdin Enterprise projects: | ||
|
|
||
| * **AI Pre-translate** – Automatically pre-translate strings with contextual awareness. | ||
| * **AI in Editor** – Provides translators with AI-powered assistance. | ||
| * *Show AI Suggestions:* Displays AI suggestions along with TM and MT suggestions. | ||
| <Aside type="caution"> | ||
| 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** – Recommended for enhanced privacy and ownership. | ||
| * **Managed by Crowdin** – 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** – Available in the Pre-translate menu and the Editor. | ||
| * **AI in the Editor** – Enables the AI Assistant for translators working on strings. | ||
| * **AI Suggestions** – 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** – Includes terminology, context, and TM data. | ||
| * **File level** – Includes descriptions, file names, and the file's overall context. | ||
| * **Project level** – 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** – You can revisit the AI settings anytime to enable or disable features, switch providers, or modify prompts. | ||
| * **Monitor Usage and Costs** – 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** – 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> | ||
| <QuestionAnswer title="How can I access the AI Setup Wizard if I dismissed the banner?"> | ||
| If you’ve dismissed the banner, you can still access the wizard using the following URL (replace `{your-organization-name}` with your actual Crowdin Enterprise organization name): | ||
|
|
||
| ``` | ||
| https://{your-organization-name}.crowdin.com/u/ai/wizard | ||
| ``` | ||
| </QuestionAnswer> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.