falaai-api 1.21.49 → 1.21.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd424a4222684b15b8858c2545873748ae0186905e13df8b87edb5b9cc7a0176
-  data.tar.gz: 36d4614309d8ddeaa0b647fb7a9f141a4ed102fbb7761faafa8b3fb106e3cb54
+  metadata.gz: d83d046b979cd6c1d09c21c3c76a82ea6b0d17131e1018b972a7fea0a3a50f3e
+  data.tar.gz: ba6256865b059b177181ce24f00cd857a2df99b0af69584fd8b4131b3a00d7df
 SHA512:
-  metadata.gz: 4eab457d32570575ae15027dd0e4499330d3aeb7fc6447bc67674c5ace493a6aca993c590155b596efae744bfdb65079f2f631f745bd14e1898e86b61c673926
-  data.tar.gz: da26196663d8efa3e9f4fa79d124739c698ca455187fd84e510fc6a0c08a41581d7b691cc07595f711a2f95c24cfc71932da0bd9af1a3a3b077a0b4d97757b30
+  metadata.gz: 74c598532ababe5e246b16f3e260886235f8b5e7f25df353b3d7cd2dc27ee392c90dbd8b1d0fac9ece144e7f04efa1209368c102c847e5008e476eecf1a8c8be
+  data.tar.gz: d3590c7c1c2e1e20bb4157f73125daae0c297dff4d44b985f3fcb7df100f4233a3672e9e200e2f68592fa61b0cf804c2099bfeb2f7b3fc815221bf738aea537a

data/README.md

@@ -28,23 +28,6 @@ Telegram voice -> your STT           ->  FalaAI Risk Audit
 CRM conversation                     ->  FalaAI Risk Audit
 ```
 
-## Use the APIs the way you want
-
-Every FalaAI API is **independent and optional** — chain any subset, in any combination.
-
-```mermaid
-flowchart LR
-  A["Audio"] -.->|optional| T["Transcribe"]
-  T --> X["Text / dialog"]
-  S["Your own STT / CRM / chat / existing transcript"] --> X
-  X -.->|optional| D["Diagnostic"]
-  X -.->|optional| R["Risk Audit"]
-  D --> O["Structured intelligence + auditable report"]
-  R --> O
-```
-
-> Skip **Transcribe** if you already have text. Call only **Diagnostic**, only **Risk Audit**, or both.
-
 ## Install
 
 ```bash
@@ -137,10 +120,37 @@ FalaAI API is an **AI conversation-intelligence API** for analyzing customer-ser
 
 ## Use cases
 
-- **Contact center / Quality** — audit 100% of conversations instead of a sample.
-- **Compliance / Legal** — auditable evidence for audits and disputes.
-- **CX / Operations** — risk score, sentiment and reason per conversation.
-- **BI / Data** — typed JSON ready for your database or analytics stack.
+- **Contact center / Quality** - audit 100% of conversations instead of a sample.
+- **Compliance / Legal** - auditable evidence for audits and disputes.
+- **CX / Operations** - risk score, sentiment and reason per conversation.
+- **BI / Data** - typed JSON ready for your database or analytics stack.
+
+## Why FalaAI
+
+- **Audit 100%, not a sample** - every conversation gets a score, not a random QA sample.
+- **Auditable by design** - a compliance risk score with detections/violations and an HTML report you can hand to an auditor.
+- **Credits, not tokens** - you know exactly what each call costs (per second of audio, per character of text, per conversation). Monthly plans + non-expiring top-up packs.
+- **Zero-storage** - audio/text/results are processed and discarded; only usage/audit records remain. TLS in transit + at rest, per-account isolation (multitenancy), LGPD (you are the controller; Action Tec is the processor).
+- **3 native languages** (PT/EN/ES) · **start free** (no card).
+- **B2B ready** - one Enterprise plan serves N clients, no per-user fee (ideal for ISVs).
+
+## Integrations
+
+FalaAI is **language-independent** - integrate at **any point** of your pipeline (capture, transcription, analysis or audit). Common ecosystems:
+
+| Ecosystem | How |
+|---|---|
+| **PABX / telephony (3CX, Asterisk, Genesys)** | Send the recording to Transcribe, or the transcript to Diagnostic/Risk Audit. |
+| **CRM / ERP (Odoo, Salesforce, SAP Service Cloud, HubSpot)** | Attach the structured JSON (summary, reason, sentiment, risk score) to the record. |
+| **Contact center / QA (Zendesk, Twilio Flex, Take Blip)** | Batch-audit conversations and feed the score into your QA dashboard. |
+| **Chatbots / messaging (WhatsApp, Telegram, Microsoft Teams)** | Extract conversations from an export and analyze them. |
+| **BI / Data** | Typed JSON ready for your warehouse or analytics stack. |
+
+> These are **integration examples**, not certified native integrations. Any platform can integrate through **REST / cURL** - the standard, language-independent path. Native ingestion connectors are on the roadmap.
+
+## BYOT - Bring Your Own Transcription
+
+Already have speech-to-text (Whisper, Deepgram, AssemblyAI, your own)? **Skip Transcription** and send the text straight to **Diagnostic** and/or **Risk Audit**. You only pay for what you use.
 
 ## SDK surface (Ruby)
 
