Interface IAiApiExecutor

Namespace: Crowdin.Api.AI

Assembly: Crowdin.Api.dll

Syntax

[PublicAPI]
public interface IAiApiExecutor

Methods

| Edit this page View Source

AddAiPrompt(long?, AddAiPromptRequest)

Declaration

Task<AiPromptResource> AddAiPrompt(long? userId, AddAiPromptRequest request)

Parameters

Type	Name	Description
long?	userId
AddAiPromptRequest	request

Returns

Type	Description
Task<AiPromptResource>

| Edit this page View Source

AddAiProvider(long?, AddAiProviderRequest)

Declaration

Task<AiProviderResource> AddAiProvider(long? userId, AddAiProviderRequest request)

Parameters

Type	Name	Description
long?	userId
AddAiProviderRequest	request

Returns

Type	Description
Task<AiProviderResource>

| Edit this page View Source

AddAiSnippet(long?, AddAiSnippetRequest)

Declaration

Task<AiSnippet> AddAiSnippet(long? userId, AddAiSnippetRequest request)

Parameters

Type	Name	Description
long?	userId
AddAiSnippetRequest	request

Returns

Type	Description
Task<AiSnippet>

| Edit this page View Source

AiFileTranslations(long?, AiFileTranslationsRequest)

AI File Translations. Documentation: Crowdin File Based API Crowdin String Based API Crowdin Enterprise API

Declaration

Task<AiFileTranslationsStatus> AiFileTranslations(long? userId, AiFileTranslationsRequest request)

Parameters

Type	Name	Description
long?	userId
AiFileTranslationsRequest	request

Returns

Type	Description
Task<AiFileTranslationsStatus>

| Edit this page View Source

CancelAiPromptCompletion(long?, long, string)

Declaration

Task CancelAiPromptCompletion(long? userId, long aiPromptId, string completionId)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	completionId

Returns

Type	Description
Task

| Edit this page View Source

CancelFileTranslations(long?, string)

Cancel File Translations. Documentation: Crowdin File Based API Crowdin String Based API Crowdin Enterprise API

Declaration

