Module `crowdin_api.api_resources.ai.resource`

Classes

class AIResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for AI.

Link to documentation: https://developer.crowdin.com/api/v2/#tag/AI

Ancestors

BaseResource

Methods

def add_ai_custom_placeholder(self, user_id: int, body: AddAiCustomPlaceholderRequest): Add AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.post
def add_ai_prompt(self, userId: int, request_data: AddAIPromptRequestScheme): Add AI Prompt

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.post
def add_ai_provider(self, userId: int, request_data: AddAIProviderReqeustScheme): Add AI Provider

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.post
def cancel_ai_prompt_completion(self, user_id: int, ai_prompt_id: int, completion_id: str): Cancel AI Prompt Completion

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.completions.delete
def check_ai_report_generation_status(self, user_id: int, ai_report_id: str): Check AI Report Generation Status

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.reports.get
def clone_ai_prompt(self, user_id: int, ai_prompt_id: int, name: Optional[str] = None): Clone AI Prompt

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.clones.post
def create_ai_prompt_fine_tuning_job(self, user_id: int, ai_prompt_id: int, request_data: CreateAIPromptFineTuningJobRequest): Create AI Prompt Fine-Tuning Job

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.post
def create_ai_proxy_chat_completion(self, userId: int, aiProviderId: int, request_data: Union[GoogleGeminiChatProxy, OtherChatProxy]): Create AI Proxy Chat Completion

This API method serves as an intermediary, forwarding your requests directly to the selected provider. Please refer to the documentation for the specific provider you use to determine the required payload format.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.chat.completions.post
def delete_ai_custom_placeholder(self, user_id: int, ai_custom_placeholder_id: int): Delete AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.delete
def delete_ai_prompt(self, userId: int, aiPromptId: int): Delete AI Prompt

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.delete
def delete_ai_provider(self, userId: int, aiProviderId: int): Delete AI Provider

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.delete
def download_ai_prompt_completion(self, user_id: int, ai_prompt_id: int, completion_id: str): Download AI Prompt Completion

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.completions.download.download
def download_ai_prompt_fine_tuning_dataset(self, user_id: int, ai_prompt_id: int, job_identifier: str): Download AI Prompt Fine-Tuning Dataset

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.fine-tuning.datasets.download.get
def download_ai_report(self, user_id: int, ai_report_id: str): Download AI Report

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.reports.download.download
def edit_ai_custom_placeholder(self, user_id: int, ai_custom_placeholder_id: int, patches: Iterable[EditAiCustomPlaceholderPatch]): Edit AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.patch
def edit_ai_prompt(self, userId: int, aiPromptId: int, request_data: Iterable[EditAIPromptScheme]): Edit AI Prompt

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.patch
def edit_ai_provider(self, userId: int, aiProviderId: int, request_data: EditAIProviderRequestScheme): Edit AI Provider

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.patch
def edit_ai_settings(self, user_id: int, patches: Iterable[EditAiSettingsPatch]): Edit AI Settings

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.patch
def generate_ai_prompt_completion(self, user_id: int, ai_prompt_id: int, request: GenerateAiPromptCompletionRequest): Generate AI Prompt Completion

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.completions.post
def generate_ai_prompt_fine_tuning_dataset(self, user_id: int, ai_prompt_id: int, request_data: GenerateAIPromptFineTuningDatasetRequest): Generate AI Prompt Fine-Tuning Dataset

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.post
def generate_ai_report(self, user_id: int, request: GenerateAiReportRequest): Generate AI Report

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.reports.post
def get_ai_custom_placeholder(self, user_id: int, ai_custom_placeholder_id: int): Get AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.get
def get_ai_custom_placeholders_path(self, user_id: int, custom_placeholder_id: Optional[int] = None)
def get_ai_path(self, userId: int, aiPromptId: Optional[int] = None)
def get_ai_prompt(self, userId: int, aiPromptId: int): Get AI Prompt

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.get
def get_ai_prompt_completion_status(self, user_id: int, ai_prompt_id: int, completion_id: str): Get AI Prompt Completion Status

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.completions.get
def get_ai_prompt_completions_path(self, user_id: int, ai_prompt_id: int, completion_id: Optional[str] = None)
def get_ai_prompt_fine_tuning_dataset_generation_status(self, user_id: int, ai_prompt_id: int, job_identifier: str): Get AI Prompt Fine-Tuning Dataset Generation Status

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.fine-tuning.datasets.get
def get_ai_prompt_fine_tuning_datasets_path(self, user_id: int, ai_prompt_id: Optional[int] = None, job_identifier: Optional[str] = None)
def get_ai_prompt_fine_tuning_job_status(self, user_id: int, ai_prompt_id: int, job_identifier: str): Get AI Prompt Fine-Tuning Job Status

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.fine-tuning.jobs.get
def get_ai_prompt_fine_tuning_jobs_path(self, user_id: int, ai_prompt_id: Optional[int] = None, job_identifier: Optional[str] = None)
def get_ai_provider(self, userId: int, aiProviderId: int): Get AI Provider

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.get
def get_ai_provider_path(self, userId: int, aiProviderId: Optional[int] = None)
def get_ai_reports_path(self, user_id: int, ai_report_id: Optional[str] = None)
def get_ai_settings(self, user_id: int): Get AI Settings

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.get
def get_ai_settings_path(self, user_id: int)
def list_ai_custom_placeholders(self, user_id: int): List AI Custom Placeholders

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompt.custom.placeholders.getMany
def list_ai_prompt_fine_tuning_events(self, user_id: int, ai_prompt_id: int, job_identifier: str): List AI Prompt Fine-Tuning Events

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.events.getMany
def list_ai_prompt_fine_tuning_jobs(self, user_id: int, statuses: Optional[Iterable[AiPromptFineTuningJobStatus]] = None, order_by: Optional[Sorting] = None, limit: Optional[int] = None, offset: Optional[int] = None): List AI Prompt Fine-Tuning Jobs

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.getMany
def list_ai_prompts(self, userId: int, projectId: Optional[int] = None, action: Optional[AIPromptAction] = None, limit: Optional[int] = None, offset: Optional[int] = None): List AI Prompts

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.ai.prompts.getMany
def list_ai_provider_models(self, userId: int, aiProviderId: int): List AI Provider Models

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.ai.providers.models.getMany
def list_ai_providers(self, userId: int, limit: Optional[int] = None, offset: Optional[int] = None): List AI Providers

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.ai.providers.getMany

class EnterpriseAIResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Enterprise Resource for AI.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#tag/AI

Ancestors

BaseResource

Methods

def add_ai_custom_placeholder(self, body: AddAiCustomPlaceholderRequest): Add AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.post
def add_ai_prompt(self, request_data: AddAIPromptRequestScheme): Add AI Prompt

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.post
def add_ai_provider(self, request_data: AddAIProviderReqeustScheme): Add AI Provider

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.post
def cancel_ai_prompt_completion(self, ai_prompt_id: int, completion_id: str): Cancel AI Prompt Completion

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.delete
def check_ai_report_generation_status(self, ai_report_id: str): Check AI Report Generation Status

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.reports.get
def clone_ai_prompt(self, ai_prompt_id: int, name: Optional[str] = None): Clone AI Prompt

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.clones.post
def create_ai_prompt_fine_tuning_job(self, ai_prompt_id: int, request_data: CreateAIPromptFineTuningJobRequest): Create AI Prompt Fine-Tuning Job

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.post
def create_ai_proxy_chat_completion(self, aiProviderId: int, request_data: Union[GoogleGeminiChatProxy, OtherChatProxy]): Create AI Proxy Chat Completion

This API method serves as an intermediary, forwarding your requests directly to the selected provider. Please refer to the documentation for the specific provider you use to determine the required payload format.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.chat.completions.post
def delete_ai_custom_placeholder(self, ai_custom_placeholder_id: int): Delete AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.delete
def delete_ai_prompt(self, aiPromptId: int): Delete AI Prompt

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.delete
def delete_ai_provider(self, aiProviderId: int): Delete AI Provider

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.delete
def download_ai_prompt_completion(self, ai_prompt_id: int, completion_id: str): Download AI Prompt Completion

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.download.download
def download_ai_prompt_fine_tuning_dataset(self, ai_prompt_id: int, job_identifier: str): Download AI Prompt Fine-Tuning Dataset

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.download.get
def download_ai_report(self, ai_report_id: str): Download AI Report

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.reports.download.download
def edit_ai_custom_placeholder(self, ai_custom_placeholder_id: int, patches: Iterable[EditAiCustomPlaceholderPatch]): Edit AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.patch
def edit_ai_prompt(self, aiPromptId: int, request_data: Iterable[EditAIPromptScheme]): Edit AI Prompt

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.patch
def edit_ai_provider(self, aiProviderId: int, request_data: EditAIProviderRequestScheme): Edit AI Provider

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.patch
def edit_ai_settings(self, patches: Iterable[EditAiSettingsPatch]): Edit AI Settings

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.patch
def generate_ai_prompt_completion(self, ai_prompt_id: int, request: GenerateAiPromptCompletionRequest): Generate AI Prompt Completion

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.post
def generate_ai_prompt_fine_tuning_dataset(self, ai_prompt_id: int, request_data: GenerateAIPromptFineTuningDatasetRequest): Generate AI Prompt Fine-Tuning Dataset

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.post
def generate_ai_report(self, request: GenerateAiReportRequest): Generate AI Report

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.reports.post
def get_ai_custom_placeholder(self, ai_custom_placeholder_id: int): Get AI Custom Placeholder

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.get
def get_ai_custom_placeholders_path(self, ai_custom_placeholder_id: Optional[int] = None)
def get_ai_path(self, aiPromptId: Optional[int] = None)
def get_ai_prompt(self, aiPromptId: int): Get AI Prompt

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.get
def get_ai_prompt_completion_status(self, ai_prompt_id: int, completion_id: str): Get AI Prompt Completion Status

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.get
def get_ai_prompt_completions_path(self, ai_prompt_id: int, completion_id: Optional[str] = None)
def get_ai_prompt_fine_tuning_dataset_generation_status(self, ai_prompt_id: int, job_identifier: str): Get AI Prompt Fine-Tuning Dataset Generation Status

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.get
def get_ai_prompt_fine_tuning_datasets_path(self, ai_prompt_id: int, job_identifier: Optional[str] = None)
def get_ai_prompt_fine_tuning_job_status(self, ai_prompt_id: int, job_identifier: str): Get AI Prompt Fine-Tuning Job Status

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.get
def get_ai_prompt_fine_tuning_jobs_path(self, ai_prompt_id: int, job_identifier: Optional[str] = None)
def get_ai_provider(self, aiProviderId: int): Get AI Provider

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.get
def get_ai_provider_path(self, aiProviderId: Optional[int] = None)
def get_ai_reports_path(self, ai_report_id: Optional[str] = None)
def get_ai_settings(self): Get AI Settings

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.get
def list_ai_custom_placeholders(self): List AI Custom Placeholders

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.custom.placeholders.getMany
def list_ai_prompt_fine_tuning_events(self, ai_prompt_id: int, job_identifier: str): List AI Prompt Fine-Tuning Events

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.events.getMany
def list_ai_prompt_fine_tuning_jobs(self, statuses: Optional[Iterable[AiPromptFineTuningJobStatus]] = None, order_by: Optional[Sorting] = None, limit: Optional[int] = None, offset: Optional[int] = None): List AI Prompt Fine-Tuning Jobs

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.getMany
def list_ai_prompts(self, projectId: Optional[int] = None, action: Optional[AIPromptAction] = None, limit: Optional[int] = None, offset: Optional[int] = None): List AI Prompts

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.getMany
def list_ai_provider_models(self, aiProviderId: int): List AI Provider Models

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.ai.providers.models.getMany
def list_ai_providers(self, limit: Optional[int] = None, offset: Optional[int] = None): List AI Providers

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.getMany