falaai-api 1.21.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +205 -0
  4. data/docs/AnalysisApi.md +147 -0
  5. data/docs/AudioEvent.md +26 -0
  6. data/docs/AudioInputMeta.md +26 -0
  7. data/docs/AuditoriaRiscoAnalysisV2.md +22 -0
  8. data/docs/AuditoriaRiscoAppliedActionV2.md +32 -0
  9. data/docs/AuditoriaRiscoAudioEventModelV2.md +22 -0
  10. data/docs/AuditoriaRiscoAuditDecisionsV2.md +22 -0
  11. data/docs/AuditoriaRiscoConversationScoresV2.md +38 -0
  12. data/docs/AuditoriaRiscoDetectionItemV2.md +110 -0
  13. data/docs/AuditoriaRiscoDetectionsV2.md +26 -0
  14. data/docs/AuditoriaRiscoIndexerV2.md +18 -0
  15. data/docs/AuditoriaRiscoMetaV2.md +28 -0
  16. data/docs/AuditoriaRiscoParticipantV2.md +22 -0
  17. data/docs/AuditoriaRiscoParticipantsV2.md +26 -0
  18. data/docs/AuditoriaRiscoRequest.md +38 -0
  19. data/docs/AuditoriaRiscoScoresV2.md +20 -0
  20. data/docs/AuditoriaRiscoScoringExplanationV2.md +20 -0
  21. data/docs/AuditoriaRiscoSummaryV2.md +48 -0
  22. data/docs/AuditoriaRiscoTimelineV2.md +22 -0
  23. data/docs/AuditoriaRiscoUsageV2.md +22 -0
  24. data/docs/AuditoriaRiscoV2.md +46 -0
  25. data/docs/AuditoriaRiscoV2Response.md +18 -0
  26. data/docs/AuditoriaRiscoVerdictV2.md +30 -0
  27. data/docs/CreateEmailAlertRequest.md +22 -0
  28. data/docs/CreateWebhookRequest.md +24 -0
  29. data/docs/DiagnosticAnalysisMap.md +28 -0
  30. data/docs/DiagnosticAudioEvent.md +26 -0
  31. data/docs/DiagnosticCategoricalAnalysis.md +22 -0
  32. data/docs/DiagnosticRequest.md +30 -0
  33. data/docs/DiagnosticResponse.md +28 -0
  34. data/docs/DiagnosticTextAnalysis.md +18 -0
  35. data/docs/DiagnosticUsage.md +22 -0
  36. data/docs/EmailAlertItem.md +32 -0
  37. data/docs/EmailAlertListResponse.md +22 -0
  38. data/docs/EmailAlertMessageResponse.md +18 -0
  39. data/docs/EmailAlertsApi.md +285 -0
  40. data/docs/EmailEvent.md +15 -0
  41. data/docs/HTTPValidationError.md +18 -0
  42. data/docs/HealthApi.md +137 -0
  43. data/docs/HealthResponse.md +28 -0
  44. data/docs/LocationInner.md +15 -0
  45. data/docs/MessageResponse.md +18 -0
  46. data/docs/Participant.md +22 -0
  47. data/docs/ParticipantDiagnostic.md +26 -0
  48. data/docs/SpeechApi.md +85 -0
  49. data/docs/TranscriptionResponse.md +49 -0
  50. data/docs/TranscriptionUsage.md +22 -0
  51. data/docs/UpdateEmailAlertRequest.md +24 -0
  52. data/docs/UpdateWebhookRequest.md +26 -0
  53. data/docs/UsageApi.md +151 -0
  54. data/docs/UsageByKeyItem.md +26 -0
  55. data/docs/UsageLogItem.md +28 -0
  56. data/docs/UsageLogResponse.md +22 -0
  57. data/docs/ValidationError.md +26 -0
  58. data/docs/VersionApi.md +72 -0
  59. data/docs/VersionResponse.md +22 -0
  60. data/docs/WebhookEvent.md +15 -0
  61. data/docs/WebhookItem.md +42 -0
  62. data/docs/WebhookListResponse.md +22 -0
  63. data/docs/WebhooksApi.md +293 -0
  64. data/lib/falaai-api/api/analysis_api.rb +158 -0
  65. data/lib/falaai-api/api/email_alerts_api.rb +294 -0
  66. data/lib/falaai-api/api/health_api.rb +132 -0
  67. data/lib/falaai-api/api/speech_api.rb +100 -0
  68. data/lib/falaai-api/api/usage_api.rb +156 -0
  69. data/lib/falaai-api/api/version_api.rb +77 -0
  70. data/lib/falaai-api/api/webhooks_api.rb +302 -0
  71. data/lib/falaai-api/api_client.rb +397 -0
  72. data/lib/falaai-api/api_error.rb +58 -0
  73. data/lib/falaai-api/api_model_base.rb +88 -0
  74. data/lib/falaai-api/configuration.rb +309 -0
  75. data/lib/falaai-api/models/audio_event.rb +273 -0
  76. data/lib/falaai-api/models/audio_input_meta.rb +273 -0
  77. data/lib/falaai-api/models/auditoria_risco_analysis_v2.rb +174 -0
  78. data/lib/falaai-api/models/auditoria_risco_applied_action_v2.rb +292 -0
  79. data/lib/falaai-api/models/auditoria_risco_audio_event_model_v2.rb +174 -0
  80. data/lib/falaai-api/models/auditoria_risco_audit_decisions_v2.rb +170 -0
  81. data/lib/falaai-api/models/auditoria_risco_conversation_scores_v2.rb +251 -0
  82. data/lib/falaai-api/models/auditoria_risco_detection_item_v2.rb +651 -0
  83. data/lib/falaai-api/models/auditoria_risco_detections_v2.rb +198 -0
  84. data/lib/falaai-api/models/auditoria_risco_indexer_v2.rb +150 -0
  85. data/lib/falaai-api/models/auditoria_risco_meta_v2.rb +234 -0
  86. data/lib/falaai-api/models/auditoria_risco_participant_v2.rb +168 -0
  87. data/lib/falaai-api/models/auditoria_risco_participants_v2.rb +196 -0
  88. data/lib/falaai-api/models/auditoria_risco_request.rb +451 -0
  89. data/lib/falaai-api/models/auditoria_risco_scores_v2.rb +177 -0
  90. data/lib/falaai-api/models/auditoria_risco_scoring_explanation_v2.rb +160 -0
  91. data/lib/falaai-api/models/auditoria_risco_summary_v2.rb +300 -0
  92. data/lib/falaai-api/models/auditoria_risco_timeline_v2.rb +174 -0
  93. data/lib/falaai-api/models/auditoria_risco_usage_v2.rb +219 -0
  94. data/lib/falaai-api/models/auditoria_risco_v2.rb +548 -0
  95. data/lib/falaai-api/models/auditoria_risco_v2_response.rb +165 -0
  96. data/lib/falaai-api/models/auditoria_risco_verdict_v2.rb +213 -0
  97. data/lib/falaai-api/models/create_email_alert_request.rb +221 -0
  98. data/lib/falaai-api/models/create_webhook_request.rb +233 -0
  99. data/lib/falaai-api/models/diagnostic_analysis_map.rb +285 -0
  100. data/lib/falaai-api/models/diagnostic_audio_event.rb +205 -0
  101. data/lib/falaai-api/models/diagnostic_categorical_analysis.rb +170 -0
  102. data/lib/falaai-api/models/diagnostic_request.rb +316 -0
  103. data/lib/falaai-api/models/diagnostic_response.rb +283 -0
  104. data/lib/falaai-api/models/diagnostic_text_analysis.rb +148 -0
  105. data/lib/falaai-api/models/diagnostic_usage.rb +219 -0
  106. data/lib/falaai-api/models/email_alert_item.rb +356 -0
  107. data/lib/falaai-api/models/email_alert_list_response.rb +218 -0
  108. data/lib/falaai-api/models/email_alert_message_response.rb +165 -0
  109. data/lib/falaai-api/models/email_event.rb +47 -0
  110. data/lib/falaai-api/models/health_response.rb +300 -0
  111. data/lib/falaai-api/models/http_validation_error.rb +149 -0
  112. data/lib/falaai-api/models/location_inner.rb +103 -0
  113. data/lib/falaai-api/models/message_response.rb +165 -0
  114. data/lib/falaai-api/models/participant.rb +226 -0
  115. data/lib/falaai-api/models/participant_diagnostic.rb +222 -0
  116. data/lib/falaai-api/models/transcription_response.rb +540 -0
  117. data/lib/falaai-api/models/transcription_usage.rb +219 -0
  118. data/lib/falaai-api/models/update_email_alert_request.rb +176 -0
  119. data/lib/falaai-api/models/update_webhook_request.rb +190 -0
  120. data/lib/falaai-api/models/usage_by_key_item.rb +256 -0
  121. data/lib/falaai-api/models/usage_log_item.rb +300 -0
  122. data/lib/falaai-api/models/usage_log_response.rb +218 -0
  123. data/lib/falaai-api/models/validation_error.rb +237 -0
  124. data/lib/falaai-api/models/version_response.rb +219 -0
  125. data/lib/falaai-api/models/webhook_event.rb +48 -0
  126. data/lib/falaai-api/models/webhook_item.rb +442 -0
  127. data/lib/falaai-api/models/webhook_list_response.rb +218 -0
  128. data/lib/falaai-api/version.rb +15 -0
  129. data/lib/falaai-api.rb +100 -0
  130. metadata +229 -0