Task CancelFileTranslations(long? userId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
string	jobIdentifier

Returns

Type	Description
Task

| Edit this page View Source

CheckAiReportGenerationStatus(long?, string)

Declaration

Task<AiReportGenerationStatus> CheckAiReportGenerationStatus(long? userId, string aiReportId)

Parameters

Type	Name	Description
long?	userId
string	aiReportId

Returns

Type	Description
Task<AiReportGenerationStatus>

| Edit this page View Source

CloneAiPrompt(long?, long, CloneAiPromptRequest)

Declaration

Task<AiPromptResource> CloneAiPrompt(long? userId, long aiPromptId, CloneAiPromptRequest request)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
CloneAiPromptRequest	request

Returns

Type	Description
Task<AiPromptResource>

| Edit this page View Source

CreateAiPromptFineTuningJob(long?, long, CreateAiPromptFineTuningJobRequest)

Declaration

Task<AiFineTuningJob> CreateAiPromptFineTuningJob(long? userId, long aiPromptId, CreateAiPromptFineTuningJobRequest request)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
CreateAiPromptFineTuningJobRequest	request

Returns

Type	Description
Task<AiFineTuningJob>

| Edit this page View Source

CreateAiProxyChatCompletion(long?, long, IDictionary<string, object>)

Declaration

Task<AiProxyChatCompletion> CreateAiProxyChatCompletion(long? userId, long aiProviderId, IDictionary<string, object> request)

Parameters

Type	Name	Description
long?	userId
long	aiProviderId
IDictionary<string, object>	request

Returns

Type	Description
Task<AiProxyChatCompletion>

| Edit this page View Source

DeleteAiPrompt(long?, long)

Declaration

Task DeleteAiPrompt(long? userId, long aiPromptId)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId

Returns

Type	Description
Task

| Edit this page View Source

DeleteAiProvider(long?, long)

Declaration

Task DeleteAiProvider(long? userId, long aiProviderId)

Parameters

Type	Name	Description
long?	userId
long	aiProviderId

Returns

Type	Description
Task

| Edit this page View Source

DeleteAiSnippet(long?, long)

Declaration

Task DeleteAiSnippet(long? userId, long aiSnippetId)

Parameters

Type	Name	Description
long?	userId
long	aiSnippetId

Returns

Type	Description
Task

| Edit this page View Source

DownloadAiPromptCompletion(long?, long, string)

Declaration

Task<DownloadLink> DownloadAiPromptCompletion(long? userId, long aiPromptId, string completionId)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	completionId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadAiPromptFineTuningDataset(long?, long, string)

Declaration

Task<DownloadLink> DownloadAiPromptFineTuningDataset(long? userId, long aiPromptId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	jobIdentifier

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadAiReport(long?, string)

Declaration

Task<DownloadLink> DownloadAiReport(long? userId, string aiReportId)

Parameters

Type	Name	Description
long?	userId
string	aiReportId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadTranslatedFile(long?, string)

Download Translated File. Documentation: Crowdin File Based API Crowdin String Based API Crowdin Enterprise API

Declaration

Task<DownloadLink> DownloadTranslatedFile(long? userId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
string	jobIdentifier

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadTranslatedFileStrings(long?, string)

Download Translated File Strings. Documentation: Crowdin File Based API Crowdin String Based API Crowdin Enterprise API

Declaration

Task<DownloadLink> DownloadTranslatedFileStrings(long? userId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
string	jobIdentifier

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

EditAiPrompt(long?, long, IEnumerable<AiPromptPatch>)

Declaration

Task<AiPromptResource> EditAiPrompt(long? userId, long aiPromptId, IEnumerable<AiPromptPatch> patches)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
IEnumerable<AiPromptPatch>	patches

Returns

Type	Description
Task<AiPromptResource>

| Edit this page View Source

EditAiProvider(long?, long, IEnumerable<AiProviderPatch>)

Declaration

Task<AiProviderResource> EditAiProvider(long? userId, long aiProviderId, IEnumerable<AiProviderPatch> patches)

Parameters

Type	Name	Description
long?	userId
long	aiProviderId
IEnumerable<AiProviderPatch>	patches

Returns

Type	Description
Task<AiProviderResource>

| Edit this page View Source

EditAiSettings(long?, IEnumerable<AiSettingsPatch>)

Declaration

Task<AiSettings> EditAiSettings(long? userId, IEnumerable<AiSettingsPatch> patches)

Parameters

Type	Name	Description
long?	userId
IEnumerable<AiSettingsPatch>	patches

Returns

Type	Description
Task<AiSettings>

| Edit this page View Source

EditAiSnippet(long?, long, IEnumerable<AiSnippetPatch>)

Declaration

Task<AiSnippet> EditAiSnippet(long? userId, long aiSnippetId, IEnumerable<AiSnippetPatch> patches)

Parameters

Type	Name	Description
long?	userId
long	aiSnippetId
IEnumerable<AiSnippetPatch>	patches

Returns

Type	Description
Task<AiSnippet>

| Edit this page View Source

GenerateAiPromptCompletion(long?, long, GenerateAiPromptCompletionRequest)

Declaration

Task<AiPromptCompletion> GenerateAiPromptCompletion(long? userId, long aiPromptId, GenerateAiPromptCompletionRequest request)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
GenerateAiPromptCompletionRequest	request

Returns

Type	Description
Task<AiPromptCompletion>

| Edit this page View Source

GenerateAiPromptFineTuningDataset(long?, long, GenerateAiPromptFineTuningDatasetRequest)

Declaration

Task<AiFineTuningDataset> GenerateAiPromptFineTuningDataset(long? userId, long aiPromptId, GenerateAiPromptFineTuningDatasetRequest request)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
GenerateAiPromptFineTuningDatasetRequest	request

Returns

Type	Description
Task<AiFineTuningDataset>

| Edit this page View Source

GenerateAiReport(long?, GenerateAiReport)

Declaration

Task<AiReportGenerationStatus> GenerateAiReport(long? userId, GenerateAiReport request)

Parameters

Type	Name	Description
long?	userId
GenerateAiReport	request

Returns

Type	Description
Task<AiReportGenerationStatus>

| Edit this page View Source

GetAiPrompt(long?, long)

Declaration

Task<AiPromptResource> GetAiPrompt(long? userId, long aiPromptId)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId

Returns

Type	Description
Task<AiPromptResource>

| Edit this page View Source

GetAiPromptCompletionStatus(long?, long, string)

Declaration

Task<AiPromptCompletion> GetAiPromptCompletionStatus(long? userId, long aiPromptId, string completionId)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	completionId

Returns

Type	Description
Task<AiPromptCompletion>

| Edit this page View Source

GetAiPromptFineTuningDatasetGenerationStatus(long?, long, string)

Declaration

Task<AiFineTuningDataset> GetAiPromptFineTuningDatasetGenerationStatus(long? userId, long aiPromptId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	jobIdentifier

Returns

Type	Description
Task<AiFineTuningDataset>

| Edit this page View Source

GetAiPromptFineTuningJobStatus(long?, long, string)

Declaration

Task<AiFineTuningJob> GetAiPromptFineTuningJobStatus(long? userId, long aiPromptId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	jobIdentifier

Returns

Type	Description
Task<AiFineTuningJob>

| Edit this page View Source

GetAiProvider(long?, long)

Declaration

Task<AiProviderResource> GetAiProvider(long? userId, long aiProviderId)

Parameters

Type	Name	Description
long?	userId
long	aiProviderId

Returns

Type	Description
Task<AiProviderResource>

| Edit this page View Source

GetAiSettings(long?)

Declaration

Task<AiSettings> GetAiSettings(long? userId)

Parameters

Type	Name	Description
long?	userId

Returns

Type	Description
Task<AiSettings>

| Edit this page View Source

GetAiSnippet(long?, long)

Declaration

Task<AiSnippet> GetAiSnippet(long? userId, long aiSnippetId)

Parameters

Type	Name	Description
long?	userId
long	aiSnippetId

Returns

Type	Description
Task<AiSnippet>

| Edit this page View Source

GetAiUsageMember(long)

Declaration

Task<AiUsageMember> GetAiUsageMember(long memberId)

Parameters

Type	Name	Description
long	memberId

Returns

Type	Description
Task<AiUsageMember>

| Edit this page View Source

GetFileTranslationsStatus(long?, string)

Get File Translations Status. Documentation: Crowdin File Based API Crowdin String Based API Crowdin Enterprise API

Declaration

Task<AiFileTranslationsStatus> GetFileTranslationsStatus(long? userId, string jobIdentifier)

Parameters

Type	Name	Description
long?	userId
string	jobIdentifier

Returns

Type	Description
Task<AiFileTranslationsStatus>

| Edit this page View Source

GetProjectAiSettings(long)

Declaration

Task<ProjectAiSettings> GetProjectAiSettings(long projectId)

Parameters

Type	Name	Description
long	projectId

Returns

Type	Description
Task<ProjectAiSettings>

| Edit this page View Source

ListAiPromptFineTuningEvents(long?, long, string, int, int)

Declaration

Task<ResponseList<AiFineTuningEvent>> ListAiPromptFineTuningEvents(long? userId, long aiPromptId, string jobIdentifier, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long?	userId
long	aiPromptId
string	jobIdentifier
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<AiFineTuningEvent>>

| Edit this page View Source

ListAiPrompts(long?, long?, AiPromptAction?, int, int)

Declaration

Task<ResponseList<AiPromptResource>> ListAiPrompts(long? userId, long? projectId = null, AiPromptAction? action = null, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long?	userId
long?	projectId
AiPromptAction?	action
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<AiPromptResource>>

| Edit this page View Source

ListAiProviderModels(long?, long)

Declaration

Task<ResponseList<AiProviderModelResource>> ListAiProviderModels(long? userId, long aiProviderId)

Parameters

Type	Name	Description
long?	userId
long	aiProviderId

Returns

Type	Description
Task<ResponseList<AiProviderModelResource>>

| Edit this page View Source

ListAiProviders(long?, int, int)

Declaration

Task<ResponseList<AiProviderResource>> ListAiProviders(long? userId, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long?	userId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<AiProviderResource>>

| Edit this page View Source

ListAiRequestLogs(long?, AiRequestLogsListParams)

List AI Request Logs. Documentation: Crowdin File Based API Crowdin String Based API Crowdin Enterprise API

Declaration

Task<ResponseList<AiRequestLog>> ListAiRequestLogs(long? userId, AiRequestLogsListParams @params)

Parameters

Type	Name	Description
long?	userId
AiRequestLogsListParams	params

Returns

Type	Description
Task<ResponseList<AiRequestLog>>

| Edit this page View Source

ListAiSnippets(long?, int, int)

Declaration

Task<ResponseList<AiSnippet>> ListAiSnippets(long? userId, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long?	userId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<AiSnippet>>

| Edit this page View Source

ListAiUsageMembers(int, int, string?, string?)

Declaration

Task<ResponseList<AiUsageMember>> ListAiUsageMembers(int limit = 25, int offset = 0, string? userIds = null, string? orderBy = null)

Parameters

Type	Name	Description
int	limit
int	offset
string	userIds
string	orderBy

Returns

Type	Description
Task<ResponseList<AiUsageMember>>

| Edit this page View Source

ListAllAiProviderModels(long?)

Declaration

Task<ResponseList<AiProviderModelResource>> ListAllAiProviderModels(long? userId)

Parameters

Type	Name	Description
long?	userId

Returns

Type	Description
Task<ResponseList<AiProviderModelResource>>

| Edit this page View Source

ListSupportedAiProviderModels(long?, int, int, string?, bool?, string?)

Declaration

Task<ResponseList<AiSupportedProviderModel>> ListSupportedAiProviderModels(long? userId, int limit = 25, int offset = 0, string? providerType = null, bool? enabled = null, string? orderBy = null)

Parameters

Type	Name	Description
long?	userId
int	limit
int	offset
string	providerType
bool?	enabled
string	orderBy

Returns

Type	Description
Task<ResponseList<AiSupportedProviderModel>>

| Edit this page View Source

TranslateStrings(long?, AiTranslateStringsRequest)

Declaration

Task<AiTranslateStringsResponse> TranslateStrings(long? userId, AiTranslateStringsRequest request)

Parameters

Type	Name	Description
long?	userId
AiTranslateStringsRequest	request

Returns

Type	Description
Task<AiTranslateStringsResponse>