com.crowdin.client.ai

Class AIApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.ai.AIApi

public class AIApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
AIApi(Credentials credentials)
AIApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<AiPrompt>	addAiPrompt(java.lang.Long userId, AiPromptAddRequest request)
ResponseObject<AiProvider>	addAiProviders(java.lang.Long userId, AiProviderRequest request)
ResponseObject<CustomPlaceholder>	addCustomPlaceholder(java.lang.Long userId, CustomPlaceholderRequest request)
void	cancelPromptCompletion(java.lang.Long userId, long aiPromptId, java.lang.String completionId)
ResponseObject<AiReportGenerate>	checkAiReportGenerationStatus(java.lang.Long userId, java.lang.String aiReportId)
ResponseObject<AiPrompt>	cloneAiPrompt(java.lang.Long userId, long aiPromptId, AiPromptCloneRequest request)
ResponseObject<FineTuningJob>	createFineTuningJob(java.lang.Long userId, java.lang.Long aiPromptId, FineTuningJobRequest request)
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>>	createProxyChatCompletion(java.lang.Long userId, java.lang.Long aiProviderId, java.util.Map<java.lang.String,java.lang.Object> request)
void	deleteAiPrompt(java.lang.Long userId, long aiPromptId)
void	deleteAiProvider(java.lang.Long userId, java.lang.Long aiProviderId)
void	deleteCustomPlaceholder(java.lang.Long userId, long aiCustomPlaceholderId)
ResponseObject<DownloadLink>	downloadAiReport(java.lang.Long userId, java.lang.String reportId)
ResponseObject<FineTuningDatasetDownload>	downloadFineTuningDataset(java.lang.Long userId, long aiPromptId, java.lang.String jobIdentifier)
ResponseObject<DownloadLink>	downloadPromptCompletion(java.lang.Long userId, long aiPromptId, java.lang.String completionId)
ResponseObject<AiPrompt>	editAiPrompt(java.lang.Long userId, long aiPromptId, java.util.List<PatchRequest> request)
ResponseObject<AiProvider>	editAiProvider(java.lang.Long userId, java.lang.Long aiProviderId, java.util.List<PatchRequest> requests)
ResponseObject<AiSetting>	editAiSetting(java.lang.Long userId, java.util.List<PatchRequest> request)
ResponseObject<CustomPlaceholder>	editCustomPlaceholder(java.lang.Long userId, long aiCustomPlaceholderId, java.util.List<PatchRequest> request)
ResponseObject<AiReportGenerate>	generateAiReport(java.lang.Long userId, GenerateAiReportRequest request)
ResponseObject<FineTuningDatasetResponse.FineTuningDatasetData>	generateFineTuningDataset(java.lang.Long userId, java.lang.Long aiPromptId, FineTuningDatasetRequest request)
ResponseObject<AiPromptCompletionResponse.AiPromptCompletionData>	generatePromptCompletion(java.lang.Long userId, long aiPromptId, AiPromptCompletionRequest request)
ResponseObject<AiPrompt>	getAiPrompt(java.lang.Long userId, long aiPromptId)
ResponseObject<AiProvider>	getAiProvider(java.lang.Long userId, java.lang.Long aiProviderId)
ResponseObject<AiSetting>	getAiSetting(java.lang.Long userId)
ResponseObject<CustomPlaceholder>	getCustomPlaceholder(java.lang.Long userId, long aiCustomPlaceholderId)
ResponseObject<FineTuningDatasetResponse.FineTuningDatasetData>	getFineTuningDatasetGenerationStatus(java.lang.Long userId, java.lang.Long aiPromptId, java.lang.String jobIdentifier)
ResponseList<FineTuningEvent>	getFineTuningEventList(java.lang.Long userId, java.lang.Long aiPromptId, java.lang.String jobIdentifier)
ResponseList<FineTuningJob>	getFineTuningJobList(java.lang.Long userId, java.lang.Integer limit, java.lang.Integer offset, java.lang.String statuses, java.lang.String orderBy)
ResponseObject<FineTuningJob>	getFineTuningJobStatus(java.lang.Long userId, java.lang.Long aiPromptId, java.lang.String jobIdentifier)
ResponseObject<AiPromptCompletionResponse.AiPromptCompletionData>	getPromptCompletionStatus(java.lang.Long userId, long aiPromptId, java.lang.String completionId)
ResponseList<AiPrompt>	listAiPrompts(java.lang.Long userId, java.lang.Long projectId, java.lang.String action, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<AiProviderModel>	listAiProviderModels(java.lang.Long userId, java.lang.Long aiProviderId)
ResponseList<AiProvider>	listAiProviders(java.lang.Long userId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<CustomPlaceholder>	listCustomPlaceholders(java.lang.Long userId, java.lang.Integer limit, java.lang.Integer offset)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AIApi

public AIApi(Credentials credentials)

AIApi

public AIApi(Credentials credentials,
             ClientConfig clientConfig)

Method Detail

listCustomPlaceholders

public ResponseList<CustomPlaceholder> listCustomPlaceholders(java.lang.Long userId,
                                                              java.lang.Integer limit,
                                                              java.lang.Integer offset)

Parameters:

userId - user identifier

limit - query limit

offset - query offset

See Also:

• API Documentation
• Enterprise API Documentation

addCustomPlaceholder

public ResponseObject<CustomPlaceholder> addCustomPlaceholder(java.lang.Long userId,
                                                              CustomPlaceholderRequest request)

Parameters:

userId - user identifier

request - request

See Also:

• API Documentation
• Enterprise API Documentation

getCustomPlaceholder

public ResponseObject<CustomPlaceholder> getCustomPlaceholder(java.lang.Long userId,
                                                              long aiCustomPlaceholderId)

Parameters:

userId - user identifier

aiCustomPlaceholderId - aiCustomPlaceholderId identifier

See Also:

• API Documentation
• Enterprise API Documentation

deleteCustomPlaceholder

public void deleteCustomPlaceholder(java.lang.Long userId,
                                    long aiCustomPlaceholderId)

Parameters:

userId - user identifier

aiCustomPlaceholderId - aiCustomPlaceholderId identifier

See Also:

• API Documentation
• Enterprise API Documentation

editCustomPlaceholder

public ResponseObject<CustomPlaceholder> editCustomPlaceholder(java.lang.Long userId,
                                                               long aiCustomPlaceholderId,
                                                               java.util.List<PatchRequest> request)

Parameters:

userId - user identifier

aiCustomPlaceholderId - aiCustomPlaceholderId identifier

request - request

See Also:

• API Documentation
• Enterprise API Documentation

getFineTuningDatasetGenerationStatus

public ResponseObject<FineTuningDatasetResponse.FineTuningDatasetData> getFineTuningDatasetGenerationStatus(java.lang.Long userId,
                                                                                                            java.lang.Long aiPromptId,
                                                                                                            java.lang.String jobIdentifier)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

jobIdentifier - AI prompt fine-tuning dataset generation identifier, consists of 36 characters

Returns:

dataset generation status

See Also:

• API Documentation
• Enterprise API Documentation

generateFineTuningDataset

public ResponseObject<FineTuningDatasetResponse.FineTuningDatasetData> generateFineTuningDataset(java.lang.Long userId,
                                                                                                 java.lang.Long aiPromptId,
                                                                                                 FineTuningDatasetRequest request)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

request - request body

Returns:

fine-tuning dataset

See Also:

• API Documentation
• Enterprise API Documentation

getFineTuningEventList

public ResponseList<FineTuningEvent> getFineTuningEventList(java.lang.Long userId,
                                                            java.lang.Long aiPromptId,
                                                            java.lang.String jobIdentifier)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

jobIdentifier - AI prompt fine-tuning dataset generation identifier, consists of 36 characters

Returns:

fine-tuning event list

See Also:

• API Documentation
• Enterprise API Documentation

getFineTuningJobList

public ResponseList<FineTuningJob> getFineTuningJobList(java.lang.Long userId,
                                                        java.lang.Integer limit,
                                                        java.lang.Integer offset,
                                                        java.lang.String statuses,
                                                        java.lang.String orderBy)

Parameters:

userId - user identifier

Returns:

fine-tuning job list

See Also:

• API Documentation
• Enterprise API Documentation

createFineTuningJob

public ResponseObject<FineTuningJob> createFineTuningJob(java.lang.Long userId,
                                                         java.lang.Long aiPromptId,
                                                         FineTuningJobRequest request)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

request - request body

Returns:

AI Prompt Fine-Tuning Dataset Job

See Also:

• API Documentation
• Enterprise API Documentation

getFineTuningJobStatus

public ResponseObject<FineTuningJob> getFineTuningJobStatus(java.lang.Long userId,
                                                            java.lang.Long aiPromptId,
                                                            java.lang.String jobIdentifier)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

jobIdentifier - AI prompt fine-tuning dataset generation identifier, consists of 36 characters

Returns:

AI Prompt Fine-Tuning Dataset Job Status

See Also:

• API Documentation
• Enterprise API Documentation

downloadFineTuningDataset

public ResponseObject<FineTuningDatasetDownload> downloadFineTuningDataset(java.lang.Long userId,
                                                                           long aiPromptId,
                                                                           java.lang.String jobIdentifier)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

jobIdentifier - AI prompt fine-tuning dataset generation identifier, consists of 36 characters

Returns:

AI Prompt Fine-Tuning Dataset Download URL

See Also:

• API Documentation
• Enterprise API Documentation

cloneAiPrompt

public ResponseObject<AiPrompt> cloneAiPrompt(java.lang.Long userId,
                                              long aiPromptId,
                                              AiPromptCloneRequest request)

Parameters:

userId - user identifier

aiPromptId - AI prompt identifier

request - request

Returns:

AI Prompt Fine-Tuning Dataset Download URL

See Also:

• API Documentation
• Enterprise API Documentation

listAiPrompts

public ResponseList<AiPrompt> listAiPrompts(java.lang.Long userId,
                                            java.lang.Long projectId,
                                            java.lang.String action,
                                            java.lang.Integer limit,
                                            java.lang.Integer offset)

Parameters:

userId - user identifier

projectId - project identifier

action - action

limit - query limit

offset - query offset

See Also:

• API Documentation
• Enterprise API Documentation

addAiPrompt

public ResponseObject<AiPrompt> addAiPrompt(java.lang.Long userId,
                                            AiPromptAddRequest request)

Parameters:

userId - user identifier

request - request

See Also:

• API Documentation
• Enterprise API Documentation

generatePromptCompletion

public ResponseObject<AiPromptCompletionResponse.AiPromptCompletionData> generatePromptCompletion(java.lang.Long userId,
                                                                                                  long aiPromptId,
                                                                                                  AiPromptCompletionRequest request)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

request - request

See Also:

• API Documentation
• Enterprise API Documentation

getPromptCompletionStatus

public ResponseObject<AiPromptCompletionResponse.AiPromptCompletionData> getPromptCompletionStatus(java.lang.Long userId,
                                                                                                   long aiPromptId,
                                                                                                   java.lang.String completionId)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

completionId - completion identifier

See Also:

• API Documentation
• Enterprise API Documentation

cancelPromptCompletion

public void cancelPromptCompletion(java.lang.Long userId,
                                   long aiPromptId,
                                   java.lang.String completionId)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

completionId - completion identifier

See Also:

• API Documentation
• Enterprise API Documentation

downloadPromptCompletion

public ResponseObject<DownloadLink> downloadPromptCompletion(java.lang.Long userId,
                                                             long aiPromptId,
                                                             java.lang.String completionId)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

completionId - completion identifier

See Also:

• API Documentation
• Enterprise API Documentation

getAiPrompt

public ResponseObject<AiPrompt> getAiPrompt(java.lang.Long userId,
                                            long aiPromptId)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

See Also:

• API Documentation
• Enterprise API Documentation

deleteAiPrompt

public void deleteAiPrompt(java.lang.Long userId,
                           long aiPromptId)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

See Also:

• API Documentation
• Enterprise API Documentation

editAiPrompt

public ResponseObject<AiPrompt> editAiPrompt(java.lang.Long userId,
                                             long aiPromptId,
                                             java.util.List<PatchRequest> request)

Parameters:

userId - user identifier

aiPromptId - aiPrompt identifier

request - request

See Also:

• API Documentation
• Enterprise API Documentation

generateAiReport

public ResponseObject<AiReportGenerate> generateAiReport(java.lang.Long userId,
                                                         GenerateAiReportRequest request)
                                                  throws HttpException,
                                                         HttpBadRequestException

Parameters:

userId - user identifier

request - request object

Returns:

AI report generation status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkAiReportGenerationStatus

public ResponseObject<AiReportGenerate> checkAiReportGenerationStatus(java.lang.Long userId,
                                                                      java.lang.String aiReportId)
                                                               throws HttpException,
                                                                      HttpBadRequestException

Parameters:

userId - user identifier

aiReportId - AI report identifier, consists of 36 characters

Returns:

AI report generation status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadAiReport

public ResponseObject<DownloadLink> downloadAiReport(java.lang.Long userId,
                                                     java.lang.String reportId)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

userId - user identifier

reportId - AI report identifier, consists of 36 characters

Returns:

AI report download URL

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getAiSetting

public ResponseObject<AiSetting> getAiSetting(java.lang.Long userId)

Parameters:

userId - user identifier

Returns:

AI settings

See Also:

• API Documentation
• Enterprise API Documentation

editAiSetting

public ResponseObject<AiSetting> editAiSetting(java.lang.Long userId,
                                               java.util.List<PatchRequest> request)

Parameters:

userId - user identifier

Returns:

updated AI settings

See Also:

• API Documentation
• Enterprise API Documentation

listAiProviders

public ResponseList<AiProvider> listAiProviders(java.lang.Long userId,
                                                java.lang.Integer limit,
                                                java.lang.Integer offset)

Parameters:

userId - user identifier

limit - limit

offset - offset

Returns:

List of AI Providers

See Also:

• API Documentation
• Enterprise API Documentation

addAiProviders

public ResponseObject<AiProvider> addAiProviders(java.lang.Long userId,
                                                 AiProviderRequest request)

Parameters:

userId - user identifier

request - AiProviderJobRequest

Returns:

AiProvider

See Also:

• API Documentation
• Enterprise API Documentation

getAiProvider

public ResponseObject<AiProvider> getAiProvider(java.lang.Long userId,
                                                java.lang.Long aiProviderId)

Parameters:

userId - user identifier

aiProviderId - id of AiProvider

Returns:

AiProvider

See Also:

• API Documentation
• Enterprise API Documentation

deleteAiProvider

public void deleteAiProvider(java.lang.Long userId,
                             java.lang.Long aiProviderId)

Parameters:

userId - user identifier

aiProviderId - id of AiProvider

See Also:

• API Documentation
• Enterprise API Documentation

editAiProvider

public ResponseObject<AiProvider> editAiProvider(java.lang.Long userId,
                                                 java.lang.Long aiProviderId,
                                                 java.util.List<PatchRequest> requests)

Parameters:

userId - user identifier

aiProviderId - id of AiProvider

requests - list of PatchRequest

Returns:

updated AiProvider

See Also:

• API Documentation
• Enterprise API Documentation

listAiProviderModels

public ResponseList<AiProviderModel> listAiProviderModels(java.lang.Long userId,
                                                          java.lang.Long aiProviderId)

Parameters:

userId - user identifier

aiProviderId - id of AiProvider

Returns:

list of AiProviderModel

See Also:

• API Documentation
• Enterprise API Documntation

createProxyChatCompletion

public ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> createProxyChatCompletion(java.lang.Long userId,
                                                                                                  java.lang.Long aiProviderId,
                                                                                                  java.util.Map<java.lang.String,java.lang.Object> request)

Parameters:

userId - user identifier

aiProviderId - id of AiProvider

request - request

Returns:

updated AiProvider

See Also:

• API Documentation
• Enterprise API Documentation