falaai-api 1.21.51 → 1.21.67

data/docs/WhatsappConversation.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **conversation_id** | **String** | Conversation identifier in the batch |  |
+| **conversation_id** | **String** | Stable conversation id: yyyymmddhhmm-<first speaker>[-xN for >2 speakers] |  |
 | **first_at** | **String** | Real start (wall-clock, ISO) |  |
 | **last_at** | **String** | Real end (wall-clock, ISO) |  |
 | **duration_seconds** | **Float** | (last - first) + last turn duration |  |

data/docs/WhatsappMeta.md

@@ -13,13 +13,15 @@
 | **_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 |  |
+| **voice_note** | **Boolean** | Voice/video medias were transcribed |  |
+| **expression** | **Boolean** | Visual expressions were described |  |
+| **windows** | **Integer** | Explicit windows used (0 = simple start/end range) |  |
 
 ## Example
 
@@ -36,13 +38,15 @@ instance = FalaAI::WhatsappMeta.new(
   _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
+  conversations_selected: null,
+  voice_note: null,
+  expression: null,
+  windows: null
 )
 ```
 

data/docs/WhatsappPreviewItem.md

@@ -0,0 +1,32 @@
+# FalaAI::WhatsappPreviewItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_id** | **String** | Stable id: yyyymmddhhmm-<first speaker>[-xN for >2 speakers] |  |
+| **first_at** | **String** | Conversation start (ISO) |  |
+| **last_at** | **String** | Conversation end (ISO) |  |
+| **duration_minutes** | **Float** | Conversation duration in minutes |  |
+| **messages** | **Integer** | Messages in this conversation |  |
+| **characters** | **Integer** | Characters of this conversation (estimate: media text is only replaced by tokens on extraction) |  |
+| **media** | [**WhatsappPreviewItemMedia**](WhatsappPreviewItemMedia.md) | Media of this conversation |  |
+| **credits** | [**WhatsappPreviewItemCredits**](WhatsappPreviewItemCredits.md) | Credits of this conversation |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewItem.new(
+  conversation_id: null,
+  first_at: null,
+  last_at: null,
+  duration_minutes: null,
+  messages: null,
+  characters: null,
+  media: null,
+  credits: null
+)
+```
+

data/docs/WhatsappPreviewItemBreakdown.md

@@ -0,0 +1,26 @@
+# FalaAI::WhatsappPreviewItemBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation** | **Float** | Conversation credit (0,15) |  |
+| **figurinha** | **Float** | Figurinha credits of this conversation |  |
+| **gif** | **Float** | GIF credits of this conversation |  |
+| **emoji** | **Float** | Emoji credits of this conversation |  |
+| **audio** | **Float** | Audio credits of this conversation |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewItemBreakdown.new(
+  conversation: null,
+  figurinha: null,
+  gif: null,
+  emoji: null,
+  audio: null
+)
+```
+

data/docs/WhatsappPreviewItemCredits.md

@@ -0,0 +1,20 @@
+# FalaAI::WhatsappPreviewItemCredits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Float** | Credits of THIS conversation (2 decimals, exact fraction — the charge is ONE ceil on the batch total) |  |
+| **breakdown** | [**WhatsappPreviewItemBreakdown**](WhatsappPreviewItemBreakdown.md) | Credits by component for THIS conversation |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewItemCredits.new(
+  total: null,
+  breakdown: null
+)
+```
+

data/docs/WhatsappPreviewItemMedia.md

@@ -0,0 +1,30 @@
+# FalaAI::WhatsappPreviewItemMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **figurinha** | **Integer** | Figurinha occurrences in this conversation (0 quando expression=false) |  |
+| **gif** | **Integer** | GIF occurrences in this conversation (0 quando expression=false) |  |
+| **emoji** | **Integer** | Emoji occurrences in this conversation (0 quando expression=false) |  |
+| **ptt** | **Integer** | Voice/audio/video turns in this conversation (cobra 0,19/segundo SO quando voice_note=true) |  |
+| **ptt_seconds** | **Float** | Voice/video SECONDS counted in this conversation (0 quando voice_note=false) |  |
+| **anexos** | **Integer** | Image/document turns in this conversation (ANEXO: nunca cobrado) |  |
+| **by_type** | **Hash<String, Integer>** | Media turns by type in THIS conversation (voz/audio/video/imagem/figurinha/gif/arquivo/oculta/chamada) |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewItemMedia.new(
+  figurinha: null,
+  gif: null,
+  emoji: null,
+  ptt: null,
+  ptt_seconds: null,
+  anexos: null,
+  by_type: null
+)
+```
+

data/docs/WhatsappPreviewParams.md

@@ -0,0 +1,32 @@
+# FalaAI::WhatsappPreviewParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **String** | Window start actually used (file period when start/end are omitted in dry_run) |  |
+| **_end** | **String** | Window end actually used (file period when start/end are omitted in dry_run) |  |
+| **timezone** | **String** | Timezone informed |  |
+| **date_format** | **String** | Date order used |  |
+| **gap_minutes** | **Float** | Gap used to split conversations |  |
+| **min_messages** | **Integer** | Minimum messages per conversation |  |
+| **voice_note** | **Boolean** | Voice/video medias would be transcribed (charge flag) |  |
+| **expression** | **Boolean** | Visual expressions would be described (charge flag) |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewParams.new(
+  start: null,
+  _end: null,
+  timezone: null,
+  date_format: null,
+  gap_minutes: null,
+  min_messages: null,
+  voice_note: null,
+  expression: null
+)
+```
+

