Module: Crowdin::ApiResources::Ai

Defined in:
lib/crowdin-api/api_resources/ai.rb

Instance Method Summary collapse

Instance Method Details

#add_ai_prompt(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 129

def add_ai_prompt(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/prompts'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#add_ai_provider(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 440

def add_ai_provider(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/providers'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#add_ai_snippet(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 853

def add_ai_snippet(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/settings/snippets'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#ai_file_translations(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 23

def ai_file_translations(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/file-translations'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#ai_gateway_delete(ai_provider_id, path, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • path (String) —

    Raw provider API path after /gateway/

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 565

def ai_gateway_delete(ai_provider_id, path, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/gateway/#{path}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#ai_gateway_get(ai_provider_id, path, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • path (String) —

    Raw provider API path after /gateway/

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 583

def ai_gateway_get(ai_provider_id, path, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/gateway/#{path}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#ai_gateway_patch(ai_provider_id, path, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • path (String) —

    Raw provider API path after /gateway/

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 602

def ai_gateway_patch(ai_provider_id, path, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/gateway/#{path}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#ai_gateway_post(ai_provider_id, path, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • path (String) —

    Raw provider API path after /gateway/

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 622

def ai_gateway_post(ai_provider_id, path, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/gateway/#{path}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#ai_gateway_put(ai_provider_id, path, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • path (String) —

    Raw provider API path after /gateway/

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 642

def ai_gateway_put(ai_provider_id, path, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/gateway/#{path}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :put,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#ai_translate_strings(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 924

def ai_translate_strings(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/translate'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#cancel_ai_prompt_completion(ai_prompt_id, completion_id, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • completion_id (String) —

    Ai Prompt Completion Identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 257

def cancel_ai_prompt_completion(ai_prompt_id, completion_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/completions/#{completion_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#cancel_file_translations(job_identifier, user_id = nil) ⇒ Object

Parameters:

  • job_identifier (String) —

    AI File Translations job identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 41

def cancel_file_translations(job_identifier, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/file-translations/#{job_identifier}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#check_ai_report_generation_status(ai_report_id, user_id = nil) ⇒ Object

Parameters:

  • ai_report_id (String) —

    AI Report Identifier, consists of 36 characters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 695

def check_ai_report_generation_status(ai_report_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/reports/#{ai_report_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#check_ai_request_logs_export_status(export_id, user_id = nil) ⇒ Object

Parameters:

  • export_id (String) —

    ID of the AI request logs export, 36 characters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 766

def check_ai_request_logs_export_status(export_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/request-logs/exports/#{export_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#clone_ai_prompt(ai_prompt_id, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 219

def clone_ai_prompt(ai_prompt_id, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/clones"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#create_ai_prompt_fine_tuning_job(ai_prompt_id, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 368

def create_ai_prompt_fine_tuning_job(ai_prompt_id, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/fine-tuning/jobs"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#create_ai_proxy_chat_completion(ai_provider_id, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 546

def create_ai_proxy_chat_completion(ai_provider_id, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/chat/completions"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#delete_ai_prompt(ai_prompt_id, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 165

def delete_ai_prompt(ai_prompt_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#delete_ai_provider(ai_provider_id, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 492

def delete_ai_provider(ai_provider_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#delete_ai_snippet(ai_snippet_id, user_id = nil) ⇒ Object

Parameters:

  • ai_snippet_id (Integer) —

    AI Snippet identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 871

def delete_ai_snippet(ai_snippet_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/settings/snippets/#{ai_snippet_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#download_ai_prompt_completion(ai_prompt_id, completion_id, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • completion_id (String) —

    Ai Prompt Completion Identifier

  • destination (String) (defaults to: nil) —

    Destination of File

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 294

def download_ai_prompt_completion(ai_prompt_id, completion_id, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/completions/#{completion_id}/download"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_ai_prompt_fine_tuning_dataset(ai_prompt_id, job_identifier, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • job_identifier (String) —

    AI Prompt Fine-Tuning Dataset Generation Identifier, consists of 36 characters

  • destination (String) (defaults to: nil) —

    Destination of File

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 350

def download_ai_prompt_fine_tuning_dataset(ai_prompt_id, job_identifier, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/fine-tuning/datasets/#{job_identifier}/download"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_ai_report(ai_report_id, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • ai_report_id (String) —

    AI Report Identifier, consists of 36 characters

  • destination (String) (defaults to: nil) —

    Destination of File

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 713

def download_ai_report(ai_report_id, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/reports/#{ai_report_id}/download"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_ai_request_logs_export(export_id, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • export_id (String) —

    ID of the AI request logs export, 36 characters

  • destination (String) (defaults to: nil) —

    Destination of File

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 784

def download_ai_request_logs_export(export_id, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/request-logs/exports/#{export_id}/download"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_translated_file(job_identifier, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • job_identifier (String) —

    AI File Translations job identifier

  • destination (String) (defaults to: nil) —

    Destination of File

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 76

def download_translated_file(job_identifier, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/file-translations/#{job_identifier}/download"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_translated_file_strings(job_identifier, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • job_identifier (String) —

    AI File Translations job identifier

  • destination (String) (defaults to: nil) —

    Destination of File

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 94

def download_translated_file_strings(job_identifier, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/file-translations/#{job_identifier}/translations"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#edit_ai_prompt(ai_prompt_id, body = [], user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • body (Array) (defaults to: []) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 200

def edit_ai_prompt(ai_prompt_id, body = [], user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#edit_ai_provider(ai_provider_id, body = [], user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • body (Array) (defaults to: []) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 527

def edit_ai_provider(ai_provider_id, body = [], user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#edit_ai_settings(body = [], user_id = nil) ⇒ Object

Parameters:

  • body (Array) (defaults to: []) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 817

def edit_ai_settings(body = [], user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/settings'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#edit_ai_snippet(ai_snippet_id, body = [], user_id = nil) ⇒ Object

Parameters:

  • ai_snippet_id (Integer) —

    AI Snippet identifier

  • body (Array) (defaults to: []) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 906

def edit_ai_snippet(ai_snippet_id, body = [], user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/settings/snippets/#{ai_snippet_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#export_ai_request_logs(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 748

def export_ai_request_logs(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/request-logs/exports'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#generate_ai_prompt_completion(ai_prompt_id, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 238

def generate_ai_prompt_completion(ai_prompt_id, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/completions"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#generate_ai_prompt_fine_tuning_dataset(ai_prompt_id, body = {}, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 312

def generate_ai_prompt_fine_tuning_dataset(ai_prompt_id, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/fine-tuning/datasets"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#generate_ai_report(body = {}, user_id = nil) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 677

def generate_ai_report(body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/reports'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#get_ai_prompt(ai_prompt_id, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 182

def get_ai_prompt(ai_prompt_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_prompt_completion_status(ai_prompt_id, completion_id, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • completion_id (String) —

    Ai Prompt Completion Identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 275

def get_ai_prompt_completion_status(ai_prompt_id, completion_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/completions/#{completion_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_prompt_fine_tuning_dataset_generation_status(ai_prompt_id, job_identifier, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • job_identifier (String) —

    AI Prompt Fine-Tuning Dataset Generation Identifier, consists of 36 characters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 331

def get_ai_prompt_fine_tuning_dataset_generation_status(ai_prompt_id, job_identifier, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/fine-tuning/datasets/#{job_identifier}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_prompt_fine_tuning_job_status(ai_prompt_id, job_identifier, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • job_identifier (String) —

    AI Prompt Fine-Tuning Job Identifier, consists of 36 characters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 387

def get_ai_prompt_fine_tuning_job_status(ai_prompt_id, job_identifier, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/fine-tuning/jobs/#{job_identifier}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_provider(ai_provider_id, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 509

def get_ai_provider(ai_provider_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_settings(user_id = nil) ⇒ Object

Parameters:

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 800

def get_ai_settings(user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/settings'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_snippet(ai_snippet_id, user_id = nil) ⇒ Object

Parameters:

  • ai_snippet_id (Integer) —

    AI Snippet identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 888

def get_ai_snippet(ai_snippet_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/settings/snippets/#{ai_snippet_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_ai_usage_member(member_id, user_id = nil) ⇒ Object

Parameters:

  • member_id (Integer) —

    User Identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



960
961
962
963
964
965
966
967
968
969
970
971
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 960

def get_ai_usage_member(member_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/usage/members/#{member_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_file_translations_status(job_identifier, user_id = nil) ⇒ Object

Parameters:

  • job_identifier (String) —

    AI File Translations job identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 58

def get_file_translations_status(job_identifier, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/file-translations/#{job_identifier}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_project_ai_settings(project_id = config.project_id) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 8

def get_project_ai_settings(project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/ai/settings"
  )
  Web::SendRequest.new(request).perform
end

#list_ai_prompt_fine_tuning_events(ai_prompt_id, job_identifier, user_id = nil) ⇒ Object

Parameters:

  • ai_prompt_id (Integer) —

    AI Prompt identifier

  • job_identifier (String) —

    AI Prompt Fine-Tuning Job Identifier, consists of 36 characters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 405

def list_ai_prompt_fine_tuning_events(ai_prompt_id, job_identifier, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/prompts/#{ai_prompt_id}/fine-tuning/jobs/#{job_identifier}/events"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#list_ai_prompt_fine_tuning_jobs(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 147

def list_ai_prompt_fine_tuning_jobs(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/prompts/fine-tuning/jobs'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_ai_prompts(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 111

def list_ai_prompts(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/prompts'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_ai_provider_models(ai_provider_id, user_id = nil) ⇒ Object

Parameters:

  • ai_provider_id (Integer) —

    AI Provider identifier

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 660

def list_ai_provider_models(ai_provider_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "ai/providers/#{ai_provider_id}/models"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#list_ai_providers(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 422

def list_ai_providers(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/providers'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_ai_request_logs(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 730

def list_ai_request_logs(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/request-logs'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_ai_snippets(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 835

def list_ai_snippets(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/settings/snippets'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_ai_usage_members(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 942

def list_ai_usage_members(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/usage/members'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_all_ai_provider_models(user_id = nil) ⇒ Object

Parameters:

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 457

def list_all_ai_provider_models(user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/providers/models'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#list_supported_ai_provider_models(query = {}, user_id = nil) ⇒ Object

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters

  • user_id (Integer) (defaults to: nil) —

    User Identifier (Crowdin only)



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/crowdin-api/api_resources/ai.rb', line 474

def list_supported_ai_provider_models(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'ai/providers/supported-models'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end