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
|
@@ -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,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditParticipantV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
```ruby
|
|
17
17
|
require 'falaai-api'
|
|
18
18
|
|
|
19
|
-
instance = FalaAI::
|
|
19
|
+
instance = FalaAI::RiskAuditParticipantV2.new(
|
|
20
20
|
interlocutor: null,
|
|
21
21
|
name: null,
|
|
22
22
|
role: null,
|
|
@@ -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
|
)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditScoringExplanationV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'falaai-api'
|
|
14
14
|
|
|
15
|
-
instance = FalaAI::
|
|
15
|
+
instance = FalaAI::RiskAuditScoringExplanationV2.new(
|
|
16
16
|
summary: null,
|
|
17
17
|
steps: null
|
|
18
18
|
)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditSummaryV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
```ruby
|
|
27
27
|
require 'falaai-api'
|
|
28
28
|
|
|
29
|
-
instance = FalaAI::
|
|
29
|
+
instance = FalaAI::RiskAuditSummaryV2.new(
|
|
30
30
|
total_turns: null,
|
|
31
31
|
total_calibrated: null,
|
|
32
32
|
active: null,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditTimelineV2
|
|
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::RiskAuditTimelineV2.new(
|
|
17
17
|
turns_sentiment: null,
|
|
18
18
|
audio_events: null,
|
|
19
19
|
audio_groups_found: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditUsageV2
|
|
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::RiskAuditUsageV2.new(
|
|
17
17
|
characters: null,
|
|
18
18
|
credits_consumed: null,
|
|
19
19
|
processing_ms: null
|
data/docs/RiskAuditV2.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# FalaAI::RiskAuditV2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta** | [**RiskAuditMetaV2**](RiskAuditMetaV2.md) | Identification + usage | |
|
|
8
|
+
| **participants** | [**RiskAuditParticipantsV2**](RiskAuditParticipantsV2.md) | Participants/roles/direction | |
|
|
9
|
+
| **verdict** | [**RiskAuditVerdictV2**](RiskAuditVerdictV2.md) | Verdict + level + applied actions | |
|
|
10
|
+
| **scores** | [**RiskAuditScoresV2**](RiskAuditScoresV2.md) | Consolidated + per-participant scores | |
|
|
11
|
+
| **detections** | [**RiskAuditDetectionsV2**](RiskAuditDetectionsV2.md) | violations/positives/client alerts | |
|
|
12
|
+
| **analysis** | [**RiskAuditAnalysisV2**](RiskAuditAnalysisV2.md) | global_metrics + final_analysis + frameworks | |
|
|
13
|
+
| **timeline** | [**RiskAuditTimelineV2**](RiskAuditTimelineV2.md) | turns_sentiment + audio_events + groups | |
|
|
14
|
+
| **audio_event_model** | [**RiskAuditAudioEventModelV2**](RiskAuditAudioEventModelV2.md) | MAC audio event semantics | |
|
|
15
|
+
| **categories_summary** | **Hash<String, Object>** | Per-category summary (keyed by category) | |
|
|
16
|
+
| **indexer** | [**RiskAuditIndexerV2**](RiskAuditIndexerV2.md) | Suggested terms for bank | |
|
|
17
|
+
| **summary** | [**RiskAuditSummaryV2**](RiskAuditSummaryV2.md) | Executive summary counts | |
|
|
18
|
+
| **actions_i18n** | **Hash<String, Object>** | Used actions i18n catalog (keyed by action) | |
|
|
19
|
+
| **audit_decisions** | [**RiskAuditAuditDecisionsV2**](RiskAuditAuditDecisionsV2.md) | Risk origin + validator changes | |
|
|
20
|
+
| **scoring_explanation** | [**RiskAuditScoringExplanationV2**](RiskAuditScoringExplanationV2.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::RiskAuditV2.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
|
+
actions_i18n: null,
|
|
41
|
+
audit_decisions: null,
|
|
42
|
+
scoring_explanation: null,
|
|
43
|
+
html_report: null
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FalaAI::RiskAuditV2Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **response** | [**RiskAuditV2**](RiskAuditV2.md) | Public response V2 — always returned | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'falaai-api'
|
|
13
|
+
|
|
14
|
+
instance = FalaAI::RiskAuditV2Response.new(
|
|
15
|
+
response: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# FalaAI::
|
|
1
|
+
# FalaAI::RiskAuditVerdictV2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **color** | **String** | Level color | [optional] |
|
|
10
10
|
| **icon** | **String** | Level icon | [optional] |
|
|
11
11
|
| **risk_matrix** | **Hash<String, Object>** | Risk matrix | [optional] |
|
|
12
|
-
| **applied_actions** | [**Array<
|
|
12
|
+
| **applied_actions** | [**Array<RiskAuditAppliedActionV2>**](RiskAuditAppliedActionV2.md) | Applied actions | [optional] |
|
|
13
13
|
| **decision_details** | **Object** | Decision details | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
```ruby
|
|
18
18
|
require 'falaai-api'
|
|
19
19
|
|
|
20
|
-
instance = FalaAI::
|
|
20
|
+
instance = FalaAI::RiskAuditVerdictV2.new(
|
|
21
21
|
label: null,
|
|
22
22
|
level_code: null,
|
|
23
23
|
color: null,
|
data/docs/SpeechApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# FalaAI::SpeechApi
|
|
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
|
| ------ | ------------ | ----------- |
|
|
@@ -13,8 +13,6 @@ All URIs are relative to *http://localhost*
|
|
|
13
13
|
|
|
14
14
|
Transcribe audio to text
|
|
15
15
|
|
|
16
|
-
Upload an audio file and receive transcription with speaker diarization, audio events, and dialog. **Supported formats:** .mp3, .mp4, .m4a, .wav, .flac, .ogg, .webm, .aac, .opus **Limits:** - Maximum audio duration: 3 hours - Maximum file size: 1GB - Cost: 1 credit per second of audio (rounded up), minimum 1 credit **Supported languages:** pt, en, es, fr, de, it, ja, ko, nl, pl, ru, tr, zh, vi, id, th, ar, hi, cs, da, el, fi, he, hu, ms, no, ro, sk, sv, ta, uk **Python:** ```python import httpx response = httpx.post( 'https://api01-falaai.action.tec.br/v1/audio/transcriptions', headers={'Authorization': 'Bearer fai_xxx'}, files={'file': open('call.mp3', 'rb')}, data={'model': 'falaai-transcribe-1', 'language': 'pt'} ) print(response.json()) ``` **cURL:** ```bash curl https://api01-falaai.action.tec.br/v1/audio/transcriptions \\ -H 'Authorization: Bearer fai_xxx' \\ -F 'file=@call.mp3' \\ -F 'model=falaai-transcribe-1' \\ -F 'language=pt' ```
|
|
17
|
-
|
|
18
16
|
### Examples
|
|
19
17
|
|
|
20
18
|
```ruby
|
|
@@ -27,23 +27,22 @@
|
|
|
27
27
|
require 'falaai-api'
|
|
28
28
|
|
|
29
29
|
instance = FalaAI::TranscriptionResponse.new(
|
|
30
|
-
id:
|
|
31
|
-
object:
|
|
32
|
-
model:
|
|
33
|
-
filename:
|
|
34
|
-
processed_at:
|
|
30
|
+
id: null,
|
|
31
|
+
object: null,
|
|
32
|
+
model: null,
|
|
33
|
+
filename: null,
|
|
34
|
+
processed_at: null,
|
|
35
35
|
usage: null,
|
|
36
|
-
language:
|
|
37
|
-
language_confidence:
|
|
38
|
-
duration_seconds:
|
|
39
|
-
text:
|
|
40
|
-
dialog:
|
|
41
|
-
Speaker 2: [00:00:01.940 - 00:00:02.720] Oi...,
|
|
36
|
+
language: null,
|
|
37
|
+
language_confidence: null,
|
|
38
|
+
duration_seconds: null,
|
|
39
|
+
text: null,
|
|
40
|
+
dialog: null,
|
|
42
41
|
audio_events: null,
|
|
43
|
-
event_types:
|
|
44
|
-
word_count:
|
|
42
|
+
event_types: null,
|
|
43
|
+
word_count: null,
|
|
45
44
|
input: null,
|
|
46
|
-
client_reference_id:
|
|
45
|
+
client_reference_id: null
|
|
47
46
|
)
|
|
48
47
|
```
|
|
49
48
|
|
data/docs/TranscriptionUsage.md
CHANGED
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
require 'falaai-api'
|
|
17
17
|
|
|
18
18
|
instance = FalaAI::UpdateWebhookRequest.new(
|
|
19
|
-
name:
|
|
20
|
-
url:
|
|
21
|
-
events:
|
|
22
|
-
retry_enabled:
|
|
23
|
-
active:
|
|
19
|
+
name: null,
|
|
20
|
+
url: null,
|
|
21
|
+
events: null,
|
|
22
|
+
retry_enabled: null,
|
|
23
|
+
active: null
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
26
|
|
data/docs/UsageApi.md
CHANGED
data/docs/VersionApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# FalaAI::VersionApi
|
|
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
|
| ------ | ------------ | ----------- |
|
|
@@ -18,11 +18,6 @@ Get Version
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'time'
|
|
20
20
|
require 'falaai-api'
|
|
21
|
-
# setup authorization
|
|
22
|
-
FalaAI.configure do |config|
|
|
23
|
-
# Configure Bearer authorization (fai_xxx): ApiKeyAuth
|
|
24
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
25
|
-
end
|
|
26
21
|
|
|
27
22
|
api_instance = FalaAI::VersionApi.new
|
|
28
23
|
|
|
@@ -63,7 +58,7 @@ This endpoint does not need any parameter.
|
|
|
63
58
|
|
|
64
59
|
### Authorization
|
|
65
60
|
|
|
66
|
-
|
|
61
|
+
No authorization required
|
|
67
62
|
|
|
68
63
|
### HTTP request headers
|
|
69
64
|
|
data/docs/VersionResponse.md
CHANGED
data/docs/WebhooksApi.md
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
# FalaAI::WebhooksApi
|
|
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_webhook_v1_webhooks_post**](WebhooksApi.md#create_webhook_v1_webhooks_post) | **POST** /v1/webhooks |
|
|
8
|
-
| [**delete_webhook_v1_webhooks_webhook_id_delete**](WebhooksApi.md#delete_webhook_v1_webhooks_webhook_id_delete) | **DELETE** /v1/webhooks/{webhook_id} |
|
|
9
|
-
| [**list_webhooks_v1_webhooks_get**](WebhooksApi.md#list_webhooks_v1_webhooks_get) | **GET** /v1/webhooks |
|
|
10
|
-
| [**update_webhook_v1_webhooks_webhook_id_put**](WebhooksApi.md#update_webhook_v1_webhooks_webhook_id_put) | **PUT** /v1/webhooks/{webhook_id} |
|
|
7
|
+
| [**create_webhook_v1_webhooks_post**](WebhooksApi.md#create_webhook_v1_webhooks_post) | **POST** /v1/webhooks | Create webhook |
|
|
8
|
+
| [**delete_webhook_v1_webhooks_webhook_id_delete**](WebhooksApi.md#delete_webhook_v1_webhooks_webhook_id_delete) | **DELETE** /v1/webhooks/{webhook_id} | Delete webhook |
|
|
9
|
+
| [**list_webhooks_v1_webhooks_get**](WebhooksApi.md#list_webhooks_v1_webhooks_get) | **GET** /v1/webhooks | List webhooks |
|
|
10
|
+
| [**update_webhook_v1_webhooks_webhook_id_put**](WebhooksApi.md#update_webhook_v1_webhooks_webhook_id_put) | **PUT** /v1/webhooks/{webhook_id} | Update webhook |
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
## create_webhook_v1_webhooks_post
|
|
14
14
|
|
|
15
15
|
> <WebhookItem> create_webhook_v1_webhooks_post(create_webhook_request)
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Create webhook
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Creates a subscription for alert events (10 alerts). Payload delivered: WebhookPayload(event, data, timestamp) with HMAC FalaAI-Signature. To verify the origin, recompute HMAC-SHA256 of \"timestamp.body\" with your secret.
|
|
20
20
|
|
|
21
21
|
### Examples
|
|
22
22
|
|
|
@@ -30,10 +30,10 @@ FalaAI.configure do |config|
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
api_instance = FalaAI::WebhooksApi.new
|
|
33
|
-
create_webhook_request = FalaAI::CreateWebhookRequest.new({name: '
|
|
33
|
+
create_webhook_request = FalaAI::CreateWebhookRequest.new({name: 'name_example', url: 'url_example', events: [FalaAI::WebhookEvent::SUBSCRIPTION_CREATED]}) # CreateWebhookRequest |
|
|
34
34
|
|
|
35
35
|
begin
|
|
36
|
-
#
|
|
36
|
+
# Create webhook
|
|
37
37
|
result = api_instance.create_webhook_v1_webhooks_post(create_webhook_request)
|
|
38
38
|
p result
|
|
39
39
|
rescue FalaAI::ApiError => e
|
|
@@ -49,7 +49,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
49
49
|
|
|
50
50
|
```ruby
|
|
51
51
|
begin
|
|
52
|
-
#
|
|
52
|
+
# Create webhook
|
|
53
53
|
data, status_code, headers = api_instance.create_webhook_v1_webhooks_post_with_http_info(create_webhook_request)
|
|
54
54
|
p status_code # => 2xx
|
|
55
55
|
p headers # => { ... }
|
|
@@ -83,9 +83,9 @@ end
|
|
|
83
83
|
|
|
84
84
|
> <MessageResponse> delete_webhook_v1_webhooks_webhook_id_delete(webhook_id)
|
|
85
85
|
|
|
86
|
-
|
|
86
|
+
Delete webhook
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
Deletes a webhook subscription by ID.
|
|
89
89
|
|
|
90
90
|
### Examples
|
|
91
91
|
|
|
@@ -102,7 +102,7 @@ api_instance = FalaAI::WebhooksApi.new
|
|
|
102
102
|
webhook_id = 'webhook_id_example' # String |
|
|
103
103
|
|
|
104
104
|
begin
|
|
105
|
-
#
|
|
105
|
+
# Delete webhook
|
|
106
106
|
result = api_instance.delete_webhook_v1_webhooks_webhook_id_delete(webhook_id)
|
|
107
107
|
p result
|
|
108
108
|
rescue FalaAI::ApiError => e
|
|
@@ -118,7 +118,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
118
118
|
|
|
119
119
|
```ruby
|
|
120
120
|
begin
|
|
121
|
-
#
|
|
121
|
+
# Delete webhook
|
|
122
122
|
data, status_code, headers = api_instance.delete_webhook_v1_webhooks_webhook_id_delete_with_http_info(webhook_id)
|
|
123
123
|
p status_code # => 2xx
|
|
124
124
|
p headers # => { ... }
|
|
@@ -152,9 +152,9 @@ end
|
|
|
152
152
|
|
|
153
153
|
> <WebhookListResponse> list_webhooks_v1_webhooks_get(opts)
|
|
154
154
|
|
|
155
|
-
|
|
155
|
+
List webhooks
|
|
156
156
|
|
|
157
|
-
|
|
157
|
+
Lists the authenticated user's webhooks (10 alerts). Paginated. Includes the URL signature secret (always visible to the owner).
|
|
158
158
|
|
|
159
159
|
### Examples
|
|
160
160
|
|
|
@@ -174,7 +174,7 @@ opts = {
|
|
|
174
174
|
}
|
|
175
175
|
|
|
176
176
|
begin
|
|
177
|
-
#
|
|
177
|
+
# List webhooks
|
|
178
178
|
result = api_instance.list_webhooks_v1_webhooks_get(opts)
|
|
179
179
|
p result
|
|
180
180
|
rescue FalaAI::ApiError => e
|
|
@@ -190,7 +190,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
190
190
|
|
|
191
191
|
```ruby
|
|
192
192
|
begin
|
|
193
|
-
#
|
|
193
|
+
# List webhooks
|
|
194
194
|
data, status_code, headers = api_instance.list_webhooks_v1_webhooks_get_with_http_info(opts)
|
|
195
195
|
p status_code # => 2xx
|
|
196
196
|
p headers # => { ... }
|
|
@@ -225,9 +225,9 @@ end
|
|
|
225
225
|
|
|
226
226
|
> <MessageResponse> update_webhook_v1_webhooks_webhook_id_put(webhook_id, update_webhook_request)
|
|
227
227
|
|
|
228
|
-
|
|
228
|
+
Update webhook
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
Updates the webhook's name/url/events/retry_enabled/active. Valid events: 10 alerts.
|
|
231
231
|
|
|
232
232
|
### Examples
|
|
233
233
|
|
|
@@ -245,7 +245,7 @@ webhook_id = 'webhook_id_example' # String |
|
|
|
245
245
|
update_webhook_request = FalaAI::UpdateWebhookRequest.new # UpdateWebhookRequest |
|
|
246
246
|
|
|
247
247
|
begin
|
|
248
|
-
#
|
|
248
|
+
# Update webhook
|
|
249
249
|
result = api_instance.update_webhook_v1_webhooks_webhook_id_put(webhook_id, update_webhook_request)
|
|
250
250
|
p result
|
|
251
251
|
rescue FalaAI::ApiError => e
|
|
@@ -261,7 +261,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
261
261
|
|
|
262
262
|
```ruby
|
|
263
263
|
begin
|
|
264
|
-
#
|
|
264
|
+
# Update webhook
|
|
265
265
|
data, status_code, headers = api_instance.update_webhook_v1_webhooks_webhook_id_put_with_http_info(webhook_id, update_webhook_request)
|
|
266
266
|
p status_code # => 2xx
|
|
267
267
|
p headers # => { ... }
|