@@ -151,15 +161,16 @@ FalaAI API is an **AI conversation-intelligence API** for analyzing customer-ser
 | `HealthApi` | `FalaAI` | `health_check` |
 | `SpeechApi` | `FalaAI` | `create_transcription_v1_audio_transcriptions_post_with_http_info(...)` |
 | `AnalysisApi` | `FalaAI` | `create_diagnostic_v1_analyze_diagnostic_post_with_http_info(...)`, `create_risk_audit_v1_analyze_risk_audit_post_with_http_info(...)` |
+| `WhatsappApi` | `FalaAI` | `extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info(...)` |
 | `UsageApi` / `WebhooksApi` / `EmailAlertsApi` / `VersionApi` | `FalaAI` | management |
-| Models | `FalaAI` | `DiagnosticRequest`, `RiskAuditRequest`, `Participant`, `DiagnosticAudioEvent` |
+| Models | `FalaAI` | `DiagnosticRequest`, `RiskAuditRequest`, `Participant`, `DiagnosticAudioEvent`, `WhatsappConversationsResponse` |
 | `ApiError` | `FalaAI` | HTTP errors |
 
 > Model IDs: `falaai-transcribe-1`, `falaai-diagnostic-1`, `falaai-risk-audit-1`.
 
 ## Examples
 
-Runnable examples in [`examples/`](./examples): `health.rb`, `transcribe.rb`, `diagnose.rb`, `audit.rb`.
+Runnable examples in [`examples/`](./examples): `health.rb`, `transcribe.rb`, `diagnose.rb`, `audit.rb`, `whatsapp.rb`.
 
 ## Authentication
 
