Skip to content

Commit

Permalink
Merge pull request #26 from AssemblyAI/E2B031BE6A11C67EA5D87E19B5EDAE2E
Browse files Browse the repository at this point in the history 
Release spec changes including LeMUR input_text
  • Loading branch information
@Swimburger
Swimburger authored Nov 16, 2023
2 parents e0b5b63 + 750ab7f commit e8d87bf
Show file tree
Hide file tree
Showing 3 changed files with 188 additions and 160 deletions.
46 changes: 24 additions & 22 deletions asyncapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ channels:
type: object
properties:
Authentication:
description: Authenticate using your AssemblyAI API key.
description: Authenticate using your AssemblyAI API key
type: string
query:
type: object
properties:
sample_rate:
description: The sample rate of the streamed audio.
description: The sample rate of the streamed audio
type: integer
word_boost:
description: |
Add up to 2500 characters of custom vocabulary.
The parameter should map to a JSON encoded list of strings.
The parameter value must be a JSON encoded array of strings.
type: string
token:
description: "Authenticate using a [generated temporary token](https://www.assemblyai.com/docs/Guides/real-time_streaming_transcription#creating-temporary-authentication-tokens)"
Expand Down Expand Up @@ -100,7 +100,7 @@ components:
$ref: "#/components/schemas/RealtimeError"
PartialTranscript:
messageId: partialTranscript
summary: As you send audio data to the API, the API immediately starts responding with Partial Results.
summary: As you send audio data to the API, the API immediately starts responding with Partial Transcript results.
payload:
$ref: "#/components/schemas/PartialTranscript"
FinalTranscript:
Expand All @@ -117,7 +117,7 @@ components:
- message_type
properties:
message_type:
description: Describes the type of the message.
description: Describes the type of the message
$ref: "#/components/schemas/MessageType"
RealtimeMessage:
oneOf:
Expand Down Expand Up @@ -155,14 +155,14 @@ components:
- expires_at
properties:
message_type:
description: Describes the type of the message.
description: Describes the type of the message
type: string
const: SessionBegins
session_id:
description: Unique identifier for the established session.
description: Unique identifier for the established session
type: string
expires_at:
description: Timestamp when this session will expire.
description: Timestamp when this session will expire
type: string
pattern: '^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$'
x-fern-type: datetime
Expand All @@ -175,7 +175,7 @@ components:
- message_type
properties:
message_type:
description: Describes the type of the message.
description: Describes the type of the message
type: string
const: SessionTerminated
additionalProperties: false
Expand All @@ -190,27 +190,29 @@ components:
- created
properties:
audio_start:
description: Start time of audio sample relative to session start, in milliseconds.
description: Start time of audio sample relative to session start, in milliseconds
type: integer
audio_end:
description: End time of audio sample relative to session start, in milliseconds.
description: End time of audio sample relative to session start, in milliseconds
type: integer
confidence:
description: The confidence score of the entire transcription, between 0 and 1.
description: The confidence score of the entire transcription, between 0 and 1
type: number
minimum: 0
maximum: 1
format: double
text:
description: The partial transcript for your audio.
description: The partial transcript for your audio
type: string
words:
description: An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
description: |
An array of objects, with the information for each word in the transcription text.
Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
type: array
items:
$ref: "#/components/schemas/Word"
created:
description: The timestamp for the partial transcript.
description: The timestamp for the partial transcript
type: string
pattern: '^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$'
x-fern-type: datetime
Expand All @@ -223,7 +225,7 @@ components:
- message_type
properties:
message_type:
description: Describes the type of message.
description: Describes the type of message
type: string
const: PartialTranscript
additionalProperties: false
Expand All @@ -237,14 +239,14 @@ components:
- text_formatted
properties:
message_type:
description: Describes the type of message.
description: Describes the type of message
type: string
const: FinalTranscript
punctuated:
description: Whether the text has been punctuated and cased.
description: Whether the text is punctuated and cased
type: boolean
text_formatted:
description: Whether the text has been formatted (e.g. Dollar -> $)
description: Whether the text is formatted, for example Dollar -> $
type: boolean
additionalProperties: false
Word:
Expand Down Expand Up @@ -277,7 +279,7 @@ components:
- audio_data
properties:
audio_data:
description: Raw audio data, base64 encoded. This can be the raw data recorded directly from a microphone or read from an audio file.
description: Base64 encoded raw audio data
type: string
additionalProperties: false
TerminateSession:
Expand All @@ -288,12 +290,12 @@ components:
- terminate_session
properties:
terminate_session:
description: A boolean value to communicate that you wish to end your real-time session forever.
description: Set to true to end your real-time session forever
type: boolean
additionalProperties: false
securitySchemes:
ApiKey:
description: Authenticate using your AssemblyAI API key.
description: Authenticate using your AssemblyAI API key
type: httpApiKey
in: header
name: Authorization
Expand Down
Loading

0 comments on commit e8d87bf

Please sign in to comment.