data/docs/WhatsappPreviewResponse.md

@@ -0,0 +1,32 @@
+# FalaAI::WhatsappPreviewResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type. Always 'whatsapp_preview' |  |
+| **dry_run** | **Boolean** | Always true (preview: no AI call, no charge) |  |
+| **credits_charged** | **Integer** | Always 0 in preview |  |
+| **credits_total** | **Float** | TOTAL credits = exact SUM of the selected conversations (2 decimals, NO rounding up) |  |
+| **params** | [**WhatsappPreviewParams**](WhatsappPreviewParams.md) | Filter parameters actually used (reuse them in the extraction) |  |
+| **windows** | [**Array<WhatsappPreviewWindow>**](WhatsappPreviewWindow.md) | Explicit windows used (empty when a single start/end range was used) |  |
+| **items** | [**Array<WhatsappPreviewItem>**](WhatsappPreviewItem.md) | Per-conversation detail (send back as `windows` to extract only what you want) |  |
+| **warnings** | **Array<String>** | Human-readable notices about what would be ignored |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewResponse.new(
+  object: null,
+  dry_run: null,
+  credits_charged: null,
+  credits_total: null,
+  params: null,
+  windows: null,
+  items: null,
+  warnings: null
+)
+```
+

data/docs/WhatsappPreviewWindow.md

@@ -0,0 +1,22 @@
+# FalaAI::WhatsappPreviewWindow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **String** | Window start used |  |
+| **_end** | **String** | Window end used |  |
+| **selected** | **Integer** | Conversations matched by THIS window (before the union dedupe) |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappPreviewWindow.new(
+  start: null,
+  _end: null,
+  selected: null
+)
+```
+

data/docs/WhatsappUsage.md

@@ -6,7 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **conversations** | **Integer** | Number of conversations returned |  |
 | **characters** | **Integer** | Total characters across conversations |  |
-| **credits_consumed** | **Integer** | Credits consumed (1 per conversation) |  |
+| **expressions** | **Integer** | Chargeable expression occurrences (figurinha+GIF+emoji); 0 quando expression=false |  |
+| **expressions_figurinha** | **Integer** | Figurinha occurrences (cobra 0,15 cada quando expression=true) |  |
+| **expressions_gif** | **Integer** | GIF occurrences (cobra 0,18 cada quando expression=true) |  |
+| **expressions_emoji** | **Integer** | Emoji occurrences (cobra 0,1 cada quando expression=true) |  |
+| **voice_notes** | **Integer** | Voice notes (PTT) resolved to text |  |
+| **conversation_credits** | **Float** | Credits for conversations (0,15 each) |  |
+| **expression_credits** | **Float** | Credits for expressions (figurinha 0,15 / GIF 0,18 / emoji 0,1) |  |
+| **audio_credits** | **Float** | Credits for transcribed voice seconds (0,19 per second; 0 quando voice_note=false) |  |
+| **credits_consumed** | **Float** | Total credits = round(conversation_credits + expression_credits + audio_credits, 2) |  |
 | **processing_ms** | **Integer** | Total processing time in milliseconds |  |
 
 ## Example
@@ -17,6 +25,14 @@ require 'falaai-api'
 instance = FalaAI::WhatsappUsage.new(
   conversations: null,
   characters: null,
+  expressions: null,
+  expressions_figurinha: null,
+  expressions_gif: null,
+  expressions_emoji: null,
+  voice_notes: null,
+  conversation_credits: null,
+  expression_credits: null,
+  audio_credits: null,
   credits_consumed: null,
   processing_ms: null
 )