Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ docs/RbmWebViewEnum.md
docs/RecordingAvailableCallback.md
docs/RecordingCompleteCallback.md
docs/RecordingStateEnum.md
docs/RecordingTranscriptionClip.md
docs/RecordingTranscriptionMetadata.md
docs/RecordingTranscriptions.md
docs/RecordingsApi.md
Expand Down Expand Up @@ -384,6 +385,7 @@ lib/bandwidth-sdk/models/rbm_web_view_enum.rb
lib/bandwidth-sdk/models/recording_available_callback.rb
lib/bandwidth-sdk/models/recording_complete_callback.rb
lib/bandwidth-sdk/models/recording_state_enum.rb
lib/bandwidth-sdk/models/recording_transcription_clip.rb
lib/bandwidth-sdk/models/recording_transcription_metadata.rb
lib/bandwidth-sdk/models/recording_transcriptions.rb
lib/bandwidth-sdk/models/redirect_callback.rb
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ Class | Method | HTTP request | Description
- [Bandwidth::RecordingAvailableCallback](docs/RecordingAvailableCallback.md)
- [Bandwidth::RecordingCompleteCallback](docs/RecordingCompleteCallback.md)
- [Bandwidth::RecordingStateEnum](docs/RecordingStateEnum.md)
- [Bandwidth::RecordingTranscriptionClip](docs/RecordingTranscriptionClip.md)
- [Bandwidth::RecordingTranscriptionMetadata](docs/RecordingTranscriptionMetadata.md)
- [Bandwidth::RecordingTranscriptions](docs/RecordingTranscriptions.md)
- [Bandwidth::RedirectCallback](docs/RedirectCallback.md)
Expand Down
70 changes: 70 additions & 0 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4354,6 +4354,72 @@ components:
type: array
items:
$ref: '#/components/schemas/transcription'
clips:
type: array
description: >-
A list of individual speech clips with speaker, timing, and
confidence information.
items:
$ref: '#/components/schemas/recordingTranscriptionClip'
example:
transcripts:
- speaker: 0
text: Hi, is Thursday at two still good for you? Perfect, talk soon.
confidence: 0.96
- speaker: 1
text: Yes, that works great. See you then! Sounds good, bye!
confidence: 0.97
clips:
- speaker: 0
text: Hi, is Thursday at two still good for you?
confidence: 0.97
startTimeSeconds: 0.4
endTimeSeconds: 3.1
- speaker: 1
text: Yes, that works great. See you then!
confidence: 0.95
startTimeSeconds: 3.8
endTimeSeconds: 6.2
- speaker: 0
text: Perfect, talk soon.
confidence: 0.94
startTimeSeconds: 6.9
endTimeSeconds: 8.1
- speaker: 1
text: Sounds good, bye!
confidence: 0.98
startTimeSeconds: 8.5
endTimeSeconds: 9.7
recordingTranscriptionClip:
type: object
properties:
speaker:
type: integer
description: Zero-based index identifying the speaker.
example: 0
text:
type: string
description: The transcribed text of this clip.
example: Hi there, thanks for calling!
confidence:
type: number
format: double
minimum: 0
maximum: 1
description: >-
How confident the transcription engine was in transcribing this clip
(from `0.0` to `1.0`).
example: 0.85
startTimeSeconds:
type: number
format: double
description: The start time of this clip within the recording, in seconds.
example: 2.3
endTimeSeconds:
type: number
format: double
description: The end time of this clip within the recording, in seconds.
example: 3.1
callTranscriptionMetadataList:
type: array
items:
Expand Down Expand Up @@ -5480,6 +5546,10 @@ components:
transcription:
type: object
properties:
speaker:
type: integer
description: Zero-based index identifying the speaker.
example: 0
text:
type: string
description: The transcribed text
Expand Down
2 changes: 1 addition & 1 deletion docs/RbmActionBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ require 'bandwidth-sdk'
instance = Bandwidth::RbmActionBase.new(
type: null,
text: Hello world,
postback_data: [B@20706e70
postback_data: [B@3c29f6be
)
```

2 changes: 1 addition & 1 deletion docs/RbmSuggestionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ require 'bandwidth-sdk'

instance = Bandwidth::RbmSuggestionResponse.new(
text: Yes, I would like to proceed,
postback_data: [B@20706e70,
postback_data: [B@3c29f6be,
paired_message_id: 1752697342534u24xerqdukke523x
)
```
Expand Down
26 changes: 26 additions & 0 deletions docs/RecordingTranscriptionClip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Bandwidth::RecordingTranscriptionClip

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **speaker** | **Integer** | Zero-based index identifying the speaker. | [optional] |
| **text** | **String** | The transcribed text of this clip. | [optional] |
| **confidence** | **Float** | How confident the transcription engine was in transcribing this clip (from `0.0` to `1.0`). | [optional] |
| **start_time_seconds** | **Float** | The start time of this clip within the recording, in seconds. | [optional] |
| **end_time_seconds** | **Float** | The end time of this clip within the recording, in seconds. | [optional] |

## Example

```ruby
require 'bandwidth-sdk'

instance = Bandwidth::RecordingTranscriptionClip.new(
speaker: 0,
text: Hi there, thanks for calling!,
confidence: 0.85,
start_time_seconds: 2.3,
end_time_seconds: 3.1
)
```

4 changes: 3 additions & 1 deletion docs/RecordingTranscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **transcripts** | [**Array<Transcription>**](Transcription.md) | | [optional] |
| **clips** | [**Array<RecordingTranscriptionClip>**](RecordingTranscriptionClip.md) | A list of individual speech clips with speaker, timing, and confidence information. | [optional] |

## Example

```ruby
require 'bandwidth-sdk'

instance = Bandwidth::RecordingTranscriptions.new(
transcripts: null
transcripts: null,
clips: null
)
```

2 changes: 2 additions & 0 deletions docs/Transcription.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **speaker** | **Integer** | Zero-based index identifying the speaker. | [optional] |
| **text** | **String** | The transcribed text | [optional] |
| **confidence** | **Float** | The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence. | [optional] |

Expand All @@ -13,6 +14,7 @@
require 'bandwidth-sdk'

instance = Bandwidth::Transcription.new(
speaker: 0,
text: Nice talking to you, friend!,
confidence: 0.9
)
Expand Down
1 change: 1 addition & 0 deletions lib/bandwidth-sdk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@
require 'bandwidth-sdk/models/recording_available_callback'
require 'bandwidth-sdk/models/recording_complete_callback'
require 'bandwidth-sdk/models/recording_state_enum'
require 'bandwidth-sdk/models/recording_transcription_clip'
require 'bandwidth-sdk/models/recording_transcription_metadata'
require 'bandwidth-sdk/models/recording_transcriptions'
require 'bandwidth-sdk/models/redirect_callback'
Expand Down
Loading