Module crowdin_api.api_resources.ai.types

Classes

class ActionRule (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var action : AIPromptAction

var availableAiModelIds : Iterable[int]

class ActionRules (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var actionRules : Iterable[ActionRule]

class AddAIPromptRequestScheme (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var action : AIPromptAction

var aiModelId : str

var aiProviderId : int

var config : Union[BasicModePreTranslateActionConfig, BasicModeAlignmentActionConfig, BasicModeQaCheckActionConfig, AdvancedModeConfig, ExternalMode]

var enabledProjectIds : Optional[Iterable[int]]

var isEnabled : Optional[bool]

var name : str

class AddAIProviderReqeustScheme (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var config : Optional[ActionRules]

var credentials : Union[OpenAICredential, AzureOpenAICredential, GoogleGeminiCredential, MistralAICredential, AnthropicCredential, CustomAICredential, None]

var isEnabled : Optional[bool]

var name : str

var type : AIProviderType

var useSystemCredentials : Optional[bool]

class AddAiCustomPlaceholderRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var description : str

var placeholder : str

var value : str

class AdvancedModeConfig (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var mode : str

var prompt : str

var screenshots : Optional[bool]

class AiFileTranslationRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var aiModelId : Optional[str]

var aiPromptId : Optional[int]

var aiProviderId : Optional[int]

var attachmentIds : Optional[Iterable[int]]

var glossaryIds : Optional[Iterable[int]]

var instructions : Optional[Iterable[str]]

var parserVersion : Optional[int]

var sourceLanguageId : Optional[str]

var storageId : int

var styleGuideIds : Optional[Iterable[int]]

var targetLanguageId : str

var tmIds : Optional[Iterable[int]]

var type : Optional[str]

class AiPromptContextResources (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

class AiTool (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var function : AiToolFunction

var type : AiToolType

class AiToolFunction (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var description : Optional[str]

var name : str

var parameters : Any

class AiToolObject (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var tool : AiTool

class AiTranslateStringsRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var aiModelId : Optional[str]

var aiPromptId : Optional[int]

var aiProviderId : Optional[int]

var attachmentIds : Optional[Iterable[int]]

var glossaryIds : Optional[Iterable[int]]

var instructions : Optional[Iterable[str]]

var sourceLanguageId : Optional[str]

var strings : Iterable[str]

var styleGuideIds : Optional[Iterable[int]]

var targetLanguageId : str

var tmIds : Optional[Iterable[int]]

class AlignmentActionAiPromptContextResources (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var overridePromptValues : Optional[Dict[str, str]]

var projectDescription : Optional[str]

var projectId : int

var sourceLanguageId : Optional[str]

var stringIds : Optional[Iterable[int]]

var targetLanguageId : Optional[str]

class AnthropicCredential (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var apiKey : str

class AzureOpenAICredential (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var apiKey : str

var apiVersion : str

var deploymentName : str

var resourceName : str

class BasicModeAlignmentActionConfig (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var customPlaceholders : Optional[Iterable[str]]

var mode : str

var organizationContext : Optional[bool]

var projectContext : Optional[bool]

var publicProjectDescription : Optional[bool]

class BasicModePreTranslateActionConfig (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var audienceDescription : Optional[bool]

var companyDescription : Optional[bool]

var fileContent : Optional[bool]

var fileContext : Optional[bool]

var glossaryTerms : Optional[bool]

var mode : str

var organizationContext : Optional[bool]

var otherLanguageTranslation : Optional[OtherLanguageTranslation]

var projectContext : Optional[bool]

var projectDescription : Optional[bool]

var publicProjectDescription : Optional[bool]

var screenshots : Optional[bool]

var tmSuggestions : Optional[bool]

class BasicModeQaCheckActionConfig (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var evaluationSteps : Iterable[str]

var fileContext : Optional[bool]

var glossaryTerms : Optional[bool]

var mode : str

var organizationContext : Optional[bool]

var projectContext : Optional[bool]

var publicProjectDescription : Optional[bool]

var screenshots : Optional[bool]

var tmSuggestions : Optional[bool]

class CreateAIPromptFineTuningJobRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var dryRun : Optional[bool]

var hyperparameters : Optional[HyperParameters]

var trainingOptions : TrainingOptions

var validationOptions : Optional[ValidationOptions]

class CustomAICredential (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var identifier : str

var key : str

class CustomActionAiPromptContextResources (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var customInstruction : Optional[str]

var overridePromptValues : Optional[Dict[str, str]]

var projectDescription : Optional[str]

var projectId : int

var sourceLanguageId : Optional[str]

var stringIds : Optional[Iterable[int]]

var targetLanguageId : Optional[str]

class EditAIPromptScheme (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : AIPromptOperation

var path : EditAIPromptPath

var value : Any

class EditAIProviderRequestScheme (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : AIPromptOperation

var path : EditAIProviderPath

var value : Union[str, Dict[~KT, ~VT], bool]

class EditAiCustomPlaceholderPatch (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : PatchOperation

var path : EditAiCustomPlaceholderPatchPath

var value : Any

class EditAiSettingsPatch (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : PatchOperation

var path : EditAiSettingsPatchPath

var value : Any

class ExternalMode (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var identifier : str

var key : str

var name : str

var options : Dict[~KT, ~VT]

class GeneralReportSchema (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var dateFrom : str

var dateTo : str

var format : Optional[str]

var projectIds : Optional[Iterable[int]]

var promptIds : Optional[Iterable[int]]

var userIds : Optional[Iterable[int]]

class GenerateAIPromptFineTuningDatasetRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var dateFrom : str

var dateTo : str

var maxExamplesCount : Optional[int]

var maxFileSize : Optional[int]

var minExamplesCount : Optional[int]

var projectIds : Optional[Iterable[int]]

var purpose : Optional[str]

var tmIds : Optional[Iterable[int]]

class GenerateAiPromptCompletionRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var resources : AiPromptContextResources

var tool_choice : Any

var tools : Optional[Iterable[AiToolObject]]

class GenerateAiReportRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var schema : GeneralReportSchema

var type : str

class GoogleGeminiChatProxy (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var model : str

var stream : Optional[bool]

class GoogleGeminiCredential (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var project : str

var region : str

var serviceAccountKey : Dict[~KT, ~VT]

class HyperParameters (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var batchSize : int

var learningRateMultiplier : float

var nEpochs : int

class MistralAICredential (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var apiKey : str

class OpenAICredential (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var apiKey : str

class OtherChatProxy (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var stream : Optional[bool]

class OtherLanguageTranslation (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var isEnabled : Optional[bool]

var languageIds : Optional[Iterable[int]]

class PreTranslateActionAiPromptContextResources (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var overridePromptValues : Optional[Dict[str, str]]

var projectDescription : Optional[str]

var projectId : int

var sourceLanguageId : Optional[str]

var stringIds : Optional[Iterable[int]]

var targetLanguageId : Optional[str]

class QaCheckActionAiPromptContextResources (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var overridePromptValues : Optional[Dict[str, str]]

var projectDescription : Optional[str]

var projectId : int

var sourceLanguageId : Optional[str]

var stringIds : Optional[Iterable[int]]

var targetLanguageId : Optional[str]

class TrainingOptions (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var dateFrom : Optional[str]

var dateTo : Optional[str]

var maxExamplesCount : Optional[int]

var maxFileSize : Optional[int]

var minExamplesCount : Optional[int]

var projectIds : Optional[Iterable[int]]

var tmIds : Optional[Iterable[int]]

class ValidationOptions (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var dateFrom : Optional[str]

var dateTo : Optional[str]

var maxExamplesCount : Optional[int]

var maxFileSize : Optional[int]

var minExamplesCount : Optional[int]

var projectIds : Optional[Iterable[int]]

var tmIds : Optional[Iterable[int]]