falaai-api 1.21.47 → 1.21.49
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.
- checksums.yaml +4 -4
- data/README.md +202 -168
- data/docs/AnalysisApi.md +33 -37
- data/docs/AudioEvent.md +5 -5
- data/docs/AudioInputMeta.md +5 -5
- data/docs/CreateEmailAlertRequest.md +3 -3
- data/docs/CreateWebhookRequest.md +4 -4
- data/docs/DiagnosticAudioEvent.md +5 -5
- data/docs/DiagnosticCategoricalAnalysis.md +3 -3
- data/docs/DiagnosticParticipant.md +22 -0
- data/docs/DiagnosticRequest.md +10 -4
- data/docs/DiagnosticResponse.md +4 -4
- data/docs/DiagnosticTextAnalysis.md +1 -1
- data/docs/DiagnosticUsage.md +3 -3
- data/docs/EmailAlertsApi.md +18 -18
- data/docs/HealthApi.md +3 -13
- data/docs/HealthResponse.md +6 -6
- data/docs/Participant.md +2 -2
- data/docs/ParticipantDiagnostic.md +5 -5
- data/docs/{AuditoriaRiscoAnalysisV2.md → RiskAuditAnalysisV2.md} +2 -2
- data/docs/{AuditoriaRiscoAppliedActionV2.md → RiskAuditAppliedActionV2.md} +2 -2
- data/docs/{AuditoriaRiscoAudioEventModelV2.md → RiskAuditAudioEventModelV2.md} +2 -2
- data/docs/{AuditoriaRiscoAuditDecisionsV2.md → RiskAuditAuditDecisionsV2.md} +2 -2
- data/docs/{AuditoriaRiscoConversationScoresV2.md → RiskAuditConversationScoresV2.md} +2 -2
- data/docs/{AuditoriaRiscoDetectionItemV2.md → RiskAuditDetectionItemV2.md} +2 -2
- data/docs/RiskAuditDetectionsV2.md +26 -0
- data/docs/{AuditoriaRiscoIndexerV2.md → RiskAuditIndexerV2.md} +2 -2
- data/docs/{AuditoriaRiscoMetaV2.md → RiskAuditMetaV2.md} +4 -4
- data/docs/RiskAuditParticipantV2.md +28 -0
- data/docs/{AuditoriaRiscoParticipantsV2.md → RiskAuditParticipantsV2.md} +3 -3
- data/docs/{AuditoriaRiscoRequest.md → RiskAuditRequest.md} +12 -12
- data/docs/{AuditoriaRiscoScoresV2.md → RiskAuditScoresV2.md} +3 -3
- data/docs/{AuditoriaRiscoScoringExplanationV2.md → RiskAuditScoringExplanationV2.md} +2 -2
- data/docs/{AuditoriaRiscoSummaryV2.md → RiskAuditSummaryV2.md} +2 -2
- data/docs/{AuditoriaRiscoTimelineV2.md → RiskAuditTimelineV2.md} +2 -2
- data/docs/{AuditoriaRiscoUsageV2.md → RiskAuditUsageV2.md} +2 -2
- data/docs/RiskAuditV2.md +46 -0
- data/docs/RiskAuditV2Response.md +18 -0
- data/docs/{AuditoriaRiscoVerdictV2.md → RiskAuditVerdictV2.md} +3 -3
- data/docs/SpeechApi.md +1 -3
- data/docs/TranscriptionResponse.md +13 -14
- data/docs/TranscriptionUsage.md +3 -3
- data/docs/UpdateWebhookRequest.md +5 -5
- data/docs/UsageApi.md +1 -1
- data/docs/VersionApi.md +2 -7
- data/docs/VersionResponse.md +3 -3
- data/docs/WebhooksApi.md +22 -22
- data/docs/index.html +758 -0
- data/lib/falaai-api/api/analysis_api.rb +38 -42
- data/lib/falaai-api/api/email_alerts_api.rb +10 -10
- data/lib/falaai-api/api/health_api.rb +4 -4
- data/lib/falaai-api/api/speech_api.rb +2 -4
- data/lib/falaai-api/api/usage_api.rb +2 -2
- data/lib/falaai-api/api/version_api.rb +3 -3
- data/lib/falaai-api/api/webhooks_api.rb +18 -18
- data/lib/falaai-api/api_client.rb +2 -2
- data/lib/falaai-api/api_error.rb +2 -2
- data/lib/falaai-api/api_model_base.rb +2 -2
- data/lib/falaai-api/configuration.rb +6 -6
- data/lib/falaai-api/models/audio_event.rb +2 -2
- data/lib/falaai-api/models/audio_input_meta.rb +2 -2
- data/lib/falaai-api/models/create_email_alert_request.rb +2 -2
- data/lib/falaai-api/models/create_webhook_request.rb +2 -2
- data/lib/falaai-api/models/diagnostic_analysis_map.rb +2 -2
- data/lib/falaai-api/models/diagnostic_audio_event.rb +2 -2
- data/lib/falaai-api/models/diagnostic_categorical_analysis.rb +2 -2
- data/lib/falaai-api/models/diagnostic_participant.rb +226 -0
- data/lib/falaai-api/models/diagnostic_request.rb +91 -6
- data/lib/falaai-api/models/diagnostic_response.rb +2 -2
- data/lib/falaai-api/models/diagnostic_text_analysis.rb +2 -2
- data/lib/falaai-api/models/diagnostic_usage.rb +2 -2
- data/lib/falaai-api/models/email_alert_item.rb +2 -2
- data/lib/falaai-api/models/email_alert_list_response.rb +2 -2
- data/lib/falaai-api/models/email_alert_message_response.rb +2 -2
- data/lib/falaai-api/models/email_event.rb +2 -2
- data/lib/falaai-api/models/health_response.rb +2 -2
- data/lib/falaai-api/models/http_validation_error.rb +2 -2
- data/lib/falaai-api/models/location_inner.rb +2 -2
- data/lib/falaai-api/models/message_response.rb +2 -2
- data/lib/falaai-api/models/participant.rb +2 -2
- data/lib/falaai-api/models/participant_diagnostic.rb +2 -2
- data/lib/falaai-api/models/{auditoria_risco_analysis_v2.rb → risk_audit_analysis_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_applied_action_v2.rb → risk_audit_applied_action_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_audio_event_model_v2.rb → risk_audit_audio_event_model_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_audit_decisions_v2.rb → risk_audit_audit_decisions_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_conversation_scores_v2.rb → risk_audit_conversation_scores_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_detection_item_v2.rb → risk_audit_detection_item_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_detections_v2.rb → risk_audit_detections_v2.rb} +8 -8
- data/lib/falaai-api/models/{auditoria_risco_indexer_v2.rb → risk_audit_indexer_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_meta_v2.rb → risk_audit_meta_v2.rb} +7 -7
- data/lib/falaai-api/models/{auditoria_risco_participant_v2.rb → risk_audit_participant_v2.rb} +39 -9
- data/lib/falaai-api/models/{auditoria_risco_participants_v2.rb → risk_audit_participants_v2.rb} +6 -6
- data/lib/falaai-api/models/{auditoria_risco_request.rb → risk_audit_request.rb} +8 -8
- data/lib/falaai-api/models/{auditoria_risco_scores_v2.rb → risk_audit_scores_v2.rb} +6 -6
- data/lib/falaai-api/models/{auditoria_risco_scoring_explanation_v2.rb → risk_audit_scoring_explanation_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_summary_v2.rb → risk_audit_summary_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_timeline_v2.rb → risk_audit_timeline_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_usage_v2.rb → risk_audit_usage_v2.rb} +5 -5
- data/lib/falaai-api/models/{auditoria_risco_v2.rb → risk_audit_v2.rb} +35 -35
- data/lib/falaai-api/models/{auditoria_risco_v2_response.rb → risk_audit_v2_response.rb} +7 -7
- data/lib/falaai-api/models/{auditoria_risco_verdict_v2.rb → risk_audit_verdict_v2.rb} +6 -6
- data/lib/falaai-api/models/transcription_response.rb +2 -2
- data/lib/falaai-api/models/transcription_usage.rb +2 -2
- data/lib/falaai-api/models/update_email_alert_request.rb +2 -2
- data/lib/falaai-api/models/update_webhook_request.rb +2 -2
- data/lib/falaai-api/models/usage_by_key_item.rb +2 -2
- data/lib/falaai-api/models/usage_log_item.rb +2 -2
- data/lib/falaai-api/models/usage_log_response.rb +2 -2
- data/lib/falaai-api/models/validation_error.rb +2 -2
- data/lib/falaai-api/models/version_response.rb +2 -2
- data/lib/falaai-api/models/webhook_event.rb +2 -2
- data/lib/falaai-api/models/webhook_item.rb +2 -2
- data/lib/falaai-api/models/webhook_list_response.rb +2 -2
- data/lib/falaai-api/version.rb +3 -3
- data/lib/falaai-api.rb +23 -22
- metadata +47 -44
- data/docs/AuditoriaRiscoDetectionsV2.md +0 -26
- data/docs/AuditoriaRiscoParticipantV2.md +0 -22
- data/docs/AuditoriaRiscoV2.md +0 -46
- data/docs/AuditoriaRiscoV2Response.md +0 -18
|
@@ -15,10 +15,10 @@
|
|
|
15
15
|
require 'falaai-api'
|
|
16
16
|
|
|
17
17
|
instance = FalaAI::CreateWebhookRequest.new(
|
|
18
|
-
name:
|
|
19
|
-
url:
|
|
20
|
-
events:
|
|
21
|
-
retry_enabled:
|
|
18
|
+
name: null,
|
|
19
|
+
url: null,
|
|
20
|
+
events: null,
|
|
21
|
+
retry_enabled: null
|
|
22
22
|
)
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
require 'falaai-api'
|
|
17
17
|
|
|
18
18
|
instance = FalaAI::DiagnosticAudioEvent.new(
|
|
19
|
-
event:
|
|
20
|
-
start_s:
|
|
21
|
-
end_s:
|
|
22
|
-
duration_s:
|
|
23
|
-
formatted_timestamp:
|
|
19
|
+
event: null,
|
|
20
|
+
start_s: null,
|
|
21
|
+
end_s: null,
|
|
22
|
+
duration_s: null,
|
|
23
|
+
formatted_timestamp: null
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
require 'falaai-api'
|
|
15
15
|
|
|
16
16
|
instance = FalaAI::DiagnosticCategoricalAnalysis.new(
|
|
17
|
-
list_choice:
|
|
18
|
-
justification:
|
|
19
|
-
evidence_phrases:
|
|
17
|
+
list_choice: null,
|
|
18
|
+
justification: null,
|
|
19
|
+
evidence_phrases: null
|
|
20
20
|
)
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FalaAI::DiagnosticParticipant
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **interlocutor** | **String** | Exact speaker label from the dialog (e.g. 'Speaker 1') | |
|
|
8
|
+
| **name** | **String** | Participant name (optional) | [optional] |
|
|
9
|
+
| **role** | **String** | agent | client | bot | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'falaai-api'
|
|
15
|
+
|
|
16
|
+
instance = FalaAI::DiagnosticParticipant.new(
|
|
17
|
+
interlocutor: null,
|
|
18
|
+
name: null,
|
|
19
|
+
role: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/DiagnosticRequest.md
CHANGED
|
@@ -9,8 +9,11 @@
|
|
|
9
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
10
|
| **audio_events** | [**Array<DiagnosticAudioEvent>**](DiagnosticAudioEvent.md) | Detected audio events with timestamps (required when using dialog) | [optional] |
|
|
11
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
|
+
| **response_language** | **String** | Language for the analysis results (labels, categories, levels). Can differ from 'language' (input). If omitted, uses 'language'. Accepted: en-US, es-ES, es-MX, pt-BR, 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. | [optional] |
|
|
12
13
|
| **duration_seconds** | **Float** | Total audio duration in seconds. Required. Max 3h (10800s). | |
|
|
13
14
|
| **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] |
|
|
15
|
+
| **call_direction** | **String** | Who originated the call. inbound=client called, outbound=company called. If omitted, the LLM infers from context. | [optional] |
|
|
16
|
+
| **participants** | [**Array<DiagnosticParticipant>**](DiagnosticParticipant.md) | Explicit participant roles. If omitted, the LLM infers from the dialog. When provided, used as ground truth (no inference) and echoed in analysis.participants_identified. | [optional] |
|
|
14
17
|
|
|
15
18
|
## Example
|
|
16
19
|
|
|
@@ -18,13 +21,16 @@
|
|
|
18
21
|
require 'falaai-api'
|
|
19
22
|
|
|
20
23
|
instance = FalaAI::DiagnosticRequest.new(
|
|
21
|
-
model:
|
|
24
|
+
model: null,
|
|
22
25
|
text: null,
|
|
23
|
-
dialog:
|
|
26
|
+
dialog: null,
|
|
24
27
|
audio_events: null,
|
|
25
|
-
language:
|
|
28
|
+
language: null,
|
|
29
|
+
response_language: null,
|
|
26
30
|
duration_seconds: null,
|
|
27
|
-
client_reference_id:
|
|
31
|
+
client_reference_id: null,
|
|
32
|
+
call_direction: null,
|
|
33
|
+
participants: null
|
|
28
34
|
)
|
|
29
35
|
```
|
|
30
36
|
|
data/docs/DiagnosticResponse.md
CHANGED
|
@@ -17,12 +17,12 @@
|
|
|
17
17
|
require 'falaai-api'
|
|
18
18
|
|
|
19
19
|
instance = FalaAI::DiagnosticResponse.new(
|
|
20
|
-
id:
|
|
21
|
-
response_language:
|
|
22
|
-
object:
|
|
20
|
+
id: null,
|
|
21
|
+
response_language: null,
|
|
22
|
+
object: null,
|
|
23
23
|
analysis: null,
|
|
24
24
|
usage: null,
|
|
25
|
-
client_reference_id:
|
|
25
|
+
client_reference_id: null
|
|
26
26
|
)
|
|
27
27
|
```
|
|
28
28
|
|
data/docs/DiagnosticUsage.md
CHANGED
data/docs/EmailAlertsApi.md
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
# FalaAI::EmailAlertsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *https://api01-falaai.action.tec.br*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_email_alert_v1_email_alerts_post**](EmailAlertsApi.md#create_email_alert_v1_email_alerts_post) | **POST** /v1/email-alerts |
|
|
8
|
-
| [**delete_email_alert_v1_email_alerts_alert_id_delete**](EmailAlertsApi.md#delete_email_alert_v1_email_alerts_alert_id_delete) | **DELETE** /v1/email-alerts/{alert_id} |
|
|
9
|
-
| [**list_email_alerts_v1_email_alerts_get**](EmailAlertsApi.md#list_email_alerts_v1_email_alerts_get) | **GET** /v1/email-alerts |
|
|
10
|
-
| [**update_email_alert_v1_email_alerts_alert_id_put**](EmailAlertsApi.md#update_email_alert_v1_email_alerts_alert_id_put) | **PUT** /v1/email-alerts/{alert_id} |
|
|
7
|
+
| [**create_email_alert_v1_email_alerts_post**](EmailAlertsApi.md#create_email_alert_v1_email_alerts_post) | **POST** /v1/email-alerts | Create email alert |
|
|
8
|
+
| [**delete_email_alert_v1_email_alerts_alert_id_delete**](EmailAlertsApi.md#delete_email_alert_v1_email_alerts_alert_id_delete) | **DELETE** /v1/email-alerts/{alert_id} | Delete email alert |
|
|
9
|
+
| [**list_email_alerts_v1_email_alerts_get**](EmailAlertsApi.md#list_email_alerts_v1_email_alerts_get) | **GET** /v1/email-alerts | List email alerts |
|
|
10
|
+
| [**update_email_alert_v1_email_alerts_alert_id_put**](EmailAlertsApi.md#update_email_alert_v1_email_alerts_alert_id_put) | **PUT** /v1/email-alerts/{alert_id} | Update email alert |
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
## create_email_alert_v1_email_alerts_post
|
|
14
14
|
|
|
15
15
|
> <EmailAlertItem> create_email_alert_v1_email_alerts_post(create_email_alert_request)
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Create email alert
|
|
18
18
|
|
|
19
19
|
### Examples
|
|
20
20
|
|
|
@@ -28,10 +28,10 @@ FalaAI.configure do |config|
|
|
|
28
28
|
end
|
|
29
29
|
|
|
30
30
|
api_instance = FalaAI::EmailAlertsApi.new
|
|
31
|
-
create_email_alert_request = FalaAI::CreateEmailAlertRequest.new({name: '
|
|
31
|
+
create_email_alert_request = FalaAI::CreateEmailAlertRequest.new({name: 'name_example', email: 'email_example', events: [FalaAI::EmailEvent::SUBSCRIPTION_CREATED]}) # CreateEmailAlertRequest |
|
|
32
32
|
|
|
33
33
|
begin
|
|
34
|
-
#
|
|
34
|
+
# Create email alert
|
|
35
35
|
result = api_instance.create_email_alert_v1_email_alerts_post(create_email_alert_request)
|
|
36
36
|
p result
|
|
37
37
|
rescue FalaAI::ApiError => e
|
|
@@ -47,7 +47,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
47
47
|
|
|
48
48
|
```ruby
|
|
49
49
|
begin
|
|
50
|
-
#
|
|
50
|
+
# Create email alert
|
|
51
51
|
data, status_code, headers = api_instance.create_email_alert_v1_email_alerts_post_with_http_info(create_email_alert_request)
|
|
52
52
|
p status_code # => 2xx
|
|
53
53
|
p headers # => { ... }
|
|
@@ -81,7 +81,7 @@ end
|
|
|
81
81
|
|
|
82
82
|
> <EmailAlertMessageResponse> delete_email_alert_v1_email_alerts_alert_id_delete(alert_id)
|
|
83
83
|
|
|
84
|
-
|
|
84
|
+
Delete email alert
|
|
85
85
|
|
|
86
86
|
### Examples
|
|
87
87
|
|
|
@@ -98,7 +98,7 @@ api_instance = FalaAI::EmailAlertsApi.new
|
|
|
98
98
|
alert_id = 'alert_id_example' # String |
|
|
99
99
|
|
|
100
100
|
begin
|
|
101
|
-
#
|
|
101
|
+
# Delete email alert
|
|
102
102
|
result = api_instance.delete_email_alert_v1_email_alerts_alert_id_delete(alert_id)
|
|
103
103
|
p result
|
|
104
104
|
rescue FalaAI::ApiError => e
|
|
@@ -114,7 +114,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
114
114
|
|
|
115
115
|
```ruby
|
|
116
116
|
begin
|
|
117
|
-
#
|
|
117
|
+
# Delete email alert
|
|
118
118
|
data, status_code, headers = api_instance.delete_email_alert_v1_email_alerts_alert_id_delete_with_http_info(alert_id)
|
|
119
119
|
p status_code # => 2xx
|
|
120
120
|
p headers # => { ... }
|
|
@@ -148,7 +148,7 @@ end
|
|
|
148
148
|
|
|
149
149
|
> <EmailAlertListResponse> list_email_alerts_v1_email_alerts_get(opts)
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
List email alerts
|
|
152
152
|
|
|
153
153
|
### Examples
|
|
154
154
|
|
|
@@ -168,7 +168,7 @@ opts = {
|
|
|
168
168
|
}
|
|
169
169
|
|
|
170
170
|
begin
|
|
171
|
-
#
|
|
171
|
+
# List email alerts
|
|
172
172
|
result = api_instance.list_email_alerts_v1_email_alerts_get(opts)
|
|
173
173
|
p result
|
|
174
174
|
rescue FalaAI::ApiError => e
|
|
@@ -184,7 +184,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
184
184
|
|
|
185
185
|
```ruby
|
|
186
186
|
begin
|
|
187
|
-
#
|
|
187
|
+
# List email alerts
|
|
188
188
|
data, status_code, headers = api_instance.list_email_alerts_v1_email_alerts_get_with_http_info(opts)
|
|
189
189
|
p status_code # => 2xx
|
|
190
190
|
p headers # => { ... }
|
|
@@ -219,7 +219,7 @@ end
|
|
|
219
219
|
|
|
220
220
|
> <EmailAlertMessageResponse> update_email_alert_v1_email_alerts_alert_id_put(alert_id, update_email_alert_request)
|
|
221
221
|
|
|
222
|
-
|
|
222
|
+
Update email alert
|
|
223
223
|
|
|
224
224
|
### Examples
|
|
225
225
|
|
|
@@ -237,7 +237,7 @@ alert_id = 'alert_id_example' # String |
|
|
|
237
237
|
update_email_alert_request = FalaAI::UpdateEmailAlertRequest.new # UpdateEmailAlertRequest |
|
|
238
238
|
|
|
239
239
|
begin
|
|
240
|
-
#
|
|
240
|
+
# Update email alert
|
|
241
241
|
result = api_instance.update_email_alert_v1_email_alerts_alert_id_put(alert_id, update_email_alert_request)
|
|
242
242
|
p result
|
|
243
243
|
rescue FalaAI::ApiError => e
|
|
@@ -253,7 +253,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
253
253
|
|
|
254
254
|
```ruby
|
|
255
255
|
begin
|
|
256
|
-
#
|
|
256
|
+
# Update email alert
|
|
257
257
|
data, status_code, headers = api_instance.update_email_alert_v1_email_alerts_alert_id_put_with_http_info(alert_id, update_email_alert_request)
|
|
258
258
|
p status_code # => 2xx
|
|
259
259
|
p headers # => { ... }
|
data/docs/HealthApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# FalaAI::HealthApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *https://api01-falaai.action.tec.br*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
@@ -19,11 +19,6 @@ Health Check
|
|
|
19
19
|
```ruby
|
|
20
20
|
require 'time'
|
|
21
21
|
require 'falaai-api'
|
|
22
|
-
# setup authorization
|
|
23
|
-
FalaAI.configure do |config|
|
|
24
|
-
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
25
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
26
|
-
end
|
|
27
22
|
|
|
28
23
|
api_instance = FalaAI::HealthApi.new
|
|
29
24
|
|
|
@@ -64,7 +59,7 @@ This endpoint does not need any parameter.
|
|
|
64
59
|
|
|
65
60
|
### Authorization
|
|
66
61
|
|
|
67
|
-
|
|
62
|
+
No authorization required
|
|
68
63
|
|
|
69
64
|
### HTTP request headers
|
|
70
65
|
|
|
@@ -83,11 +78,6 @@ Health Check
|
|
|
83
78
|
```ruby
|
|
84
79
|
require 'time'
|
|
85
80
|
require 'falaai-api'
|
|
86
|
-
# setup authorization
|
|
87
|
-
FalaAI.configure do |config|
|
|
88
|
-
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
89
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
90
|
-
end
|
|
91
81
|
|
|
92
82
|
api_instance = FalaAI::HealthApi.new
|
|
93
83
|
|
|
@@ -128,7 +118,7 @@ This endpoint does not need any parameter.
|
|
|
128
118
|
|
|
129
119
|
### Authorization
|
|
130
120
|
|
|
131
|
-
|
|
121
|
+
No authorization required
|
|
132
122
|
|
|
133
123
|
### HTTP request headers
|
|
134
124
|
|
data/docs/HealthResponse.md
CHANGED
|
@@ -17,12 +17,12 @@
|
|
|
17
17
|
require 'falaai-api'
|
|
18
18
|
|
|
19
19
|
instance = FalaAI::HealthResponse.new(
|
|
20
|
-
status:
|
|
21
|
-
version:
|
|
22
|
-
uptime_seconds:
|
|
23
|
-
database:
|
|
24
|
-
phase:
|
|
25
|
-
launch_date:
|
|
20
|
+
status: null,
|
|
21
|
+
version: null,
|
|
22
|
+
uptime_seconds: null,
|
|
23
|
+
database: null,
|
|
24
|
+
phase: null,
|
|
25
|
+
launch_date: null
|
|
26
26
|
)
|
|
27
27
|
```
|
|
28
28
|
|
data/docs/Participant.md
CHANGED
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
require 'falaai-api'
|
|
17
17
|
|
|
18
18
|
instance = FalaAI::ParticipantDiagnostic.new(
|
|
19
|
-
interlocutor:
|
|
20
|
-
role:
|
|
21
|
-
name:
|
|
22
|
-
confidence:
|
|
23
|
-
evidence:
|
|
19
|
+
interlocutor: null,
|
|
20
|
+
role: null,
|
|
21
|
+
name: null,
|
|
22
|
+
confidence: null,
|
|
23
|
+
evidence: null
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditAnalysisV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'falaai-api'
|
|
15
15
|
|
|
16
|
-
instance = FalaAI::
|
|
16
|
+
instance = FalaAI::RiskAuditAnalysisV2.new(
|
|
17
17
|
global_metrics: null,
|
|
18
18
|
final_analysis: null,
|
|
19
19
|
frameworks: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditAppliedActionV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'falaai-api'
|
|
20
20
|
|
|
21
|
-
instance = FalaAI::
|
|
21
|
+
instance = FalaAI::RiskAuditAppliedActionV2.new(
|
|
22
22
|
action_type: null,
|
|
23
23
|
label: null,
|
|
24
24
|
description: null,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditAudioEventModelV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'falaai-api'
|
|
15
15
|
|
|
16
|
-
instance = FalaAI::
|
|
16
|
+
instance = FalaAI::RiskAuditAudioEventModelV2.new(
|
|
17
17
|
model: null,
|
|
18
18
|
description: null,
|
|
19
19
|
windows_s: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditAuditDecisionsV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'falaai-api'
|
|
15
15
|
|
|
16
|
-
instance = FalaAI::
|
|
16
|
+
instance = FalaAI::RiskAuditAuditDecisionsV2.new(
|
|
17
17
|
risk_origin: null,
|
|
18
18
|
has_zero_tolerance_violation: null,
|
|
19
19
|
deterministic_validator_changes: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditConversationScoresV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'falaai-api'
|
|
23
23
|
|
|
24
|
-
instance = FalaAI::
|
|
24
|
+
instance = FalaAI::RiskAuditConversationScoresV2.new(
|
|
25
25
|
consolidated_score: null,
|
|
26
26
|
violation_density_per_min: null,
|
|
27
27
|
sentiment_trend: null,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditDetectionItemV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
```ruby
|
|
58
58
|
require 'falaai-api'
|
|
59
59
|
|
|
60
|
-
instance = FalaAI::
|
|
60
|
+
instance = FalaAI::RiskAuditDetectionItemV2.new(
|
|
61
61
|
turn: null,
|
|
62
62
|
interlocutor: null,
|
|
63
63
|
role: null,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# FalaAI::RiskAuditDetectionsV2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **violations** | [**Array<RiskAuditDetectionItemV2>**](RiskAuditDetectionItemV2.md) | Active violations | [optional] |
|
|
8
|
+
| **positives** | [**Array<RiskAuditDetectionItemV2>**](RiskAuditDetectionItemV2.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<RiskAuditDetectionItemV2>**](RiskAuditDetectionItemV2.md) | Client negatives | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'falaai-api'
|
|
17
|
+
|
|
18
|
+
instance = FalaAI::RiskAuditDetectionsV2.new(
|
|
19
|
+
violations: null,
|
|
20
|
+
positives: null,
|
|
21
|
+
client_risk_alerts: null,
|
|
22
|
+
client_behavior_alerts: null,
|
|
23
|
+
client_negatives: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditIndexerV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'falaai-api'
|
|
13
13
|
|
|
14
|
-
instance = FalaAI::
|
|
14
|
+
instance = FalaAI::RiskAuditIndexerV2.new(
|
|
15
15
|
suggested_terms_for_bank: null
|
|
16
16
|
)
|
|
17
17
|
```
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditMetaV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Analysis id | |
|
|
8
|
-
| **object** | **String** | Object type | [optional][default to '
|
|
8
|
+
| **object** | **String** | Object type | [optional][default to 'risk_audit'] |
|
|
9
9
|
| **call_duration_s** | **Float** | Call duration (s) | [optional] |
|
|
10
10
|
| **analyzed_at** | **String** | ISO 8601 analyzed timestamp | [optional] |
|
|
11
|
-
| **usage** | [**
|
|
11
|
+
| **usage** | [**RiskAuditUsageV2**](RiskAuditUsageV2.md) | Usage block | |
|
|
12
12
|
| **client_reference_id** | **String** | Echoed client reference id | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
```ruby
|
|
17
17
|
require 'falaai-api'
|
|
18
18
|
|
|
19
|
-
instance = FalaAI::
|
|
19
|
+
instance = FalaAI::RiskAuditMetaV2.new(
|
|
20
20
|
id: null,
|
|
21
21
|
object: null,
|
|
22
22
|
call_duration_s: null,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# FalaAI::RiskAuditParticipantV2
|
|
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
|
+
| **confidence** | **String** | Role inference confidence (high/medium/low) | [optional] |
|
|
11
|
+
| **source** | **String** | Role source (input/inferred) | [optional] |
|
|
12
|
+
| **evidence** | **String** | Role inference evidence | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'falaai-api'
|
|
18
|
+
|
|
19
|
+
instance = FalaAI::RiskAuditParticipantV2.new(
|
|
20
|
+
interlocutor: null,
|
|
21
|
+
name: null,
|
|
22
|
+
role: null,
|
|
23
|
+
confidence: null,
|
|
24
|
+
source: null,
|
|
25
|
+
evidence: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditParticipantsV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **identified** | [**Array<
|
|
7
|
+
| **identified** | [**Array<RiskAuditParticipantV2>**](RiskAuditParticipantV2.md) | Identified participants | [optional] |
|
|
8
8
|
| **call_direction** | **String** | inbound/outbound | [optional] |
|
|
9
9
|
| **role_inference_reliable** | **Boolean** | Role inference reliability | [optional][default to true] |
|
|
10
10
|
| **identification_status** | **String** | Identification status | [optional][default to 'none'] |
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'falaai-api'
|
|
17
17
|
|
|
18
|
-
instance = FalaAI::
|
|
18
|
+
instance = FalaAI::RiskAuditParticipantsV2.new(
|
|
19
19
|
identified: null,
|
|
20
20
|
call_direction: null,
|
|
21
21
|
role_inference_reliable: null,
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **model** | **String** | Analysis model. Always 'falaai-
|
|
7
|
+
| **model** | **String** | Analysis model. Always 'falaai-risk-audit-1' | [optional][default to 'falaai-risk-audit-1'] |
|
|
8
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
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
10
|
| **audio_events** | [**Array<DiagnosticAudioEvent>**](DiagnosticAudioEvent.md) | Audio events with timestamps (correlated with turns when diarization is present) | [optional] |
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **language** | **String** | Language of the transcript being analyzed. Must match the dialog/text language. Accepted: pt-BR, en-US, es-ES. | |
|
|
13
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
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
|
|
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
16
|
| **response_format** | **String** | Response format version. v1=legacy flat PT-BR, v2=structured EN-US blocks. | [optional][default to 'v2'] |
|
|
17
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
18
|
|
|
@@ -21,18 +21,18 @@
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'falaai-api'
|
|
23
23
|
|
|
24
|
-
instance = FalaAI::
|
|
25
|
-
model:
|
|
24
|
+
instance = FalaAI::RiskAuditRequest.new(
|
|
25
|
+
model: null,
|
|
26
26
|
text: null,
|
|
27
|
-
dialog:
|
|
27
|
+
dialog: null,
|
|
28
28
|
audio_events: null,
|
|
29
29
|
duration_seconds: null,
|
|
30
|
-
language:
|
|
31
|
-
response_language:
|
|
32
|
-
call_direction:
|
|
33
|
-
participants:
|
|
34
|
-
response_format:
|
|
35
|
-
client_reference_id:
|
|
30
|
+
language: null,
|
|
31
|
+
response_language: null,
|
|
32
|
+
call_direction: null,
|
|
33
|
+
participants: null,
|
|
34
|
+
response_format: null,
|
|
35
|
+
client_reference_id: null
|
|
36
36
|
)
|
|
37
37
|
```
|
|
38
38
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditScoresV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **conversation** | [**
|
|
7
|
+
| **conversation** | [**RiskAuditConversationScoresV2**](RiskAuditConversationScoresV2.md) | Conversation scores | |
|
|
8
8
|
| **per_participant** | **Hash<String, Object>** | Per-participant KPIs | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'falaai-api'
|
|
14
14
|
|
|
15
|
-
instance = FalaAI::
|
|
15
|
+
instance = FalaAI::RiskAuditScoresV2.new(
|
|
16
16
|
conversation: null,
|
|
17
17
|
per_participant: null
|
|
18
18
|
)
|