@@ -180,19 +191,6 @@ rescue FalaAI::ApiError => e
 end
 ```
 
-## Where to integrate (this SDK)
-
-FalaAI is language-independent; this package targets **Ruby** backends.
-
-| Platform / environment (this SDK's language: **Ruby**) | Integration |
-|---|---|
-| **Ruby on Rails** apps | `falaai-api` (Ruby) |
-| Ruby workers / Sidekiq jobs | `falaai-api` (Ruby) |
-| Ruby data pipelines | `falaai-api` (Ruby) |
-| Other stacks (3CX, Salesforce, Genesys...) | REST / cURL — [API reference](https://api01-falaai.action.tec.br/docs) (or the SDK for that backend's language) |
-
-> These are **integration examples**, not certified native integrations. Any platform can integrate through **REST / cURL** — see the [API reference](https://api01-falaai.action.tec.br/docs). Authenticated calls use `Authorization: Bearer fai_<key>`.
-
 ## Production usage
 
 - Store API keys in environment variables or a secret manager — never hard-code.
@@ -204,7 +202,7 @@ FalaAI is language-independent; this package targets **Ruby** backends.
 | Requirement | Version |
 |---|---|
 | Ruby | 2.7+ |
-| API | v1.21.49 |
+| API | v1.21.51 |
 
 ## Documentation
 
@@ -217,7 +215,7 @@ FalaAI is language-independent; this package targets **Ruby** backends.
 
 ## Versioning
 
-Semantic versioning; the SDK version tracks the API version (`1.21.49`). See [CHANGELOG.md](CHANGELOG.md) and [Releases](https://github.com/ActionTecBr/falaai-api-ruby/releases).
+Semantic versioning; the SDK version tracks the API version (`1.21.51`). See [CHANGELOG.md](CHANGELOG.md) and [Releases](https://github.com/ActionTecBr/falaai-api-ruby/releases).
 
 ## Security
 

data/docs/RiskAuditRequest.md

@@ -13,7 +13,7 @@
 | **response_language** | **String** | Language for analysis results (labels, categories, levels, actions, HTML report). Can differ from 'language'. Accepted: pt-BR, en-US, es-ES. |  |
 | **call_direction** | **String** | Who originated the call. inbound=client called, outbound=company called. If omitted, LLM infers from context. | [optional] |
 | **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] |
-| **response_format** | **String** | Response format version. v1=legacy flat PT-BR, v2=structured EN-US blocks. | [optional][default to 'v2'] |
+| **response_format** | **String** | Response format version. Only 'v2' (structured EN-US blocks) is available today. | [optional][default to 'v2'] |
 | **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] |
 
 ## Example

data/docs/WhatsappApi.md

@@ -0,0 +1,93 @@
+# FalaAI::WhatsappApi
+
+All URIs are relative to *https://api01-falaai.action.tec.br*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**extract_conversations_v1_whatsapp_extract_conversations_post**](WhatsappApi.md#extract_conversations_v1_whatsapp_extract_conversations_post) | **POST** /v1/whatsapp/extractConversations | Extract and segment WhatsApp conversations from an export |
+
+
+## extract_conversations_v1_whatsapp_extract_conversations_post
+
+> <WhatsappConversationsResponse> extract_conversations_v1_whatsapp_extract_conversations_post(file, start, _end, timezone, date_format, opts)
+
+Extract and segment WhatsApp conversations from an export
+
+### Examples
+
+```ruby
+require 'time'
+require 'falaai-api'
+# setup authorization
+FalaAI.configure do |config|
+  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FalaAI::WhatsappApi.new
+file = File.new('/path/to/some/file') # File | 
+start = 'start_example' # String | 
+_end = '_end_example' # String | 
+timezone = 'timezone_example' # String | 
+date_format = 'date_format_example' # String | 
+opts = {
+  gap_minutes: 8.14, # Float | 
+  min_messages: 56, # Integer | 
+  chars_per_minute: 8.14, # Float | 
+  client_reference_id: 'client_reference_id_example' # String | 
+}
+
+begin
+  # Extract and segment WhatsApp conversations from an export
+  result = api_instance.extract_conversations_v1_whatsapp_extract_conversations_post(file, start, _end, timezone, date_format, opts)
+  p result
+rescue FalaAI::ApiError => e
+  puts "Error when calling WhatsappApi->extract_conversations_v1_whatsapp_extract_conversations_post: #{e}"
+end
+```
+
+#### Using the extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WhatsappConversationsResponse>, Integer, Hash)> extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info(file, start, _end, timezone, date_format, opts)
+
+```ruby
+begin
+  # Extract and segment WhatsApp conversations from an export
+  data, status_code, headers = api_instance.extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info(file, start, _end, timezone, date_format, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WhatsappConversationsResponse>
+rescue FalaAI::ApiError => e
+  puts "Error when calling WhatsappApi->extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** |  |  |
+| **start** | **String** |  |  |
+| **_end** | **String** |  |  |
+| **timezone** | **String** |  |  |
+| **date_format** | **String** |  |  |
+| **gap_minutes** | **Float** |  | [optional][default to 720] |
+| **min_messages** | **Integer** |  | [optional][default to 2] |
+| **chars_per_minute** | **Float** |  | [optional][default to 800] |
+| **client_reference_id** | **String** |  | [optional] |
+
+### Return type
+
+[**WhatsappConversationsResponse**](WhatsappConversationsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/WhatsappConversation.md

@@ -0,0 +1,32 @@
+# FalaAI::WhatsappConversation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_id** | **String** | Conversation identifier in the batch |  |
+| **first_at** | **String** | Real start (wall-clock, ISO) |  |
+| **last_at** | **String** | Real end (wall-clock, ISO) |  |
+| **duration_seconds** | **Float** | (last - first) + last turn duration |  |
+| **speakers** | [**Array<WhatsappSpeaker>**](WhatsappSpeaker.md) | Speakers of THIS conversation (dynamic) |  |
+| **dialog** | **String** | Lines 'Speaker N: [HH:MM:SS.mmm - HH:MM:SS.mmm] text' (real offset) |  |
+| **message_count** | **Integer** | Number of messages |  |
+| **characters** | **Integer** | Total characters of the conversation |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappConversation.new(
+  conversation_id: null,
+  first_at: null,
+  last_at: null,
+  duration_seconds: null,
+  speakers: null,
+  dialog: null,
+  message_count: null,
+  characters: null
+)
+```
+

data/docs/WhatsappConversationsResponse.md

@@ -0,0 +1,28 @@
+# FalaAI::WhatsappConversationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier. Prefix 'wc-' + UUID |  |
+| **object** | **String** | Object type. Always 'conversations' |  |
+| **usage** | [**WhatsappUsage**](WhatsappUsage.md) | Usage and processing information |  |
+| **conversations** | [**Array<WhatsappConversation>**](WhatsappConversation.md) | Segmented conversations |  |
+| **client_reference_id** | **String** | Client-supplied ID echoed verbatim (if provided) | [optional] |
+| **meta** | [**WhatsappMeta**](WhatsappMeta.md) | Segmentation parameters and counts |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappConversationsResponse.new(
+  id: null,
+  object: null,
+  usage: null,
+  conversations: null,
+  client_reference_id: null,
+  meta: null
+)
+```
+

data/docs/WhatsappMeta.md

@@ -0,0 +1,48 @@
+# FalaAI::WhatsappMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **String** | Uploaded file name |  |
+| **chat_txt** | **String** | chat.txt entry name inside the export |  |
+| **format** | **String** | Detected format: Android | iOS |  |
+| **date_format** | **String** | Date order used |  |
+| **timezone** | **String** | Timezone informed |  |
+| **start** | **String** | Window start (ISO) |  |
+| **_end** | **String** | Window end (ISO) |  |
+| **gap_minutes** | **Float** | Gap used to split conversations |  |
+| **min_messages** | **Integer** | Minimum messages per conversation |  |
+| **chars_per_minute** | **Float** | Chars per minute used to estimate duration |  |
+| **turns** | **Integer** | Total parsed turns |  |
+| **system_lines** | **Integer** | System lines ignored |  |
+| **conversations_total** | **Integer** | Conversations before window filter |  |
+| **conversations_in_window** | **Integer** | Conversations overlapping the window |  |
+| **monologues_dropped** | **Integer** | Single-speaker conversations dropped |  |
+| **conversations_selected** | **Integer** | Final conversations returned |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappMeta.new(
+  file: null,
+  chat_txt: null,
+  format: null,
+  date_format: null,
+  timezone: null,
+  start: null,
+  _end: null,
+  gap_minutes: null,
+  min_messages: null,
+  chars_per_minute: null,
+  turns: null,
+  system_lines: null,
+  conversations_total: null,
+  conversations_in_window: null,
+  monologues_dropped: null,
+  conversations_selected: null
+)
+```
+

data/docs/WhatsappSpeaker.md

@@ -0,0 +1,20 @@
+# FalaAI::WhatsappSpeaker
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Speaker label (e.g. 'Speaker 1') |  |
+| **name** | **String** | Participant name from the export |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappSpeaker.new(
+  label: null,
+  name: null
+)
+```
+

data/docs/WhatsappUsage.md

@@ -0,0 +1,24 @@
+# FalaAI::WhatsappUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversations** | **Integer** | Number of conversations returned |  |
+| **characters** | **Integer** | Total characters across conversations |  |
+| **credits_consumed** | **Integer** | Credits consumed (1 per conversation) |  |
+| **processing_ms** | **Integer** | Total processing time in milliseconds |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappUsage.new(
+  conversations: null,
+  characters: null,
+  credits_consumed: null,
+  processing_ms: null
+)
+```
+