@@ -0,0 +1,110 @@
1
+ # FalaAI::AuditoriaRiscoDetectionItemV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **turn** | **Integer** | Turn number | [optional] |
8
+ | **interlocutor** | **String** | Speaker | [optional] |
9
+ | **role** | **String** | Role | [optional] |
10
+ | **timestamp_start_s** | **Float** | Start (s) | [optional] |
11
+ | **timestamp_end_s** | **Float** | End (s) | [optional] |
12
+ | **timestamp_formatted** | **String** | Formatted timestamp | [optional] |
13
+ | **term_text** | **String** | Detected term | [optional] |
14
+ | **suggested_term_for_bank** | **Object** | Suggested term for bank | [optional] |
15
+ | **category** | **String** | Category code | [optional] |
16
+ | **category_label** | **String** | Category label (i18n) | |
17
+ | **category_color** | **String** | Category color | [optional] |
18
+ | **category_icon** | **String** | Category icon | [optional] |
19
+ | **criticality** | **String** | Criticality | [optional] |
20
+ | **category_threshold** | **Float** | Category threshold | [optional] |
21
+ | **category_type** | **String** | Category type | [optional] |
22
+ | **category_group** | **String** | Category group label (i18n) | |
23
+ | **nature** | **String** | Nature | [optional] |
24
+ | **llm_confidence** | **Float** | LLM confidence | [optional] |
25
+ | **reason** | **String** | Reason | [optional] |
26
+ | **is_valid_context** | **Boolean** | Valid context | [optional] |
27
+ | **risk_probability** | **Float** | Risk probability | [optional] |
28
+ | **risk_impact** | **Float** | Risk impact | [optional] |
29
+ | **category_weight** | **Float** | Category weight | [optional] |
30
+ | **turn_sentiment** | **String** | Turn sentiment | [optional] |
31
+ | **intensity** | **Object** | Intensity | [optional] |
32
+ | **mod_applied** | **Float** | Total modifier applied | [optional] |
33
+ | **mac_applied** | **Float** | Audio modifier applied | [optional] |
34
+ | **mvad_applied** | **Float** | Intensity modifier applied | [optional] |
35
+ | **mod_formula** | **String** | Modifier formula | [optional] |
36
+ | **mac_details** | **Array<Hash<String, Object>>** | MAC details | [optional] |
37
+ | **calibration_reason** | **String** | Calibration reason | [optional] |
38
+ | **final_score** | **Float** | Final score | [optional] |
39
+ | **final_score_formula** | **String** | Final score formula | [optional] |
40
+ | **conversation_limit** | **Object** | Conversation limit | [optional] |
41
+ | **apply_saturation** | **Boolean** | Apply saturation | [optional] |
42
+ | **block_repetition** | **Boolean** | Block repetition | [optional] |
43
+ | **status** | **String** | Status | [optional] |
44
+ | **effective_impact** | **Float** | Effective impact | [optional] |
45
+ | **saturation_factor** | **Float** | Saturation factor | [optional] |
46
+ | **saturation_formula** | **String** | Saturation formula | [optional] |
47
+ | **threshold_formula** | **String** | Threshold formula | [optional] |
48
+ | **blocked_formula** | **String** | Blocked formula | [optional] |
49
+ | **reconciliation_note** | **String** | Reconciliation note | [optional] |
50
+ | **violated_frameworks** | **Array<Object>** | Violated frameworks | [optional] |
51
+ | **citation_fidelity** | **Boolean** | Citation fidelity | [optional][default to true] |
52
+ | **subcategory** | **String** | Subcategory code | [optional] |
53
+ | **subcategory_label** | **String** | Subcategory label (i18n) | [optional] |
54
+
55
+ ## Example
56
+
57
+ ```ruby
58
+ require 'falaai-api'
59
+
60
+ instance = FalaAI::AuditoriaRiscoDetectionItemV2.new(
61
+ turn: null,
62
+ interlocutor: null,
63
+ role: null,
64
+ timestamp_start_s: null,
65
+ timestamp_end_s: null,
66
+ timestamp_formatted: null,
67
+ term_text: null,
68
+ suggested_term_for_bank: null,
69
+ category: null,
70
+ category_label: null,
71
+ category_color: null,
72
+ category_icon: null,
73
+ criticality: null,
74
+ category_threshold: null,
75
+ category_type: null,
76
+ category_group: null,
77
+ nature: null,
78
+ llm_confidence: null,
79
+ reason: null,
80
+ is_valid_context: null,
81
+ risk_probability: null,
82
+ risk_impact: null,
83
+ category_weight: null,
84
+ turn_sentiment: null,
85
+ intensity: null,
86
+ mod_applied: null,
87
+ mac_applied: null,
88
+ mvad_applied: null,
89
+ mod_formula: null,
90
+ mac_details: null,
91
+ calibration_reason: null,
92
+ final_score: null,
93
+ final_score_formula: null,
94
+ conversation_limit: null,
95
+ apply_saturation: null,
96
+ block_repetition: null,
97
+ status: null,
98
+ effective_impact: null,
99
+ saturation_factor: null,
100
+ saturation_formula: null,
101
+ threshold_formula: null,
102
+ blocked_formula: null,
103
+ reconciliation_note: null,
104
+ violated_frameworks: null,
105
+ citation_fidelity: null,
106
+ subcategory: null,
107
+ subcategory_label: null
108
+ )
109
+ ```
110
+
@@ -0,0 +1,26 @@
1
+ # FalaAI::AuditoriaRiscoDetectionsV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **violations** | [**Array<AuditoriaRiscoDetectionItemV2>**](AuditoriaRiscoDetectionItemV2.md) | Active violations | [optional] |
8
+ | **positives** | [**Array<AuditoriaRiscoDetectionItemV2>**](AuditoriaRiscoDetectionItemV2.md) | Active positives | [optional] |
9
+ | **client_risk_alerts** | **Array<Hash<String, Object>>** | Client risk alerts | [optional] |
10
+ | **client_behavior_alerts** | **Array<Hash<String, Object>>** | Client behavior alerts | [optional] |
11
+ | **client_negatives** | [**Array<AuditoriaRiscoDetectionItemV2>**](AuditoriaRiscoDetectionItemV2.md) | Client negatives | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'falaai-api'
17
+
18
+ instance = FalaAI::AuditoriaRiscoDetectionsV2.new(
19
+ violations: null,
20
+ positives: null,
21
+ client_risk_alerts: null,
22
+ client_behavior_alerts: null,
23
+ client_negatives: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # FalaAI::AuditoriaRiscoIndexerV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **suggested_terms_for_bank** | **Array<Hash<String, Object>>** | Suggested terms for bank | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'falaai-api'
13
+
14
+ instance = FalaAI::AuditoriaRiscoIndexerV2.new(
15
+ suggested_terms_for_bank: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,28 @@
1
+ # FalaAI::AuditoriaRiscoMetaV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Analysis id | |
8
+ | **object** | **String** | Object type | [optional][default to 'auditoria_risco'] |
9
+ | **call_duration_s** | **Float** | Call duration (s) | [optional] |
10
+ | **analyzed_at** | **String** | ISO 8601 analyzed timestamp | [optional] |
11
+ | **usage** | [**AuditoriaRiscoUsageV2**](AuditoriaRiscoUsageV2.md) | Usage block | |
12
+ | **client_reference_id** | **String** | Echoed client reference id | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'falaai-api'
18
+
19
+ instance = FalaAI::AuditoriaRiscoMetaV2.new(
20
+ id: null,
21
+ object: null,
22
+ call_duration_s: null,
23
+ analyzed_at: null,
24
+ usage: null,
25
+ client_reference_id: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # FalaAI::AuditoriaRiscoParticipantV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **interlocutor** | **String** | Speaker label | [optional] |
8
+ | **name** | **String** | Participant name | [optional] |
9
+ | **role** | **String** | Role (agent/client/bot/unknown) | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'falaai-api'
15
+
16
+ instance = FalaAI::AuditoriaRiscoParticipantV2.new(
17
+ interlocutor: null,
18
+ name: null,
19
+ role: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # FalaAI::AuditoriaRiscoParticipantsV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **identified** | [**Array<AuditoriaRiscoParticipantV2>**](AuditoriaRiscoParticipantV2.md) | Identified participants | [optional] |
8
+ | **call_direction** | **String** | inbound/outbound | [optional] |
9
+ | **role_inference_reliable** | **Boolean** | Role inference reliability | [optional][default to true] |
10
+ | **identification_status** | **String** | Identification status | [optional][default to 'none'] |
11
+ | **unidentified_items_count** | **Integer** | Unidentified items count | [optional][default to 0] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'falaai-api'
17
+
18
+ instance = FalaAI::AuditoriaRiscoParticipantsV2.new(
19
+ identified: null,
20
+ call_direction: null,
21
+ role_inference_reliable: null,
22
+ identification_status: null,
23
+ unidentified_items_count: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,38 @@
1
+ # FalaAI::AuditoriaRiscoRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | **String** | Analysis model. Always 'falaai-auditoria-risco-1' | [optional][default to 'falaai-auditoria-risco-1'] |
8
+ | **text** | **String** | Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters | [optional][default to ''] |
9
+ | **dialog** | **String** | Diarized transcript with speaker turns. PRIMARY source. Speaker labels accepted (any case): 'Speaker N', 'Interlocutor N', 'Hablante N', 'Locutor N', 'Orador N' (space or underscore). Normalized internally to 'Speaker N' in the response. Max 300,000 characters | [optional][default to ''] |
10
+ | **audio_events** | [**Array<DiagnosticAudioEvent>**](DiagnosticAudioEvent.md) | Audio events with timestamps (correlated with turns when diarization is present) | [optional] |
11
+ | **duration_seconds** | **Float** | Total audio duration in seconds. Required. Max 3h (10800s). | |
12
+ | **language** | **String** | Language of the transcript being analyzed. Must match the dialog/text language. Accepted: pt-BR, en-US, es-ES. | |
13
+ | **response_language** | **String** | Language for analysis results (labels, categories, levels, actions, HTML report). Can differ from 'language'. Accepted: pt-BR, en-US, es-ES. | |
14
+ | **call_direction** | **String** | Who originated the call. inbound=client called, outbound=company called. If omitted, LLM infers from context. | [optional] |
15
+ | **participants** | [**Array<Participant>**](Participant.md) | Explicit participant roles. If omitted, LLM infers from dialog (Lei 17). When provided, used as ground truth — no inference. | [optional] |
16
+ | **response_format** | **String** | Response format version. v1=legacy flat PT-BR, v2=structured EN-US blocks. | [optional][default to 'v2'] |
17
+ | **client_reference_id** | **String** | Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'falaai-api'
23
+
24
+ instance = FalaAI::AuditoriaRiscoRequest.new(
25
+ model: falaai-auditoria-risco-1,
26
+ text: null,
27
+ dialog: Speaker 1: [00:00:00.540 - 00:00:01.139] Hi, Alex.,
28
+ audio_events: null,
29
+ duration_seconds: null,
30
+ language: pt-BR,
31
+ response_language: en-US,
32
+ call_direction: inbound,
33
+ participants: [{interlocutor=Interlocutor 1, name=Antonio, role=client}, {interlocutor=Interlocutor 2, name=Maria, role=agent}],
34
+ response_format: v2,
35
+ client_reference_id: call-2026-08-30-001
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # FalaAI::AuditoriaRiscoScoresV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation** | [**AuditoriaRiscoConversationScoresV2**](AuditoriaRiscoConversationScoresV2.md) | Conversation scores | |
8
+ | **per_participant** | **Hash<String, Object>** | Per-participant KPIs | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'falaai-api'
14
+
15
+ instance = FalaAI::AuditoriaRiscoScoresV2.new(
16
+ conversation: null,
17
+ per_participant: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # FalaAI::AuditoriaRiscoScoringExplanationV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **summary** | **String** | Explanation summary | [optional] |
8
+ | **steps** | **Array<Object>** | Explanation steps | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'falaai-api'
14
+
15
+ instance = FalaAI::AuditoriaRiscoScoringExplanationV2.new(
16
+ summary: null,
17
+ steps: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,48 @@
1
+ # FalaAI::AuditoriaRiscoSummaryV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total_turns** | **Integer** | Total turns | [optional] |
8
+ | **total_calibrated** | **Integer** | Total calibrated detections | [optional] |
9
+ | **active** | **Integer** | Active detections | [optional] |
10
+ | **tolerated** | **Integer** | Tolerated detections | [optional] |
11
+ | **blocked** | **Integer** | Blocked detections | [optional] |
12
+ | **audio_events_used** | **Integer** | Audio events used | [optional] |
13
+ | **audio_events_aggravated** | **Integer** | Audio events aggravated | [optional] |
14
+ | **mac_audio_applied** | **Object** | MAC audio applied | [optional] |
15
+ | **mvad_applied** | **Object** | MVAD applied | [optional] |
16
+ | **total_participants** | **Integer** | Total participants | [optional] |
17
+ | **total_agents** | **Integer** | Total agents | [optional] |
18
+ | **total_clients** | **Integer** | Total clients | [optional] |
19
+ | **total_bots** | **Integer** | Total bots | [optional] |
20
+ | **total_unknown** | **Integer** | Total unknown | [optional] |
21
+ | **client_risk_alerts_count** | **Integer** | Client risk alerts count | [optional] |
22
+ | **client_behavior_alerts_count** | **Integer** | Client behavior alerts count | [optional] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'falaai-api'
28
+
29
+ instance = FalaAI::AuditoriaRiscoSummaryV2.new(
30
+ total_turns: null,
31
+ total_calibrated: null,
32
+ active: null,
33
+ tolerated: null,
34
+ blocked: null,
35
+ audio_events_used: null,
36
+ audio_events_aggravated: null,
37
+ mac_audio_applied: null,
38
+ mvad_applied: null,
39
+ total_participants: null,
40
+ total_agents: null,
41
+ total_clients: null,
42
+ total_bots: null,
43
+ total_unknown: null,
44
+ client_risk_alerts_count: null,
45
+ client_behavior_alerts_count: null
46
+ )
47
+ ```
48
+
@@ -0,0 +1,22 @@
1
+ # FalaAI::AuditoriaRiscoTimelineV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **turns_sentiment** | **Array<Hash<String, Object>>** | Per-turn sentiment | [optional] |
8
+ | **audio_events** | **Array<Hash<String, Object>>** | Audio events (i18n) | [optional] |
9
+ | **audio_groups_found** | **Array<Hash<String, Object>>** | Audio groups found | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'falaai-api'
15
+
16
+ instance = FalaAI::AuditoriaRiscoTimelineV2.new(
17
+ turns_sentiment: null,
18
+ audio_events: null,
19
+ audio_groups_found: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # FalaAI::AuditoriaRiscoUsageV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **characters** | **Integer** | Characters analyzed | |
8
+ | **credits_consumed** | **Integer** | Credits consumed | |
9
+ | **processing_ms** | **Integer** | Processing time (ms) | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'falaai-api'
15
+
16
+ instance = FalaAI::AuditoriaRiscoUsageV2.new(
17
+ characters: null,
18
+ credits_consumed: null,
19
+ processing_ms: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,46 @@
1
+ # FalaAI::AuditoriaRiscoV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **meta** | [**AuditoriaRiscoMetaV2**](AuditoriaRiscoMetaV2.md) | Identification + usage | |
8
+ | **participants** | [**AuditoriaRiscoParticipantsV2**](AuditoriaRiscoParticipantsV2.md) | Participants/roles/direction | |
9
+ | **verdict** | [**AuditoriaRiscoVerdictV2**](AuditoriaRiscoVerdictV2.md) | Verdict + level + applied actions | |
10
+ | **scores** | [**AuditoriaRiscoScoresV2**](AuditoriaRiscoScoresV2.md) | Consolidated + per-participant scores | |
11
+ | **detections** | [**AuditoriaRiscoDetectionsV2**](AuditoriaRiscoDetectionsV2.md) | violations/positives/client alerts | |
12
+ | **analysis** | [**AuditoriaRiscoAnalysisV2**](AuditoriaRiscoAnalysisV2.md) | global_metrics + final_analysis + frameworks | |
13
+ | **timeline** | [**AuditoriaRiscoTimelineV2**](AuditoriaRiscoTimelineV2.md) | turns_sentiment + audio_events + groups | |
14
+ | **audio_event_model** | [**AuditoriaRiscoAudioEventModelV2**](AuditoriaRiscoAudioEventModelV2.md) | MAC audio event semantics | |
15
+ | **categories_summary** | **Hash<String, Object>** | Per-category summary (keyed by category) | |
16
+ | **indexer** | [**AuditoriaRiscoIndexerV2**](AuditoriaRiscoIndexerV2.md) | Suggested terms for bank | |
17
+ | **summary** | [**AuditoriaRiscoSummaryV2**](AuditoriaRiscoSummaryV2.md) | Executive summary counts | |
18
+ | **acoes_i18n** | **Hash<String, Object>** | Used actions i18n catalog (keyed by action) | |
19
+ | **audit_decisions** | [**AuditoriaRiscoAuditDecisionsV2**](AuditoriaRiscoAuditDecisionsV2.md) | Risk origin + validator changes | |
20
+ | **scoring_explanation** | [**AuditoriaRiscoScoringExplanationV2**](AuditoriaRiscoScoringExplanationV2.md) | Score composition explanation | |
21
+ | **html_report** | **String** | HTML report (base64 gzip) | |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'falaai-api'
27
+
28
+ instance = FalaAI::AuditoriaRiscoV2.new(
29
+ meta: null,
30
+ participants: null,
31
+ verdict: null,
32
+ scores: null,
33
+ detections: null,
34
+ analysis: null,
35
+ timeline: null,
36
+ audio_event_model: null,
37
+ categories_summary: null,
38
+ indexer: null,
39
+ summary: null,
40
+ acoes_i18n: null,
41
+ audit_decisions: null,
42
+ scoring_explanation: null,
43
+ html_report: null
44
+ )
45
+ ```
46
+
@@ -0,0 +1,18 @@
1
+ # FalaAI::AuditoriaRiscoV2Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **response** | [**AuditoriaRiscoV2**](AuditoriaRiscoV2.md) | Public response V2 — always returned | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'falaai-api'
13
+
14
+ instance = FalaAI::AuditoriaRiscoV2Response.new(
15
+ response: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,30 @@
1
+ # FalaAI::AuditoriaRiscoVerdictV2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label** | **String** | Human-readable verdict | [optional] |
8
+ | **level_code** | **String** | Classification level code | [optional] |
9
+ | **color** | **String** | Level color | [optional] |
10
+ | **icon** | **String** | Level icon | [optional] |
11
+ | **risk_matrix** | **Hash<String, Object>** | Risk matrix | [optional] |
12
+ | **applied_actions** | [**Array<AuditoriaRiscoAppliedActionV2>**](AuditoriaRiscoAppliedActionV2.md) | Applied actions | [optional] |
13
+ | **decision_details** | **Object** | Decision details | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'falaai-api'
19
+
20
+ instance = FalaAI::AuditoriaRiscoVerdictV2.new(
21
+ label: null,
22
+ level_code: null,
23
+ color: null,
24
+ icon: null,
25
+ risk_matrix: null,
26
+ applied_actions: null,
27
+ decision_details: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # FalaAI::CreateEmailAlertRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Nome identificador | |
8
+ | **email** | **String** | Email destino | |
9
+ | **events** | [**Array<EmailEvent>**](EmailEvent.md) | Eventos subscritos | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'falaai-api'
15
+
16
+ instance = FalaAI::CreateEmailAlertRequest.new(
17
+ name: Financeiro,
18
+ email: finance@empresa.com,
19
+ events: [payment.failed, subscription.renewed]
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # FalaAI::CreateWebhookRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Nome identificador do webhook | |
8
+ | **url** | **String** | URL HTTPS que recebera POST com HMAC FalaAI-Signature | |
9
+ | **events** | [**Array<WebhookEvent>**](WebhookEvent.md) | Eventos subscritos (10 alertas) | |
10
+ | **retry_enabled** | **Boolean** | Retry exponencial 5 tentativas quando true (false=1 tentativa) | [optional][default to false] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'falaai-api'
16
+
17
+ instance = FalaAI::CreateWebhookRequest.new(
18
+ name: Alertas FalaAI,
19
+ url: https://webhook.site/00000000-0000-0000-0000-000000000000,
20
+ events: [credits.low, credits.exhausted, payment.failed],
21
+ retry_enabled: false
22
+ )
23
+ ```
24
+
@@ -0,0 +1,28 @@
1
+ # FalaAI::DiagnosticAnalysisMap
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dialogue_summary** | [**DiagnosticTextAnalysis**](DiagnosticTextAnalysis.md) | Detailed conversation summary | |
8
+ | **contact_reason** | [**DiagnosticTextAnalysis**](DiagnosticTextAnalysis.md) | Initial contact reason | |
9
+ | **identified_action** | [**DiagnosticCategoricalAnalysis**](DiagnosticCategoricalAnalysis.md) | Action taken / resolution | |
10
+ | **identified_label** | [**DiagnosticCategoricalAnalysis**](DiagnosticCategoricalAnalysis.md) | Theme classification | |
11
+ | **sentiment** | [**DiagnosticCategoricalAnalysis**](DiagnosticCategoricalAnalysis.md) | Predominant sentiment | |
12
+ | **participants_identified** | [**Array<ParticipantDiagnostic>**](ParticipantDiagnostic.md) | Identified participants and roles (same field names as auditoria) | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'falaai-api'
18
+
19
+ instance = FalaAI::DiagnosticAnalysisMap.new(
20
+ dialogue_summary: null,
21
+ contact_reason: null,
22
+ identified_action: null,
23
+ identified_label: null,
24
+ sentiment: null,
25
+ participants_identified: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # FalaAI::DiagnosticAudioEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **event** | **String** | Audio event type. E.g.: [laughter], [sigh] | |
8
+ | **start_s** | **Float** | Start time in seconds | [optional] |
9
+ | **end_s** | **Float** | End time in seconds | [optional] |
10
+ | **duration_s** | **Float** | Duration in seconds | [optional] |
11
+ | **formatted_timestamp** | **String** | Formatted timestamp (HH:MM:SS.ms) | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'falaai-api'
17
+
18
+ instance = FalaAI::DiagnosticAudioEvent.new(
19
+ event: [laughter],
20
+ start_s: 72.98,
21
+ end_s: 74.34,
22
+ duration_s: 1.36,
23
+ formatted_timestamp: 00:01:12.980
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # FalaAI::DiagnosticCategoricalAnalysis
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **list_choice** | **String** | Selected value from classification list (used in action, label, sentiment) | [optional] |
8
+ | **justification** | **String** | Justification for the choice | [optional] |
9
+ | **evidence_phrases** | **Array<String>** | Verbatim transcript excerpts supporting the analysis | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'falaai-api'
15
+
16
+ instance = FalaAI::DiagnosticCategoricalAnalysis.new(
17
+ list_choice: Informative,
18
+ justification: Information about required documentation was provided,
19
+ evidence_phrases: [[00:01:36.640 - 00:02:02.659] No, same thing: proof of address...]
20
+ )
21
+ ```
22
+
@@ -0,0 +1,30 @@
1
+ # FalaAI::DiagnosticRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | **String** | Analysis model. Always 'falaai-diagnostic-1' | [optional][default to 'falaai-diagnostic-1'] |
8
+ | **text** | **String** | Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters | [optional][default to ''] |
9
+ | **dialog** | **String** | Diarized transcript with speaker turns. PRIMARY source. At least one of 'dialog' or 'text' required. Speaker labels accepted (any case): 'Speaker N', 'Interlocutor N', 'Hablante N', 'Locutor N', 'Orador N' (space or underscore). Normalized internally to 'Speaker N' in the response. Max 300,000 characters | [optional][default to ''] |
10
+ | **audio_events** | [**Array<DiagnosticAudioEvent>**](DiagnosticAudioEvent.md) | Detected audio events with timestamps (required when using dialog) | [optional] |
11
+ | **language** | **String** | Transcript language. Required. Accepted: en-US, pt-BR, es-ES, es-MX, fr-FR, de-DE, it-IT, pt-PT, zh-CN, ja-JP, ko-KR, ar-SA, hi-IN, ru-RU, id-ID, tr-TR, nl-NL, pl-PL, vi-VN, th-TH, en-GB | |
12
+ | **duration_seconds** | **Float** | Total audio duration in seconds. Required. Max 3h (10800s). | |
13
+ | **client_reference_id** | **String** | Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'falaai-api'
19
+
20
+ instance = FalaAI::DiagnosticRequest.new(
21
+ model: falaai-diagnostic-1,
22
+ text: null,
23
+ dialog: Speaker 1: [00:00:00.540 - 00:00:01.139] Hi, Alex.,
24
+ audio_events: null,
25
+ language: pt-BR,
26
+ duration_seconds: null,
27
+ client_reference_id: call-2026-08-30-001
28
+ )
29
+ ```
30
+