falaai-api 1.21.48 → 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 +239 -339
- 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/{AuditoriaRiscoParticipantV2.md → RiskAuditParticipantV2.md} +2 -2
- 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} +5 -5
- 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 +45 -42
- data/docs/AuditoriaRiscoDetectionsV2.md +0 -26
- data/docs/AuditoriaRiscoV2.md +0 -46
- data/docs/AuditoriaRiscoV2Response.md +0 -18
data/docs/AnalysisApi.md
CHANGED
|
@@ -1,20 +1,18 @@
|
|
|
1
1
|
# FalaAI::AnalysisApi
|
|
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
|
-
| [**
|
|
8
|
-
| [**
|
|
7
|
+
| [**create_diagnostic_v1_analyze_diagnostic_post**](AnalysisApi.md#create_diagnostic_v1_analyze_diagnostic_post) | **POST** /v1/analyze/diagnostic | Analyze a call transcript — 5 parallel analyses |
|
|
8
|
+
| [**create_risk_audit_v1_analyze_risk_audit_post**](AnalysisApi.md#create_risk_audit_v1_analyze_risk_audit_post) | **POST** /v1/analyze/riskAudit | Compliance Risk Audit — conversation compliance analysis |
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
##
|
|
12
|
-
|
|
13
|
-
> <AuditoriaRiscoV2Response> create_auditoria_risco_v1_analyze_auditoria_risco_post(auditoria_risco_request)
|
|
11
|
+
## create_diagnostic_v1_analyze_diagnostic_post
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
> <DiagnosticResponse> create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
Analyze a call transcript — 5 parallel analyses
|
|
18
16
|
|
|
19
17
|
### Examples
|
|
20
18
|
|
|
@@ -28,32 +26,32 @@ FalaAI.configure do |config|
|
|
|
28
26
|
end
|
|
29
27
|
|
|
30
28
|
api_instance = FalaAI::AnalysisApi.new
|
|
31
|
-
|
|
29
|
+
diagnostic_request = FalaAI::DiagnosticRequest.new({language: 'language_example', duration_seconds: 3.56}) # DiagnosticRequest |
|
|
32
30
|
|
|
33
31
|
begin
|
|
34
|
-
#
|
|
35
|
-
result = api_instance.
|
|
32
|
+
# Analyze a call transcript — 5 parallel analyses
|
|
33
|
+
result = api_instance.create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
|
|
36
34
|
p result
|
|
37
35
|
rescue FalaAI::ApiError => e
|
|
38
|
-
puts "Error when calling AnalysisApi->
|
|
36
|
+
puts "Error when calling AnalysisApi->create_diagnostic_v1_analyze_diagnostic_post: #{e}"
|
|
39
37
|
end
|
|
40
38
|
```
|
|
41
39
|
|
|
42
|
-
#### Using the
|
|
40
|
+
#### Using the create_diagnostic_v1_analyze_diagnostic_post_with_http_info variant
|
|
43
41
|
|
|
44
42
|
This returns an Array which contains the response data, status code and headers.
|
|
45
43
|
|
|
46
|
-
> <Array(<
|
|
44
|
+
> <Array(<DiagnosticResponse>, Integer, Hash)> create_diagnostic_v1_analyze_diagnostic_post_with_http_info(diagnostic_request)
|
|
47
45
|
|
|
48
46
|
```ruby
|
|
49
47
|
begin
|
|
50
|
-
#
|
|
51
|
-
data, status_code, headers = api_instance.
|
|
48
|
+
# Analyze a call transcript — 5 parallel analyses
|
|
49
|
+
data, status_code, headers = api_instance.create_diagnostic_v1_analyze_diagnostic_post_with_http_info(diagnostic_request)
|
|
52
50
|
p status_code # => 2xx
|
|
53
51
|
p headers # => { ... }
|
|
54
|
-
p data # => <
|
|
52
|
+
p data # => <DiagnosticResponse>
|
|
55
53
|
rescue FalaAI::ApiError => e
|
|
56
|
-
puts "Error when calling AnalysisApi->
|
|
54
|
+
puts "Error when calling AnalysisApi->create_diagnostic_v1_analyze_diagnostic_post_with_http_info: #{e}"
|
|
57
55
|
end
|
|
58
56
|
```
|
|
59
57
|
|
|
@@ -61,11 +59,11 @@ end
|
|
|
61
59
|
|
|
62
60
|
| Name | Type | Description | Notes |
|
|
63
61
|
| ---- | ---- | ----------- | ----- |
|
|
64
|
-
| **
|
|
62
|
+
| **diagnostic_request** | [**DiagnosticRequest**](DiagnosticRequest.md) | | |
|
|
65
63
|
|
|
66
64
|
### Return type
|
|
67
65
|
|
|
68
|
-
[**
|
|
66
|
+
[**DiagnosticResponse**](DiagnosticResponse.md)
|
|
69
67
|
|
|
70
68
|
### Authorization
|
|
71
69
|
|
|
@@ -77,13 +75,11 @@ end
|
|
|
77
75
|
- **Accept**: application/json
|
|
78
76
|
|
|
79
77
|
|
|
80
|
-
##
|
|
81
|
-
|
|
82
|
-
> <DiagnosticResponse> create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
|
|
78
|
+
## create_risk_audit_v1_analyze_risk_audit_post
|
|
83
79
|
|
|
84
|
-
|
|
80
|
+
> <RiskAuditV2Response> create_risk_audit_v1_analyze_risk_audit_post(risk_audit_request)
|
|
85
81
|
|
|
86
|
-
|
|
82
|
+
Compliance Risk Audit — conversation compliance analysis
|
|
87
83
|
|
|
88
84
|
### Examples
|
|
89
85
|
|
|
@@ -97,32 +93,32 @@ FalaAI.configure do |config|
|
|
|
97
93
|
end
|
|
98
94
|
|
|
99
95
|
api_instance = FalaAI::AnalysisApi.new
|
|
100
|
-
|
|
96
|
+
risk_audit_request = FalaAI::RiskAuditRequest.new({duration_seconds: 3.56, language: 'language_example', response_language: 'response_language_example'}) # RiskAuditRequest |
|
|
101
97
|
|
|
102
98
|
begin
|
|
103
|
-
#
|
|
104
|
-
result = api_instance.
|
|
99
|
+
# Compliance Risk Audit — conversation compliance analysis
|
|
100
|
+
result = api_instance.create_risk_audit_v1_analyze_risk_audit_post(risk_audit_request)
|
|
105
101
|
p result
|
|
106
102
|
rescue FalaAI::ApiError => e
|
|
107
|
-
puts "Error when calling AnalysisApi->
|
|
103
|
+
puts "Error when calling AnalysisApi->create_risk_audit_v1_analyze_risk_audit_post: #{e}"
|
|
108
104
|
end
|
|
109
105
|
```
|
|
110
106
|
|
|
111
|
-
#### Using the
|
|
107
|
+
#### Using the create_risk_audit_v1_analyze_risk_audit_post_with_http_info variant
|
|
112
108
|
|
|
113
109
|
This returns an Array which contains the response data, status code and headers.
|
|
114
110
|
|
|
115
|
-
> <Array(<
|
|
111
|
+
> <Array(<RiskAuditV2Response>, Integer, Hash)> create_risk_audit_v1_analyze_risk_audit_post_with_http_info(risk_audit_request)
|
|
116
112
|
|
|
117
113
|
```ruby
|
|
118
114
|
begin
|
|
119
|
-
#
|
|
120
|
-
data, status_code, headers = api_instance.
|
|
115
|
+
# Compliance Risk Audit — conversation compliance analysis
|
|
116
|
+
data, status_code, headers = api_instance.create_risk_audit_v1_analyze_risk_audit_post_with_http_info(risk_audit_request)
|
|
121
117
|
p status_code # => 2xx
|
|
122
118
|
p headers # => { ... }
|
|
123
|
-
p data # => <
|
|
119
|
+
p data # => <RiskAuditV2Response>
|
|
124
120
|
rescue FalaAI::ApiError => e
|
|
125
|
-
puts "Error when calling AnalysisApi->
|
|
121
|
+
puts "Error when calling AnalysisApi->create_risk_audit_v1_analyze_risk_audit_post_with_http_info: #{e}"
|
|
126
122
|
end
|
|
127
123
|
```
|
|
128
124
|
|
|
@@ -130,11 +126,11 @@ end
|
|
|
130
126
|
|
|
131
127
|
| Name | Type | Description | Notes |
|
|
132
128
|
| ---- | ---- | ----------- | ----- |
|
|
133
|
-
| **
|
|
129
|
+
| **risk_audit_request** | [**RiskAuditRequest**](RiskAuditRequest.md) | | |
|
|
134
130
|
|
|
135
131
|
### Return type
|
|
136
132
|
|
|
137
|
-
[**
|
|
133
|
+
[**RiskAuditV2Response**](RiskAuditV2Response.md)
|
|
138
134
|
|
|
139
135
|
### Authorization
|
|
140
136
|
|
data/docs/AudioEvent.md
CHANGED
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
require 'falaai-api'
|
|
17
17
|
|
|
18
18
|
instance = FalaAI::AudioEvent.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
|
|
data/docs/AudioInputMeta.md
CHANGED
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
require 'falaai-api'
|
|
17
17
|
|
|
18
18
|
instance = FalaAI::AudioInputMeta.new(
|
|
19
|
-
duration_s:
|
|
20
|
-
original_format:
|
|
21
|
-
codec:
|
|
22
|
-
sample_rate:
|
|
23
|
-
channels:
|
|
19
|
+
duration_s: null,
|
|
20
|
+
original_format: null,
|
|
21
|
+
codec: null,
|
|
22
|
+
sample_rate: null,
|
|
23
|
+
channels: null
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -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
|