From 4ffa35c4f250cfa844d543e02345b6e578eb4dee Mon Sep 17 00:00:00 2001 From: Martin Schweiger Date: Tue, 25 Nov 2025 15:12:04 +0800 Subject: [PATCH 1/2] Remove SDK groups from API spec --- fern/.definition/__package__.yml | 54 - fern/.definition/api.yml | 17 - fern/.definition/files.yml | 53 - fern/.definition/lemur.yml | 549 ----- fern/.definition/realtime.yml | 406 ---- fern/.definition/transcripts.yml | 3472 ------------------------------ fern/generators.yml | 60 - openapi.yml | 184 +- 8 files changed, 81 insertions(+), 4714 deletions(-) delete mode 100644 fern/.definition/__package__.yml delete mode 100644 fern/.definition/api.yml delete mode 100644 fern/.definition/files.yml delete mode 100644 fern/.definition/lemur.yml delete mode 100644 fern/.definition/realtime.yml delete mode 100644 fern/.definition/transcripts.yml diff --git a/fern/.definition/__package__.yml b/fern/.definition/__package__.yml deleted file mode 100644 index f3269428..00000000 --- a/fern/.definition/__package__.yml +++ /dev/null @@ -1,54 +0,0 @@ -types: - Error: - extra-properties: true - properties: - error: - docs: Error message - type: string - status: optional> - source: - openapi: ../openapi.yml -errors: - BadRequestError: - docs: Bad request - examples: - - value: - error: This is a sample error message - status-code: 400 - type: Error - GatewayTimeoutError: - docs: Gateway timeout - status-code: 504 - type: unknown - InternalServerError: - docs: An error occurred while processing the request - examples: - - value: - error: Internal Server Error - status-code: 500 - type: Error - NotFoundError: - docs: Not found - examples: - - value: - error: Not found - status-code: 404 - type: Error - ServiceUnavailableError: - docs: Service unavailable - status-code: 503 - type: unknown - TooManyRequestsError: - docs: Too many requests - examples: - - value: - error: Too Many Requests - status-code: 429 - type: Error - UnauthorizedError: - docs: Unauthorized - examples: - - value: - error: Authentication error, API token missing/invalid - status-code: 401 - type: Error diff --git a/fern/.definition/api.yml b/fern/.definition/api.yml deleted file mode 100644 index 690b5608..00000000 --- a/fern/.definition/api.yml +++ /dev/null @@ -1,17 +0,0 @@ -auth: ApiKey -auth-schemes: - ApiKey: - header: Authorization - name: apiKey - type: string -default-environment: Default -default-url: Base -display-name: AssemblyAI API -environments: - Default: - urls: - API: wss://api.assemblyai.com - Base: https://api.assemblyai.com -error-discrimination: - strategy: status-code -name: api diff --git a/fern/.definition/files.yml b/fern/.definition/files.yml deleted file mode 100644 index c0d8860d..00000000 --- a/fern/.definition/files.yml +++ /dev/null @@ -1,53 +0,0 @@ -imports: - root: __package__.yml -types: - UploadedFile: - properties: - upload_url: - docs: > - A URL that points to your audio file, accessible only by AssemblyAI's - servers - type: string - source: - openapi: ../openapi.yml -service: - auth: false - base-path: "" - endpoints: - upload: - auth: true - display-name: Upload a media file - docs: > - To upload a media file to our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Upload a media file to AssemblyAI's servers. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - code-samples: - - code: | - curl -X POST https://api.assemblyai.com/v2/upload \ - -H "Authorization: " \ - -H "Content-Type: application/octet-stream" \ - --data-binary @path/to/file - sdk: curl - method: POST - path: /v2/upload - request: - body: bytes - content-type: application/octet-stream - response: - docs: Media file uploaded successfully - status-code: 200 - type: UploadedFile - source: - openapi: ../openapi.yml - source: - openapi: ../openapi.yml diff --git a/fern/.definition/lemur.yml b/fern/.definition/lemur.yml deleted file mode 100644 index 1c992cd2..00000000 --- a/fern/.definition/lemur.yml +++ /dev/null @@ -1,549 +0,0 @@ -imports: - root: __package__.yml -types: - LemurActionItemsParams: - extends: - - LemurBaseParams - properties: - answer_format: - default: Bullet Points - docs: | - How you want the action items to be returned. This can be any text. - Defaults to "Bullet Points". - type: optional - source: - openapi: ../openapi.yml - LemurActionItemsResponse: - extends: - - LemurStringResponse - properties: {} - source: - openapi: ../openapi.yml - LemurBaseParams: - properties: - context: - docs: >- - Context to provide the model. This can be a string or a free-form JSON - value. - type: optional - final_model: - docs: > - The model that is used for the final prompt after compression is - performed. - type: LemurModel - input_text: - docs: > - Custom formatted transcript data. Maximum size is the context limit of - the selected model. - - Use either transcript_ids or input_text as input into LeMUR. - type: optional - max_output_size: - default: 2000 - docs: Max output size in tokens, up to the `final_model`'s max [see chart](/docs/lemur/customize-parameters#change-the-maximum-output-size). - type: optional - temperature: - docs: > - The temperature to use for the model. - - Higher values result in answers that are more creative, lower values - are more conservative. - - Can be any value between 0.0 and 1.0 inclusive. - type: optional - transcript_ids: - docs: > - A list of completed transcripts with text. Up to a maximum of 100 hours of audio. - - Use either transcript_ids or input_text as input into LeMUR. - type: optional> - source: - openapi: ../openapi.yml - LemurBaseParamsContext: - discriminated: false - docs: >- - Context to provide the model. This can be a string or a free-form JSON - value. - inline: true - source: - openapi: ../openapi.yml - union: - - string - - map - LemurBaseResponse: - properties: - request_id: - docs: The ID of the LeMUR request - type: string - validation: - format: uuid - usage: - docs: The usage numbers for the LeMUR request - type: LemurUsage - source: - openapi: ../openapi.yml - LemurModel: - docs: > - The model that is used for the final prompt after compression is - performed. - enum: - - casing: - camel: anthropicClaude3_5_Sonnet - pascal: AnthropicClaude3_5_Sonnet - screaming-snake: ANTHROPIC_CLAUDE3_5_SONNET - snake: anthropic_claude3_5_sonnet - docs: > - Claude 3.5 Sonnet is Anthropic's most intelligent model to date, - outperforming Claude 3 Opus on a wide range of evaluations, with the - speed and cost of Claude 3 Sonnet. - name: AnthropicClaude35Sonnet - value: anthropic/claude-3-5-sonnet - - casing: - camel: anthropicClaude3_Opus - pascal: AnthropicClaude3_Opus - screaming-snake: ANTHROPIC_CLAUDE3_OPUS - snake: anthropic_claude3_opus - docs: > - Claude 3 Opus is good at handling complex analysis, longer tasks with - many steps, and higher-order math and coding tasks. - name: AnthropicClaude3Opus - value: anthropic/claude-3-opus - - casing: - camel: anthropicClaude3_Haiku - pascal: AnthropicClaude3_Haiku - screaming-snake: ANTHROPIC_CLAUDE3_HAIKU - snake: anthropic_claude3_haiku - docs: > - Claude 3 Haiku is the fastest model that can execute lightweight - actions. - name: AnthropicClaude3Haiku - value: anthropic/claude-3-haiku - source: - openapi: ../openapi.yml - LemurQuestion: - properties: - answer_format: - docs: > - How you want the answer to be returned. This can be any text. Can't be - used with answer_options. Examples: "short sentence", "bullet points" - type: optional - answer_options: - docs: > - What discrete options to return. Useful for precise responses. Can't - be used with answer_format. Example: ["Yes", "No"] - type: optional> - context: - docs: >- - Any context about the transcripts you wish to provide. This can be a - string or any object. - type: optional - question: - docs: >- - The question you wish to ask. For more complex questions use default - model. - type: string - source: - openapi: ../openapi.yml - LemurQuestionAnswer: - docs: An answer generated by LeMUR and its question - properties: - answer: - docs: The answer generated by LeMUR - type: string - question: - docs: The question for LeMUR to answer - type: string - source: - openapi: ../openapi.yml - LemurQuestionAnswerResponse: - extends: - - LemurBaseResponse - properties: - response: - docs: The answers generated by LeMUR and their questions - type: list - source: - openapi: ../openapi.yml - LemurQuestionContext: - discriminated: false - docs: >- - Any context about the transcripts you wish to provide. This can be a - string or any object. - inline: true - source: - openapi: ../openapi.yml - union: - - string - - map - LemurResponse: - discriminated: false - source: - openapi: ../openapi.yml - union: - - LemurStringResponse - - LemurQuestionAnswerResponse - LemurStringResponse: - extends: - - LemurBaseResponse - properties: - response: - docs: The response generated by LeMUR. - type: string - source: - openapi: ../openapi.yml - LemurSummaryResponse: - extends: - - LemurStringResponse - properties: {} - source: - openapi: ../openapi.yml - LemurTaskResponse: - extends: - - LemurStringResponse - properties: {} - source: - openapi: ../openapi.yml - LemurUsage: - docs: The usage numbers for the LeMUR request - properties: - input_tokens: - docs: The number of input tokens used by the model - type: integer - validation: - min: 0 - output_tokens: - docs: The number of output tokens generated by the model - type: integer - validation: - min: 0 - source: - openapi: ../openapi.yml - PurgeLemurRequestDataResponse: - properties: - deleted: - docs: Whether the request data was deleted - type: boolean - request_id: - docs: The ID of the deletion request of the LeMUR request - type: string - validation: - format: uuid - request_id_to_purge: - docs: The ID of the LeMUR request to purge the data for - type: string - validation: - format: uuid - source: - openapi: ../openapi.yml -docs: LeMUR related operations -service: - auth: false - base-path: "" - display-name: LeMUR - endpoints: - getResponse: - auth: true - display-name: Retrieve LeMUR response - docs: | - Retrieve a LeMUR response that was previously generated. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - request_id: request_id - response: - body: - request_id: 5e1b27c2-691f-4414-8bc5-f14678442f9e - response: > - Based on the transcript, the following locations were mentioned - as being affected by wildfire smoke from Canada: - - - - Maine - - - Maryland - - - Minnesota - - - Mid Atlantic region - - - Northeast region - - - New York City - - - Baltimore - usage: - input_tokens: 27 - output_tokens: 3 - method: GET - path: /lemur/v3/{request_id} - path-parameters: - request_id: - docs: | - The ID of the LeMUR request you previously made. - This would be found in the response of the original request. - type: string - response: - docs: LeMUR response - status-code: 200 - type: LemurResponse - source: - openapi: ../openapi.yml - purgeRequestData: - auth: true - display-name: Purge LeMUR request data - docs: > - Delete the data for a previously submitted LeMUR request. - - The LLM response data, as well as any context provided in the original - request will be removed. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - request_id: request_id - response: - body: - deleted: true - request_id: 914fe7e4-f10a-4364-8946-34614c2873f6 - request_id_to_purge: b7eb03ec-1650-4181-949b-75d9de317de1 - method: DELETE - path: /lemur/v3/{request_id} - path-parameters: - request_id: - docs: >- - The ID of the LeMUR request whose data you want to delete. This - would be found in the response of the original request. - type: string - response: - docs: LeMUR request data deleted - status-code: 200 - type: PurgeLemurRequestDataResponse - source: - openapi: ../openapi.yml - questionAnswer: - auth: true - display-name: Ask questions using LeMUR - docs: > - Question & Answer allows you to ask free-form questions about a single - transcript or a group of transcripts. - - The questions can be any whose answers you find useful, such as judging - whether a caller is likely to become a customer or whether all items on - a meeting's agenda were covered. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - request: - context: This is an interview about wildfires. - final_model: anthropic/claude-3-5-sonnet - max_output_size: 3000 - questions: - - answer_format: List of countries in ISO 3166-1 alpha-2 format - answer_options: - - US - - CA - question: Where are there wildfires? - - answer_options: - - "yes" - - "no" - question: Is global warming affecting wildfires? - temperature: 0 - transcript_ids: - - 64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce - response: - body: - request_id: 5e1b27c2-691f-4414-8bc5-f14678442f9e - response: - - answer: CA, US - question: Where are there wildfires? - - answer: "yes" - question: Is global warming affecting wildfires? - usage: - input_tokens: 27 - output_tokens: 3 - method: POST - path: /lemur/v3/generate/question-answer - request: - body: - extends: - - LemurBaseParams - properties: - questions: - docs: A list of questions to ask - type: list - content-type: application/json - name: LemurQuestionAnswerParams - response: - docs: LeMUR question & answer response - status-code: 200 - type: LemurQuestionAnswerResponse - source: - openapi: ../openapi.yml - summary: - auth: true - display-name: Summarize a transcript using LeMUR - docs: > - Custom Summary allows you to distill a piece of audio into a few - impactful sentences. - - You can give the model context to obtain more targeted results while - outputting the results in a variety of formats described in human - language. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - request: - context: This is an interview about wildfires. - final_model: anthropic/claude-3-5-sonnet - max_output_size: 3000 - temperature: 0 - transcript_ids: - - 47b95ba5-8889-44d8-bc80-5de38306e582 - response: - body: - request_id: 5e1b27c2-691f-4414-8bc5-f14678442f9e - response: > - - Wildfires in Canada are sending smoke and air pollution across - parts of the US, triggering air quality alerts from Maine to - Minnesota. Concentrations of particulate matter have exceeded - safety levels. - - - - Weather systems are channeling the smoke through Pennsylvania - into the Mid-Atlantic and Northeast regions. New York City has - canceled outdoor activities to keep children and vulnerable - groups indoors. - - - - Very small particulate matter can enter the lungs and impact - respiratory, cardiovascular and neurological health. Young - children, the elderly and those with preexisting conditions are - most at risk. - - - - The conditions causing the poor air quality could get worse or - shift to different areas in coming days depending on weather - patterns. More wildfires may also contribute to higher - concentrations. - - - - Climate change is leading to longer and more severe fire - seasons. Events of smoke traveling long distances and affecting - air quality over wide areas will likely become more common in - the future." - usage: - input_tokens: 27 - output_tokens: 3 - method: POST - path: /lemur/v3/generate/summary - request: - body: - extends: - - LemurBaseParams - properties: - answer_format: - docs: > - How you want the summary to be returned. This can be any text. - Examples: "TLDR", "bullet points" - type: optional - content-type: application/json - name: LemurSummaryParams - response: - docs: LeMUR summary response - status-code: 200 - type: LemurSummaryResponse - source: - openapi: ../openapi.yml - task: - auth: true - display-name: Run a task using LeMUR - docs: | - Use the LeMUR task endpoint to input your own LLM prompt. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - request: - context: This is an interview about wildfires. - final_model: anthropic/claude-3-5-sonnet - max_output_size: 3000 - prompt: List all the locations affected by wildfires. - temperature: 0 - transcript_ids: - - 64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce - response: - body: - request_id: 5e1b27c2-691f-4414-8bc5-f14678442f9e - response: > - Based on the transcript, the following locations were mentioned - as being affected by wildfire smoke from Canada: - - - - Maine - - - Maryland - - - Minnesota - - - Mid Atlantic region - - - Northeast region - - - New York City - - - Baltimore - usage: - input_tokens: 27 - output_tokens: 3 - method: POST - path: /lemur/v3/generate/task - request: - body: - extends: - - LemurBaseParams - properties: - prompt: - docs: >- - Your text to prompt the model to produce a desired output, - including any context you want to pass into the model. - type: string - content-type: application/json - name: LemurTaskParams - response: - docs: LeMUR task response - status-code: 200 - type: LemurTaskResponse - source: - openapi: ../openapi.yml - source: - openapi: ../openapi.yml diff --git a/fern/.definition/realtime.yml b/fern/.definition/realtime.yml deleted file mode 100644 index ed00e94a..00000000 --- a/fern/.definition/realtime.yml +++ /dev/null @@ -1,406 +0,0 @@ -imports: - root: __package__.yml -types: - AudioData: - docs: Binary audio data - type: string - validation: - format: binary - AudioEncoding: - default: pcm_s16le - docs: The encoding of the audio data - enum: - - casing: - camel: pcmS16le - pascal: PcmS16le - screaming-snake: PCM_S16LE - snake: pcm_s16le - docs: PCM signed 16-bit little-endian - value: pcm_s16le - - casing: - camel: pcmMulaw - pascal: PcmMulaw - screaming-snake: PCM_MULAW - snake: pcm_mulaw - docs: PCM Mu-law - value: pcm_mulaw - source: - openapi: ../asyncapi.yml - ConfigureEndUtteranceSilenceThreshold: - docs: >- - Configure the threshold for how long to wait before ending an utterance. - Default is 700ms. - properties: - end_utterance_silence_threshold: - docs: The duration threshold in milliseconds - type: integer - validation: - max: 20000 - min: 0 - source: - openapi: ../asyncapi.yml - FinalTranscript: - extends: - - RealtimeBaseTranscript - properties: - message_type: - docs: Describes the type of message - type: literal<"FinalTranscript"> - punctuated: - docs: Whether the text is punctuated and cased - type: boolean - text_formatted: - docs: Whether the text is formatted, for example Dollar -> $ - type: boolean - source: - openapi: ../asyncapi.yml - ForceEndUtterance: - docs: Manually end an utterance - properties: - force_end_utterance: - docs: >- - A boolean value to communicate that you wish to force the end of the - utterance - type: boolean - source: - openapi: ../asyncapi.yml - MessageType: - enum: - - SessionBegins - - PartialTranscript - - FinalTranscript - - SessionInformation - - SessionTerminated - source: - openapi: ../asyncapi.yml - PartialTranscript: - extends: - - RealtimeBaseTranscript - properties: - message_type: - docs: Describes the type of message - type: literal<"PartialTranscript"> - source: - openapi: ../asyncapi.yml - RealtimeBaseMessage: - properties: - message_type: - docs: Describes the type of the message - type: MessageType - source: - openapi: ../asyncapi.yml - RealtimeBaseTranscript: - properties: - audio_end: - docs: End time of audio sample relative to session start, in milliseconds - type: integer - audio_start: - docs: Start time of audio sample relative to session start, in milliseconds - type: integer - confidence: - docs: The confidence score of the entire transcription, between 0 and 1 - type: double - validation: - max: 1 - min: 0 - created: - docs: The timestamp for the partial transcript - type: datetime - text: - docs: The partial transcript for your audio - type: string - words: - docs: > - 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: list - source: - openapi: ../asyncapi.yml - RealtimeEncoding: - default: pcm_s16le - docs: The encoding of the audio data - enum: - - casing: - camel: pcmS16le - pascal: PcmS16le - screaming-snake: PCM_S16LE - snake: pcm_s16le - docs: PCM signed 16-bit little-endian - value: pcm_s16le - - casing: - camel: pcmMulaw - pascal: PcmMulaw - screaming-snake: PCM_MULAW - snake: pcm_mulaw - docs: PCM Mu-law - value: pcm_mulaw - source: - openapi: ../asyncapi.yml - RealtimeError: - properties: - error: string - source: - openapi: ../asyncapi.yml - RealtimeMessage: - discriminated: false - source: - openapi: ../asyncapi.yml - union: - - SessionBegins - - PartialTranscript - - FinalTranscript - - SessionInformation - - SessionTerminated - - RealtimeError - RealtimeTemporaryTokenResponse: - properties: - token: - docs: The temporary authentication token for Streaming Speech-to-Text - type: string - source: - openapi: ../openapi.yml - RealtimeTranscript: - discriminated: false - source: - openapi: ../asyncapi.yml - union: - - PartialTranscript - - FinalTranscript - RealtimeTranscriptType: - enum: - - PartialTranscript - - FinalTranscript - source: - openapi: ../asyncapi.yml - receiveMessage: - discriminated: false - docs: Receive messages from the WebSocket - source: - openapi: ../asyncapi.yml - union: - - SessionBegins - - PartialTranscript - - FinalTranscript - - SessionInformation - - SessionTerminated - - RealtimeError - sendMessage: - discriminated: false - docs: Send messages to the WebSocket - source: - openapi: ../asyncapi.yml - union: - - AudioData - - TerminateSession - - ForceEndUtterance - - ConfigureEndUtteranceSilenceThreshold - SessionBegins: - properties: - expires_at: - docs: Timestamp when this session will expire - type: datetime - message_type: - docs: Describes the type of the message - type: literal<"SessionBegins"> - session_id: - docs: Unique identifier for the established session - type: string - validation: - format: uuid - source: - openapi: ../asyncapi.yml - SessionInformation: - docs: > - Information about the session that is concluding. - - This message is sent at the end of the session, before the - SessionTerminated message. - properties: - audio_duration_seconds: - docs: The total duration of the audio in seconds - type: float - message_type: - docs: Describes the type of the message - type: literal<"SessionInformation"> - source: - openapi: ../asyncapi.yml - SessionTerminated: - properties: - message_type: - docs: Describes the type of the message - type: literal<"SessionTerminated"> - source: - openapi: ../asyncapi.yml - TerminateSession: - properties: - terminate_session: - docs: Set to true to end your streaming session forever - type: boolean - source: - openapi: ../asyncapi.yml - Word: - properties: - confidence: - docs: Confidence score of the word - type: double - validation: - max: 1 - min: 0 - end: - docs: End time of the word in milliseconds - type: integer - start: - docs: Start time of the word in milliseconds - type: integer - text: - docs: The word itself - type: string - source: - openapi: ../asyncapi.yml -channel: - auth: false - display-name: Streaming Speech-to-Text - examples: - - messages: - - body: UklGRtjIAABXQVZFZ - type: publish - - body: - audio_end: 1500 - audio_start: 0 - confidence: 0.987190506414702 - created: "2023-05-24T06:09:10Z" - message_type: PartialTranscript - text: there is a house in new orleans - words: - - confidence: 1 - end: 300 - start: 0 - text: there - type: subscribe - - body: - audio_end: 1500 - audio_start: 0 - confidence: 0.987190506414702 - created: "2023-05-24T06:09:10Z" - message_type: FinalTranscript - punctuated: true - text: There is a house in New Orleans. - text_formatted: true - words: - - confidence: 1 - end: 300 - start: 0 - text: there - type: subscribe - - body: - terminate_session: true - type: publish - - body: - message_type: SessionTerminated - type: subscribe - query-parameters: - sample_rate: 16000 - token: eyJhbGciOiJIUzI1... - word_boost: '["foo","bar"]' - headers: - Authorization: - docs: Authenticate using your AssemblyAI API key - name: authorization - type: optional - messages: - publish: - body: - docs: Send messages to the WebSocket - type: sendMessage - origin: client - subscribe: - body: - docs: Receive messages from the WebSocket - type: receiveMessage - origin: server - path: /v2/realtime/ws - query-parameters: - disable_partial_transcripts: - default: false - docs: Set to true to not receive partial transcripts. Defaults to false. - type: optional - enable_extra_session_information: - default: false - docs: >- - Set to true to receive the SessionInformation message before the session - ends. Defaults to false. - type: optional - encoding: - default: pcm_s16le - docs: The encoding of the audio data - type: optional - sample_rate: - docs: The sample rate of the streamed audio - type: integer - token: - docs: > - Authenticate using a [generated temporary - token](https://www.assemblyai.com/docs/speech-to-text/streaming#authenticate-with-a-temporary-token) - type: optional - validation: - format: password - word_boost: - docs: > - Add up to 2500 characters of custom vocabulary. - - The parameter value must be a JSON encoded array of strings. The JSON - must be URL encoded like other query string parameters. - type: optional - url: API -service: - auth: false - base-path: "" - endpoints: - createTemporaryToken: - auth: true - display-name: Create temporary authentication token for Streaming STT - docs: > - Streaming Speech-to-Text is currently not available on the EU - endpoint. - - Any usage associated with a temporary token will be attributed to - the API key that generated it. - - Create a temporary authentication token for Streaming Speech-to-Text - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - request: - expires_in: 480 - response: - body: - token: fe4145dd1e7a2e149488dcd2d553a8018a89833fc5084837d66fd1bcf5a105d4 - method: POST - path: /v2/realtime/token - request: - body: - properties: - expires_in: - docs: The amount of time until the token expires in seconds - type: integer - validation: - min: 60 - content-type: application/json - name: CreateRealtimeTemporaryTokenParams - response: - docs: Temporary authentication token generated - status-code: 200 - type: RealtimeTemporaryTokenResponse - source: - openapi: ../openapi.yml - source: - openapi: ../openapi.yml diff --git a/fern/.definition/transcripts.yml b/fern/.definition/transcripts.yml deleted file mode 100644 index 2cd86ff5..00000000 --- a/fern/.definition/transcripts.yml +++ /dev/null @@ -1,3472 +0,0 @@ -imports: - root: __package__.yml -types: - AudioIntelligenceModelStatus: - docs: Either success, or unavailable in the rare case that the model failed - enum: - - success - - unavailable - source: - openapi: ../openapi.yml - AutoHighlightResult: - properties: - count: - docs: The total number of times the key phrase appears in the audio file - type: integer - rank: - docs: >- - The total relevancy to the overall audio file of this key phrase - a - greater number means more relevant - type: float - text: - docs: The text itself of the key phrase - type: string - timestamps: - docs: The timestamp of the of the key phrase - type: list - source: - openapi: ../openapi.yml - AutoHighlightsResult: - docs: > - An array of results for the Key Phrases model, if it is enabled. - - See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for - more information. - properties: - results: - docs: A temporally-sequential array of Key Phrases - type: list - status: - docs: >- - The status of the Key Phrases model. Either success, or unavailable in - the rare case that the model failed. - type: AudioIntelligenceModelStatus - source: - openapi: ../openapi.yml - Chapter: - docs: Chapter of the audio file - properties: - end: - docs: The starting time, in milliseconds, for the chapter - type: integer - gist: - docs: >- - An ultra-short summary (just a few words) of the content spoken in the - chapter - type: string - headline: - docs: A single sentence summary of the content spoken during the chapter - type: string - start: - docs: The starting time, in milliseconds, for the chapter - type: integer - summary: - docs: A one paragraph summary of the content spoken during the chapter - type: string - source: - openapi: ../openapi.yml - ContentSafetyLabel: - properties: - confidence: - docs: The confidence score for the topic being discussed, from 0 to 1 - type: double - validation: - max: 1 - min: 0 - label: - docs: The label of the sensitive topic - type: string - severity: - docs: How severely the topic is discussed in the section, from 0 to 1 - type: double - validation: - max: 1 - min: 0 - source: - openapi: ../openapi.yml - ContentSafetyLabelResult: - properties: - labels: - docs: >- - An array of safety labels, one per sensitive topic that was detected - in the section - type: list - sentences_idx_end: - docs: The sentence index at which the section ends - type: integer - sentences_idx_start: - docs: The sentence index at which the section begins - type: integer - text: - docs: The transcript of the section flagged by the Content Moderation model - type: string - timestamp: - docs: Timestamp information for the section - type: Timestamp - source: - openapi: ../openapi.yml - ContentSafetyLabelsResult: - docs: > - An array of results for the Content Moderation model, if it is enabled. - - See [Content - moderation](https://www.assemblyai.com/docs/models/content-moderation) for - more information. - properties: - results: - docs: An array of results for the Content Moderation model - type: list - severity_score_summary: - docs: >- - A summary of the Content Moderation severity results for the entire - audio file - type: map - status: - docs: >- - The status of the Content Moderation model. Either success, or - unavailable in the rare case that the model failed. - type: AudioIntelligenceModelStatus - summary: - docs: >- - A summary of the Content Moderation confidence results for the entire - audio file - type: map - source: - openapi: ../openapi.yml - Entity: - docs: A detected entity - properties: - end: - docs: >- - The ending time, in milliseconds, for the detected entity in the audio - file - type: integer - entity_type: - docs: The type of entity for the detected entity - type: EntityType - start: - docs: >- - The starting time, in milliseconds, at which the detected entity - appears in the audio file - type: integer - text: - docs: The text for the detected entity - type: string - source: - openapi: ../openapi.yml - EntityType: - docs: The type of entity for the detected entity - enum: - - docs: >- - Customer account or membership identification number (e.g., Policy No. - 10042992, Member ID: HZ-5235-001) - value: account_number - - docs: Banking information, including account and routing numbers - value: banking_information - - docs: Blood type (e.g., O-, AB positive) - value: blood_type - - docs: "Credit card verification code (e.g., CVV: 080)" - value: credit_card_cvv - - docs: Expiration date of a credit card - value: credit_card_expiration - - docs: Credit card number - value: credit_card_number - - docs: Specific calendar date (e.g., December 18) - value: date - - docs: >- - Broader time periods, including date ranges, months, seasons, years, - and decades (e.g., 2020-2021, 5-9 May, January 1984) - value: date_interval - - docs: "Date of birth (e.g., Date of Birth: March 7,1961)" - value: date_of_birth - - docs: Driver's license number. (e.g., DL# 356933-540) - value: drivers_license - - docs: >- - Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, - Panadol) - value: drug - - docs: >- - Periods of time, specified as a number and a unit of time (e.g., 8 - months, 2 years) - value: duration - - docs: Email address (e.g., support@assemblyai.com) - value: email_address - - docs: Name of an event or holiday (e.g., Olympics, Yom Kippur) - value: event - - docs: >- - Names of computer files, including the extension or filepath (e.g., - Taxes/2012/brad-tax-returns.pdf) - value: filename - - docs: >- - Terms indicating gender identity or sexual orientation, including - slang terms (e.g., female, bisexual, trans) - value: gender_sexuality - - docs: >- - Healthcare numbers and health plan beneficiary numbers (e.g., Policy - No.: 5584-486-674-YM) - value: healthcare_number - - docs: Bodily injury (e.g., I broke my arm, I have a sprained wrist) - value: injury - - docs: >- - Internet IP address, including IPv4 and IPv6 formats (e.g., - 192.168.0.1) - value: ip_address - - docs: Name of a natural language (e.g., Spanish, French) - value: language - - docs: >- - Any Location reference including mailing address, postal code, city, - state, province, country, or coordinates. (e.g., Lake Victoria, 145 - Windsor St., 90210) - value: location - - docs: >- - Terms indicating marital status (e.g., Single, common-law, ex-wife, - married) - value: marital_status - - docs: >- - Name of a medical condition, disease, syndrome, deficit, or disorder - (e.g., chronic fatigue syndrome, arrhythmia, depression) - value: medical_condition - - docs: >- - Medical process, including treatments, procedures, and tests (e.g., - heart surgery, CT scan) - value: medical_process - - docs: Name and/or amount of currency (e.g., 15 pesos, $94.50) - value: money_amount - - docs: >- - Terms indicating nationality, ethnicity, or race (e.g., American, - Asian, Caucasian) - value: nationality - - docs: >- - Numerical PII (including alphanumeric strings) that doesn't fall under - other categories - value: number_sequence - - docs: Job title or profession (e.g., professor, actors, engineer, CPA) - value: occupation - - docs: >- - Name of an organization (e.g., CNN, McDonalds, University of Alaska, - Northwest General Hospital) - value: organization - - docs: Passport numbers, issued by any country (e.g., PA4568332, NU3C6L86S12) - value: passport_number - - docs: >- - Account passwords, PINs, access keys, or verification answers (e.g., - 27%alfalfa, temp1234, My mother's maiden name is Smith) - value: password - - docs: Number associated with an age (e.g., 27, 75) - value: person_age - - docs: Name of a person (e.g., Bob, Doug Jones, Dr. Kay Martinez, MD) - value: person_name - - docs: Telephone or fax number - value: phone_number - - docs: >- - Distinctive bodily attributes, including terms indicating race (e.g., - I'm 190cm tall, He belongs to the Black students' association) - value: physical_attribute - - docs: >- - Terms referring to a political party, movement, or ideology (e.g., - Republican, Liberal) - value: political_affiliation - - docs: Terms indicating religious affiliation (e.g., Hindu, Catholic) - value: religion - - docs: Medical statistics (e.g., 18%, 18 percent) - value: statistics - - docs: Expressions indicating clock times (e.g., 19:37:28, 10pm EST) - value: time - - docs: Internet addresses (e.g., https://www.assemblyai.com/) - value: url - - docs: Social Security Number or equivalent - value: us_social_security_number - - docs: Usernames, login names, or handles (e.g., @AssemblyAI) - value: username - - docs: >- - Vehicle identification numbers (VINs), vehicle serial numbers, and - license plate numbers (e.g., 5FNRL38918B111818, BIF7547) - value: vehicle_id - - docs: Names of Zodiac signs (e.g., Aries, Taurus) - value: zodiac_sign - source: - openapi: ../openapi.yml - PageDetails: - docs: >- - Details of the transcript page. Transcripts are sorted from newest to - oldest. The previous URL always points to a page with older transcripts. - properties: - current_url: - docs: The URL used to retrieve the current page of transcripts - type: string - limit: - docs: The number of results this page is limited to - type: integer - next_url: - docs: >- - The URL to the next page of transcripts. The next URL always points to - a page with newer transcripts. - type: optional - prev_url: - docs: >- - The URL to the next page of transcripts. The previous URL always - points to a page with older transcripts. - type: optional - result_count: - docs: The actual number of results in the page - type: integer - source: - openapi: ../openapi.yml - ParagraphsResponse: - properties: - audio_duration: - docs: The duration of the audio file in seconds - type: double - confidence: - docs: The confidence score for the transcript - type: double - validation: - max: 1 - min: 0 - id: - docs: The unique identifier of your transcript - type: string - validation: - format: uuid - paragraphs: - docs: An array of paragraphs in the transcript - type: list - source: - openapi: ../openapi.yml - PiiPolicy: - docs: The type of PII to redact - enum: - - docs: >- - Customer account or membership identification number (e.g., Policy No. - 10042992, Member ID: HZ-5235-001) - value: account_number - - docs: Banking information, including account and routing numbers - value: banking_information - - docs: Blood type (e.g., O-, AB positive) - value: blood_type - - docs: "Credit card verification code (e.g., CVV: 080)" - value: credit_card_cvv - - docs: Expiration date of a credit card - value: credit_card_expiration - - docs: Credit card number - value: credit_card_number - - docs: Specific calendar date (e.g., December 18) - value: date - - docs: >- - Broader time periods, including date ranges, months, seasons, years, - and decades (e.g., 2020-2021, 5-9 May, January 1984) - value: date_interval - - docs: "Date of birth (e.g., Date of Birth: March 7,1961)" - value: date_of_birth - - docs: Driver's license number. (e.g., DL# 356933-540) - value: drivers_license - - docs: >- - Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, - Panadol) - value: drug - - docs: >- - Periods of time, specified as a number and a unit of time (e.g., 8 - months, 2 years) - value: duration - - docs: Email address (e.g., support@assemblyai.com) - value: email_address - - docs: Name of an event or holiday (e.g., Olympics, Yom Kippur) - value: event - - docs: >- - Names of computer files, including the extension or filepath (e.g., - Taxes/2012/brad-tax-returns.pdf) - value: filename - - docs: >- - Terms indicating gender identity or sexual orientation, including - slang terms (e.g., female, bisexual, trans) - value: gender_sexuality - - docs: >- - Healthcare numbers and health plan beneficiary numbers (e.g., Policy - No.: 5584-486-674-YM) - value: healthcare_number - - docs: Bodily injury (e.g., I broke my arm, I have a sprained wrist) - value: injury - - docs: >- - Internet IP address, including IPv4 and IPv6 formats (e.g., - 192.168.0.1) - value: ip_address - - docs: Name of a natural language (e.g., Spanish, French) - value: language - - docs: >- - Any Location reference including mailing address, postal code, city, - state, province, country, or coordinates. (e.g., Lake Victoria, 145 - Windsor St., 90210) - value: location - - docs: >- - Terms indicating marital status (e.g., Single, common-law, ex-wife, - married) - value: marital_status - - docs: >- - Name of a medical condition, disease, syndrome, deficit, or disorder - (e.g., chronic fatigue syndrome, arrhythmia, depression) - value: medical_condition - - docs: >- - Medical process, including treatments, procedures, and tests (e.g., - heart surgery, CT scan) - value: medical_process - - docs: Name and/or amount of currency (e.g., 15 pesos, $94.50) - value: money_amount - - docs: >- - Terms indicating nationality, ethnicity, or race (e.g., American, - Asian, Caucasian) - value: nationality - - docs: >- - Numerical PII (including alphanumeric strings) that doesn't fall under - other categories - value: number_sequence - - docs: Job title or profession (e.g., professor, actors, engineer, CPA) - value: occupation - - docs: >- - Name of an organization (e.g., CNN, McDonalds, University of Alaska, - Northwest General Hospital) - value: organization - - docs: Passport numbers, issued by any country (e.g., PA4568332, NU3C6L86S12) - value: passport_number - - docs: >- - Account passwords, PINs, access keys, or verification answers (e.g., - 27%alfalfa, temp1234, My mother's maiden name is Smith) - value: password - - docs: Number associated with an age (e.g., 27, 75) - value: person_age - - docs: Name of a person (e.g., Bob, Doug Jones, Dr. Kay Martinez, MD) - value: person_name - - docs: Telephone or fax number - value: phone_number - - docs: >- - Distinctive bodily attributes, including terms indicating race (e.g., - I'm 190cm tall, He belongs to the Black students' association) - value: physical_attribute - - docs: >- - Terms referring to a political party, movement, or ideology (e.g., - Republican, Liberal) - value: political_affiliation - - docs: Terms indicating religious affiliation (e.g., Hindu, Catholic) - value: religion - - docs: Medical statistics (e.g., 18%, 18 percent) - value: statistics - - docs: Expressions indicating clock times (e.g., 19:37:28, 10pm EST) - value: time - - docs: Internet addresses (e.g., https://www.assemblyai.com/) - value: url - - docs: Social Security Number or equivalent - value: us_social_security_number - - docs: Usernames, login names, or handles (e.g., @AssemblyAI) - value: username - - docs: >- - Vehicle identification numbers (VINs), vehicle serial numbers, and - license plate numbers (e.g., 5FNRL38918B111818, BIF7547) - value: vehicle_id - - docs: Names of Zodiac signs (e.g., Aries, Taurus) - value: zodiac_sign - source: - openapi: ../openapi.yml - RedactedAudioNotification: - docs: The notification when the redacted audio is ready. - type: RedactedAudioResponse - RedactedAudioResponse: - properties: - redacted_audio_url: - docs: The URL of the redacted audio file - type: string - status: - docs: The status of the redacted audio - type: RedactedAudioStatus - source: - openapi: ../openapi.yml - RedactedAudioStatus: - docs: The status of the redacted audio - type: literal<"redacted_audio_ready"> - RedactPiiAudioQuality: - docs: >- - Controls the filetype of the audio created by redact_pii_audio. Currently - supports mp3 (default) and wav. See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more - details. - enum: - - casing: - camel: mp3 - pascal: Mp3 - screaming-snake: MP3 - snake: mp3 - docs: MP3 audio format is lower quality and lower size than WAV. - value: mp3 - - docs: >- - WAV audio format is the highest quality (no compression) and larger - size than MP3. - value: wav - source: - openapi: ../openapi.yml - SentencesResponse: - properties: - audio_duration: - docs: The duration of the audio file in seconds - type: double - confidence: - docs: The confidence score for the transcript - type: double - validation: - max: 1 - min: 0 - id: - docs: The unique identifier for the transcript - type: string - validation: - format: uuid - sentences: - docs: An array of sentences in the transcript - type: list - source: - openapi: ../openapi.yml - Sentiment: - enum: - - POSITIVE - - NEUTRAL - - NEGATIVE - source: - openapi: ../openapi.yml - SentimentAnalysisResult: - docs: The result of the Sentiment Analysis model - properties: - channel: - docs: >- - The channel of this utterance. The left and right channels are - channels 1 and 2. Additional channels increment the channel number - sequentially. - type: optional - confidence: - docs: >- - The confidence score for the detected sentiment of the sentence, from - 0 to 1 - type: double - validation: - max: 1 - min: 0 - end: - docs: The ending time, in milliseconds, of the sentence - type: integer - sentiment: - docs: >- - The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, - NEGATIVE - type: Sentiment - speaker: - docs: >- - The speaker of the sentence if [Speaker - Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) - is enabled, else null - type: optional - start: - docs: The starting time, in milliseconds, of the sentence - type: integer - text: - docs: The transcript of the sentence - type: string - source: - openapi: ../openapi.yml - SeverityScoreSummary: - properties: - high: - type: double - validation: - max: 1 - min: 0 - low: - type: double - validation: - max: 1 - min: 0 - medium: - type: double - validation: - max: 1 - min: 0 - source: - openapi: ../openapi.yml - SpeechModel: - docs: The speech model to use for the transcription. - enum: - - docs: >- - The model optimized for accuracy, low latency, ease of use, and - mutli-language support. - name: Best - value: best - - docs: A contextual model optimized for customization. - name: Slam1 - value: slam-1 - - docs: >- - The model optimized for accuracy, low latency, ease of use, and - mutli-language support. - name: Universal - value: universal - source: - openapi: ../openapi.yml - SubstitutionPolicy: - docs: >- - The replacement logic for detected PII, can be "entity_name" or "hash". - See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) - for more details. - enum: - - entity_name - - hash - source: - openapi: ../openapi.yml - SubtitleFormat: - docs: Format of the subtitles - enum: - - srt - - vtt - source: - openapi: ../openapi.yml - SummaryModel: - docs: The model to summarize the transcript - enum: - - informative - - conversational - - catchy - source: - openapi: ../openapi.yml - SummaryType: - docs: The type of summary - enum: - - bullets - - bullets_verbose - - gist - - headline - - paragraph - source: - openapi: ../openapi.yml - Timestamp: - docs: Timestamp containing a start and end property in milliseconds - properties: - end: - docs: The end time in milliseconds - type: integer - start: - docs: The start time in milliseconds - type: integer - source: - openapi: ../openapi.yml - TopicDetectionModelResult: - docs: > - The result of the Topic Detection model, if it is enabled. - - See [Topic - Detection](https://www.assemblyai.com/docs/models/topic-detection) for - more information. - properties: - results: - docs: An array of results for the Topic Detection model - type: list - status: - docs: >- - The status of the Topic Detection model. Either success, or - unavailable in the rare case that the model failed. - type: AudioIntelligenceModelStatus - summary: - docs: The overall relevance of topic to the entire audio file - type: map - source: - openapi: ../openapi.yml - TopicDetectionResult: - docs: The result of the topic detection model - properties: - labels: - docs: An array of detected topics in the text - type: optional> - text: - docs: The text in the transcript in which a detected topic occurs - type: string - timestamp: optional - source: - openapi: ../openapi.yml - TopicDetectionResultLabelsItem: - inline: true - properties: - label: - docs: >- - The IAB taxonomical label for the label of the detected topic, where > - denotes supertopic/subtopic relationship - type: string - relevance: - docs: How relevant the detected topic is of a detected topic - type: double - validation: - max: 1 - min: 0 - source: - openapi: ../openapi.yml - Transcript: - docs: A transcript object - properties: - acoustic_model: - availability: deprecated - docs: The acoustic model that was used for the transcript - type: string - audio_channels: - docs: >- - The number of audio channels in the audio file. This is only present - when multichannel is enabled. - type: optional - audio_duration: - docs: The duration of this transcript object's media file, in seconds - type: optional - audio_end_at: - docs: >- - The point in time, in milliseconds, in the file at which the - transcription was terminated - type: optional - audio_start_from: - docs: >- - The point in time, in milliseconds, in the file at which the - transcription was started - type: optional - audio_url: - docs: The URL of the media that was transcribed - type: string - auto_chapters: - docs: >- - Whether [Auto - Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is - enabled, can be true or false - type: optional - auto_highlights: - docs: Whether Key Phrases is enabled, either true or false - type: boolean - auto_highlights_result: optional - boost_param: - docs: The word boost parameter value - type: optional - chapters: - docs: An array of temporally sequential chapters for the audio file - type: optional> - confidence: - docs: >- - The confidence score for the transcript, between 0.0 (low confidence) - and 1.0 (high confidence) - type: optional - validation: - max: 1 - min: 0 - content_safety: - docs: >- - Whether [Content - Moderation](https://www.assemblyai.com/docs/models/content-moderation) - is enabled, can be true or false - type: optional - content_safety_labels: optional - custom_spelling: - docs: Customize how words are spelled and formatted using to and from values - type: optional> - custom_topics: - availability: deprecated - docs: Whether custom topics is enabled, either true or false - type: optional - disfluencies: - docs: >- - Transcribe Filler Words, like "umm", in your media file; can be true - or false - type: optional - dual_channel: - availability: deprecated - docs: >- - Whether [Dual channel - transcription](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) - was enabled in the transcription request, either true or false - type: optional - entities: - docs: > - An array of results for the Entity Detection model, if it is enabled. - - See [Entity - detection](https://www.assemblyai.com/docs/models/entity-detection) - for more information. - type: optional> - entity_detection: - docs: >- - Whether [Entity - Detection](https://www.assemblyai.com/docs/models/entity-detection) is - enabled, can be true or false - type: optional - error: - docs: Error message of why the transcript failed - type: optional - filter_profanity: - docs: >- - Whether [Profanity - Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) - is enabled, either true or false - type: optional - format_text: - docs: Whether Text Formatting is enabled, either true or false - type: optional - iab_categories: - docs: >- - Whether [Topic - Detection](https://www.assemblyai.com/docs/models/topic-detection) is - enabled, can be true or false - type: optional - iab_categories_result: optional - id: - docs: The unique identifier of your transcript - type: string - validation: - format: uuid - keyterms_prompt: - docs: > - Improve accuracy with up to 1000 domain-specific words or phrases - (maximum 6 words per phrase). - type: optional> - language_code: - docs: > - The language of your audio file. - - Possible values are found in [Supported - Languages](https://www.assemblyai.com/docs/concepts/supported-languages). - - The default value is 'en_us'. - type: optional - language_confidence: - docs: >- - The confidence score for the detected language, between 0.0 (low - confidence) and 1.0 (high confidence) - type: optional - validation: - max: 1 - min: 0 - language_confidence_threshold: - docs: > - The confidence threshold for the automatically detected language. - - An error will be returned if the language confidence is below this - threshold. - type: optional - language_detection: - docs: >- - Whether [Automatic language - detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) - is enabled, either true or false - type: optional - language_model: - availability: deprecated - docs: The language model that was used for the transcript - type: string - multichannel: - docs: >- - Whether [Multichannel - transcription](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription) - was enabled in the transcription request, either true or false - type: optional - prompt: - availability: deprecated - docs: >- - This parameter does not currently have any functionality attached to - it. - type: optional - punctuate: - docs: Whether Automatic Punctuation is enabled, either true or false - type: optional - redact_pii: - docs: >- - Whether [PII - Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is - enabled, either true or false - type: boolean - redact_pii_audio: - docs: > - Whether a redacted version of the audio file was generated, - - either true or false. See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for - more information. - type: optional - redact_pii_audio_quality: optional - redact_pii_policies: - docs: > - The list of PII Redaction policies that were enabled, if PII Redaction - is enabled. - - See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for - more information. - type: optional> - redact_pii_sub: - docs: >- - The replacement logic for detected PII, can be "entity_type" or - "hash". See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for - more details. - type: optional - sentiment_analysis: - docs: >- - Whether [Sentiment - Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) - is enabled, can be true or false - type: optional - sentiment_analysis_results: - docs: > - An array of results for the Sentiment Analysis model, if it is - enabled. - - See [Sentiment - Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) - for more information. - type: optional> - speaker_labels: - docs: >- - Whether [Speaker - diarization](https://www.assemblyai.com/docs/models/speaker-diarization) - is enabled, can be true or false - type: optional - speakers_expected: - docs: >- - Tell the speaker label model how many speakers it should attempt to - identify. See [Speaker - diarization](https://www.assemblyai.com/docs/models/speaker-diarization) - for more details. - type: optional - speech_model: optional - speech_threshold: - docs: > - Defaults to null. Reject audio files that contain less than this - fraction of speech. - - Valid values are in the range [0, 1] inclusive. - type: optional - speed_boost: - availability: deprecated - docs: Whether speed boost is enabled - type: optional - status: - docs: >- - The status of your transcript. Possible values are queued, processing, - completed, or error. - type: TranscriptStatus - summarization: - docs: >- - Whether - [Summarization](https://www.assemblyai.com/docs/models/summarization) - is enabled, either true or false - type: boolean - summary: - docs: >- - The generated summary of the media file, if - [Summarization](https://www.assemblyai.com/docs/models/summarization) - is enabled - type: optional - summary_model: - docs: > - The Summarization model used to generate the summary, - - if - [Summarization](https://www.assemblyai.com/docs/models/summarization) - is enabled - type: optional - summary_type: - docs: >- - The type of summary generated, if - [Summarization](https://www.assemblyai.com/docs/models/summarization) - is enabled - type: optional - text: - docs: The textual transcript of your media file - type: optional - throttled: - docs: >- - True while a request is throttled and false when a request is no - longer throttled - type: optional - topics: - docs: The list of custom topics provided if custom topics is enabled - type: optional> - utterances: - docs: > - When multichannel or speaker_labels is enabled, a list of turn-by-turn - utterance objects. - - See [Speaker - diarization](https://www.assemblyai.com/docs/speech-to-text/speaker-diarization) - and [Multichannel - transcription](https://www.assemblyai.com/docs/speech-to-text/speech-recognition#multichannel-transcription) - for more information. - type: optional> - webhook_auth: - docs: Whether webhook authentication details were provided - type: boolean - webhook_auth_header_name: - docs: >- - The header name to be sent with the transcript completed or failed - webhook requests - type: optional - webhook_status_code: - docs: >- - The status code we received from your server when delivering the - transcript completed or failed webhook request, if a webhook URL was - provided - type: optional - webhook_url: - docs: > - The URL to which we send webhook requests. - - We sends two different types of webhook requests. - - One request when a transcript is completed or failed, and one request - when the redacted audio is ready if redact_pii_audio is enabled. - type: optional - word_boost: - availability: deprecated - docs: The list of custom vocabulary to boost transcription probability for - type: optional> - words: - docs: > - An array of temporally-sequential word objects, one for each word in - the transcript. - - See [Speech - recognition](https://www.assemblyai.com/docs/models/speech-recognition) - for more information. - type: optional> - source: - openapi: ../openapi.yml - TranscriptBoostParam: - docs: How much to boost specified words - enum: - - low - - default - - high - source: - openapi: ../openapi.yml - TranscriptCustomSpelling: - docs: >- - Object containing words or phrases to replace, and the word or phrase to - replace with - properties: - from: - docs: Words or phrases to replace - type: list - to: - docs: Word to replace with - type: string - source: - openapi: ../openapi.yml - TranscriptLanguageCode: - docs: > - The language of your audio file. Possible values are found in [Supported - Languages](https://www.assemblyai.com/docs/concepts/supported-languages). - - The default value is 'en_us'. - enum: - - en - - en_au - - en_uk - - en_us - - es - - fr - - de - - it - - pt - - nl - - af - - sq - - am - - ar - - hy - - as - - az - - ba - - eu - - be - - bn - - bs - - br - - bg - - my - - ca - - zh - - hr - - cs - - da - - et - - fo - - fi - - gl - - ka - - el - - gu - - ht - - ha - - haw - - he - - hi - - hu - - is - - id - - ja - - jw - - kn - - kk - - km - - ko - - lo - - la - - lv - - ln - - lt - - lb - - mk - - mg - - ms - - ml - - mt - - mi - - mr - - mn - - ne - - "no" - - nn - - oc - - pa - - ps - - fa - - pl - - ro - - ru - - sa - - sr - - sn - - sd - - si - - sk - - sl - - so - - su - - sw - - sv - - tl - - tg - - ta - - tt - - te - - th - - bo - - tr - - tk - - uk - - ur - - uz - - vi - - cy - - yi - - yo - source: - openapi: ../openapi.yml - TranscriptList: - docs: >- - A list of transcripts. Transcripts are sorted from newest to oldest. The - previous URL always points to a page with older transcripts. - properties: - page_details: - docs: Details of the transcript page - type: PageDetails - transcripts: - docs: An array of transcripts - type: list - source: - openapi: ../openapi.yml - TranscriptListItem: - properties: - audio_url: - docs: The URL to the audio file - type: string - completed: - docs: The date and time the transcript was completed - type: optional - created: - docs: The date and time the transcript was created - type: datetime - error: - docs: Error message of why the transcript failed - type: optional - id: - docs: The unique identifier for the transcript - type: string - validation: - format: uuid - resource_url: - docs: The URL to retrieve the transcript - type: string - status: - docs: The status of the transcript - type: TranscriptStatus - source: - openapi: ../openapi.yml - TranscriptOptionalParams: - docs: The parameters for creating a transcript - properties: - audio_end_at: - docs: >- - The point in time, in milliseconds, to stop transcribing in your media - file - type: optional - audio_start_from: - docs: >- - The point in time, in milliseconds, to begin transcribing in your - media file - type: optional - auto_chapters: - default: false - docs: >- - Enable [Auto - Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can - be true or false - type: optional - auto_highlights: - default: false - docs: Enable Key Phrases, either true or false - type: optional - boost_param: - docs: How much to boost specified words - type: optional - content_safety: - default: false - docs: >- - Enable [Content - Moderation](https://www.assemblyai.com/docs/models/content-moderation), - can be true or false - type: optional - content_safety_confidence: - default: 50 - docs: >- - The confidence threshold for the Content Moderation model. Values must - be between 25 and 100. - type: optional - validation: - max: 100 - min: 25 - custom_spelling: - docs: Customize how words are spelled and formatted using to and from values - type: optional> - custom_topics: - availability: deprecated - default: false - docs: Enable custom topics, either true or false - type: optional - disfluencies: - default: false - docs: >- - Transcribe Filler Words, like "umm", in your media file; can be true - or false - type: optional - dual_channel: - availability: deprecated - default: false - docs: >- - Enable [Dual - Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) - transcription, can be true or false. - type: optional - entity_detection: - default: false - docs: >- - Enable [Entity - Detection](https://www.assemblyai.com/docs/models/entity-detection), - can be true or false - type: optional - filter_profanity: - default: false - docs: Filter profanity from the transcribed text, can be true or false - type: optional - format_text: - default: true - docs: Enable Text Formatting, can be true or false - type: optional - iab_categories: - default: false - docs: >- - Enable [Topic - Detection](https://www.assemblyai.com/docs/models/topic-detection), - can be true or false - type: optional - keyterms_prompt: - docs: > - `keyterms_prompt` is only supported when the `speech_model` - is specified as `slam-1` - - Improve accuracy with up to 1000 domain-specific words or phrases - (maximum 6 words per phrase). - type: optional> - language_code: optional - language_confidence_threshold: - docs: > - The confidence threshold for the automatically detected language. - - An error will be returned if the language confidence is below this - threshold. - - Defaults to 0. - type: optional - language_detection: - default: false - docs: >- - Enable [Automatic language - detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection), - either true or false. - type: optional - multichannel: - default: false - docs: >- - Enable - [Multichannel](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription) - transcription, can be true or false. - type: optional - prompt: - availability: deprecated - docs: >- - This parameter does not currently have any functionality attached to - it. - type: optional - punctuate: - default: true - docs: Enable Automatic Punctuation, can be true or false - type: optional - redact_pii: - default: false - docs: >- - Redact PII from the transcribed text using the Redact PII model, can - be true or false - type: optional - redact_pii_audio: - default: false - docs: >- - Generate a copy of the original media file with spoken PII "beeped" - out, can be true or false. See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for - more details. - type: optional - redact_pii_audio_quality: - docs: >- - Controls the filetype of the audio created by redact_pii_audio. - Currently supports mp3 (default) and wav. See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for - more details. - type: optional - redact_pii_policies: - docs: >- - The list of PII Redaction policies to enable. See [PII - redaction](https://www.assemblyai.com/docs/models/pii-redaction) for - more details. - type: optional> - redact_pii_sub: optional - sentiment_analysis: - default: false - docs: >- - Enable [Sentiment - Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), - can be true or false - type: optional - speaker_labels: - default: false - docs: >- - Enable [Speaker - diarization](https://www.assemblyai.com/docs/models/speaker-diarization), - can be true or false - type: optional - speakers_expected: - docs: >- - Tells the speaker label model how many speakers it should attempt to - identify. See [Speaker - diarization](https://www.assemblyai.com/docs/models/speaker-diarization) - for more details. - type: optional - speech_model: optional - speech_threshold: - docs: | - Reject audio files that contain less than this fraction of speech. - Valid values are in the range [0, 1] inclusive. - type: optional - summarization: - default: false - docs: >- - Enable - [Summarization](https://www.assemblyai.com/docs/models/summarization), - can be true or false - type: optional - summary_model: - docs: The model to summarize the transcript - type: optional - summary_type: - docs: The type of summary - type: optional - topics: - docs: The list of custom topics - type: optional> - webhook_auth_header_name: - docs: >- - The header name to be sent with the transcript completed or failed - webhook requests - type: optional - webhook_auth_header_value: - docs: >- - The header value to send back with the transcript completed or failed - webhook requests for added security - type: optional - webhook_url: - docs: > - The URL to which we send webhook requests. - - We sends two different types of webhook requests. - - One request when a transcript is completed or failed, and one request - when the redacted audio is ready if redact_pii_audio is enabled. - type: optional - word_boost: - availability: deprecated - docs: The list of custom vocabulary to boost transcription probability for - type: optional> - source: - openapi: ../openapi.yml - TranscriptParagraph: - properties: - confidence: - docs: The confidence score for the transcript of this paragraph - type: double - validation: - max: 1 - min: 0 - end: - docs: The ending time, in milliseconds, of the paragraph - type: integer - start: - docs: The starting time, in milliseconds, of the paragraph - type: integer - text: - docs: The transcript of the paragraph - type: string - words: - docs: An array of words in the paragraph - type: list - source: - openapi: ../openapi.yml - TranscriptReadyNotification: - docs: The notification when the transcript status is completed or error. - properties: - status: - docs: The status of the transcript. Either completed or error. - type: TranscriptReadyStatus - transcript_id: - docs: The ID of the transcript - type: string - validation: - format: uuid - source: - openapi: ../openapi.yml - TranscriptReadyStatus: - docs: The status of the transcript. Either completed or error. - enum: - - docs: The transcript job has been completed successfully. - value: completed - - docs: An error occurred while processing the audio file. - value: error - source: - openapi: ../openapi.yml - TranscriptSentence: - properties: - channel: - docs: >- - The channel of the sentence. The left and right channels are channels - 1 and 2. Additional channels increment the channel number - sequentially. - type: optional - confidence: - docs: The confidence score for the transcript of this sentence - type: double - validation: - max: 1 - min: 0 - end: - docs: The ending time, in milliseconds, for the sentence - type: integer - speaker: - docs: >- - The speaker of the sentence if [Speaker - Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) - is enabled, else null - type: optional - start: - docs: The starting time, in milliseconds, for the sentence - type: integer - text: - docs: The transcript of the sentence - type: string - words: - docs: An array of words in the sentence - type: list - source: - openapi: ../openapi.yml - TranscriptStatus: - docs: >- - The status of your transcript. Possible values are queued, processing, - completed, or error. - enum: - - docs: The audio file is in the queue to be processed by the API. - value: queued - - docs: The audio file is being processed by the API. - value: processing - - docs: The transcript job has been completed successfully. - value: completed - - docs: An error occurred while processing the audio file. - value: error - source: - openapi: ../openapi.yml - TranscriptUtterance: - properties: - channel: - docs: >- - The channel of this utterance. The left and right channels are - channels 1 and 2. Additional channels increment the channel number - sequentially. - type: optional - confidence: - docs: The confidence score for the transcript of this utterance - type: double - validation: - max: 1 - min: 0 - end: - docs: The ending time, in milliseconds, of the utterance in the audio file - type: integer - speaker: - docs: >- - The speaker of this utterance, where each speaker is assigned a - sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, - etc. - type: string - start: - docs: The starting time, in milliseconds, of the utterance in the audio file - type: integer - text: - docs: The text for this utterance - type: string - words: - docs: The words in the utterance. - type: list - source: - openapi: ../openapi.yml - TranscriptWebhookNotification: - discriminated: false - docs: The notifications sent to the webhook URL. - source: - openapi: ../openapi.yml - union: - - TranscriptReadyNotification - - RedactedAudioNotification - TranscriptWord: - properties: - channel: - docs: >- - The channel of the word. The left and right channels are channels 1 - and 2. Additional channels increment the channel number sequentially. - type: optional - confidence: - docs: The confidence score for the transcript of this word - type: double - validation: - max: 1 - min: 0 - end: - docs: The ending time, in milliseconds, for the word - type: integer - speaker: - docs: >- - The speaker of the word if [Speaker - Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) - is enabled, else null - type: optional - start: - docs: The starting time, in milliseconds, for the word - type: integer - text: - docs: The text of the word - type: string - source: - openapi: ../openapi.yml - WordSearchMatch: - properties: - count: - docs: The total amount of times the word is in the transcript - type: integer - indexes: - docs: >- - An array of all index locations for that word within the `words` array - of the completed transcript - type: list - text: - docs: The matched word - type: string - timestamps: - docs: An array of timestamps - type: list - source: - openapi: ../openapi.yml - WordSearchResponse: - properties: - id: - docs: The ID of the transcript - type: string - validation: - format: uuid - matches: - docs: The matches of the search - type: list - total_count: - docs: >- - The total count of all matched instances. For e.g., word 1 matched 2 - times, and word 2 matched 3 times, `total_count` will equal 5. - type: integer - source: - openapi: ../openapi.yml - WordSearchTimestamp: - docs: >- - An array of timestamps structured as [`start_time`, `end_time`] in - milliseconds - type: list -service: - auth: false - base-path: "" - endpoints: - delete: - auth: true - display-name: Delete transcript - docs: > - To delete your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Remove the data from the transcript and mark it as deleted. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - transcript_id: "{transcript_id}" - response: - body: - acoustic_model: assemblyai_default - audio_duration: 390 - audio_end_at: null - audio_start_from: null - audio_url: http://deleted_by_user - auto_chapters: false - auto_highlights: false - auto_highlights_result: null - boost_param: null - chapters: null - confidence: null - content_safety: null - content_safety_labels: null - custom_spelling: null - custom_topics: null - disfluencies: true - dual_channel: null - entities: null - entity_detection: false - error: null - filter_profanity: null - format_text: null - iab_categories: null - iab_categories_result: null - id: 47b95ba5-8889-44d8-bc80-5de38306e582 - language_code: null - language_confidence: null - language_confidence_threshold: null - language_detection: false - language_model: assemblyai_default - punctuate: null - redact_pii: false - redact_pii_audio: null - redact_pii_audio_quality: null - redact_pii_policies: null - redact_pii_sub: null - sentiment_analysis: false - sentiment_analysis_results: null - speaker_labels: null - speakers_expected: null - speech_model: null - speech_threshold: null - speed_boost: null - status: completed - summarization: false - summary: null - summary_model: null - summary_type: null - text: Deleted by user. - throttled: null - topics: null - utterances: null - webhook_auth: false - webhook_auth_header_name: null - webhook_status_code: null - webhook_url: http://deleted_by_user - word_boost: null - words: null - method: DELETE - path: /v2/transcript/{transcript_id} - path-parameters: - transcript_id: - docs: ID of the transcript - type: string - response: - docs: The deleted transcript response - status-code: 200 - type: Transcript - source: - openapi: ../openapi.yml - get: - auth: true - display-name: Get transcript - docs: > - To retrieve your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Get the transcript resource. The transcript is ready when the "status" - is "completed". - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - transcript_id: transcript_id - response: - body: - acoustic_model: assemblyai_default - audio_channels: 1 - audio_duration: 281 - audio_end_at: 280 - audio_start_from: 10 - audio_url: https://assembly.ai/wildfires.mp3 - auto_chapters: true - auto_highlights: true - auto_highlights_result: - results: - - count: 1 - rank: 0.08 - text: air quality alerts - timestamps: - - end: 5114 - start: 3978 - - count: 1 - rank: 0.08 - text: wide ranging air quality consequences - timestamps: - - end: 238694 - start: 235388 - - count: 1 - rank: 0.07 - text: more wildfires - timestamps: - - end: 232354 - start: 230972 - - count: 1 - rank: 0.07 - text: air pollution - timestamps: - - end: 156910 - start: 156004 - - count: 3 - rank: 0.07 - text: weather systems - timestamps: - - end: 47958 - start: 47344 - - end: 205818 - start: 205268 - - end: 213434 - start: 211588 - - count: 2 - rank: 0.06 - text: high levels - timestamps: - - end: 121646 - start: 121128 - - end: 155866 - start: 155412 - - count: 1 - rank: 0.06 - text: health conditions - timestamps: - - end: 152666 - start: 152138 - - count: 2 - rank: 0.06 - text: Peter de Carlo - timestamps: - - end: 19930 - start: 18948 - - end: 269194 - start: 268298 - - count: 1 - rank: 0.06 - text: New York City - timestamps: - - end: 126274 - start: 125768 - - count: 1 - rank: 0.05 - text: respiratory conditions - timestamps: - - end: 153786 - start: 152964 - - count: 3 - rank: 0.05 - text: New York - timestamps: - - end: 126034 - start: 125768 - - end: 171938 - start: 171448 - - end: 176322 - start: 176008 - - count: 3 - rank: 0.05 - text: climate change - timestamps: - - end: 230230 - start: 229548 - - end: 245162 - start: 244576 - - end: 263950 - start: 263348 - - count: 1 - rank: 0.05 - text: Johns Hopkins University Varsity - timestamps: - - end: 25490 - start: 23972 - - count: 1 - rank: 0.05 - text: heart conditions - timestamps: - - end: 154506 - start: 153988 - - count: 1 - rank: 0.05 - text: air quality warnings - timestamps: - - end: 13434 - start: 12308 - status: success - boost_param: high - chapters: - - end: 28840 - gist: Smoggy air quality alerts across US - headline: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts across US - start: 250 - summary: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. In some places, - the air quality warnings include the warning to stay inside. - - end: 280340 - gist: >- - What is it about the conditions right now that have caused - this round - headline: >- - High particulate matter in wildfire smoke can lead to - serious health problems - start: 29610 - summary: >- - Air pollution levels in Baltimore are considered unhealthy. - Exposure to high levels can lead to a host of health - problems. With climate change, we are seeing more wildfires. - Will we be seeing more of these kinds of wide ranging air - quality consequences? - confidence: 0.9404651451800253 - content_safety: true - content_safety_labels: - results: - - labels: - - confidence: 0.8142836093902588 - label: disasters - severity: 0.4093044400215149 - sentences_idx_end: 5 - sentences_idx_start: 0 - text: >- - Smoke from hundreds of wildfires in Canada is triggering - air quality alerts throughout the US. Skylines from Maine - to Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to - stay inside. We wanted to better understand what's - happening here and why, so we called Peter de Carlo, an - associate professor in the Department of Environmental - Health and Engineering at Johns Hopkins University - Varsity. Good morning, professor. Good morning. - timestamp: - end: 28840 - start: 250 - severity_score_summary: - disasters: - high: 0 - low: 0.5733263024656846 - medium: 0.42667369753431533 - health_issues: - high: 0.32122030095136983 - low: 0.22863814977924785 - medium: 0.45014154926938227 - status: success - summary: - disasters: 0.9940800441842205 - health_issues: 0.9216489289040967 - custom_topics: true - disfluencies: false - dual_channel: false - entities: - - end: 3130 - entity_type: location - start: 2548 - text: Canada - - end: 6382 - entity_type: location - start: 5498 - text: the US - - end: 7914 - entity_type: location - start: 7492 - text: Maine - - end: 8634 - entity_type: location - start: 8212 - text: Maryland - - end: 9578 - entity_type: location - start: 8932 - text: Minnesota - - end: 19930 - entity_type: person_name - start: 18948 - text: Peter de Carlo - - end: 21194 - entity_type: occupation - start: 20292 - text: associate professor - - end: 23706 - entity_type: organization - start: 21508 - text: Department of Environmental Health and Engineering - - end: 25490 - entity_type: organization - start: 23972 - text: Johns Hopkins University Varsity - - end: 26950 - entity_type: occupation - start: 26076 - text: professor - - end: 45898 - entity_type: location - start: 45184 - text: the US - - end: 50086 - entity_type: nationality - start: 49728 - text: Canadian - entity_detection: true - error: error - filter_profanity: true - format_text: true - iab_categories: true - iab_categories_result: - results: - - labels: - - label: Home&Garden>IndoorEnvironmentalQuality - relevance: 0.988274097442627 - - label: NewsAndPolitics>Weather - relevance: 0.5821335911750793 - - label: >- - MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth - relevance: 0.0042327106930315495 - - label: NewsAndPolitics>Disasters - relevance: 0.0033971222583204508 - - label: BusinessAndFinance>Business>GreenSolutions - relevance: 0.002469958271831274 - - label: MedicalHealth>DiseasesAndConditions>Cancer - relevance: 0.0014376690378412604 - - label: Science>Environment - relevance: 0.0014294233405962586 - - label: Travel>TravelLocations>PolarTravel - relevance: 0.001234519761055708 - - label: MedicalHealth>DiseasesAndConditions>ColdAndFlu - relevance: 0.0010231725173071027 - - label: BusinessAndFinance>Industries>PowerAndEnergyIndustry - relevance: 0.0007445293595083058 - text: >- - Smoke from hundreds of wildfires in Canada is triggering - air quality alerts throughout the US. Skylines from Maine - to Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to - stay inside. We wanted to better understand what's - happening here and why, so we called Peter de Carlo, an - associate professor in the Department of Environmental - Health and Engineering at Johns Hopkins University - Varsity. Good morning, professor. Good morning. - timestamp: - end: 28840 - start: 250 - status: success - summary: - BusinessAndFinance>Business>GreenSolutions: 0.06348437070846558 - BusinessAndFinance>Industries>EnvironmentalServicesIndustry: 0.14393523335456848 - BusinessAndFinance>Industries>PowerAndEnergyIndustry: 0.0012570273829624057 - HealthyLiving: 0.008222488686442375 - HealthyLiving>Wellness>SmokingCessation: 0.001540527562610805 - Home&Garden>IndoorEnvironmentalQuality: 0.9043831825256348 - MedicalHealth>DiseasesAndConditions>Allergies: 0.0010148967849090695 - MedicalHealth>DiseasesAndConditions>Cancer: 0.001097781932912767 - MedicalHealth>DiseasesAndConditions>ColdAndFlu: 0.0022315620444715023 - MedicalHealth>DiseasesAndConditions>HeartAndCardiovascularDiseases: 0.00213034451007843 - MedicalHealth>DiseasesAndConditions>Injuries: 0.0013950627762824297 - MedicalHealth>DiseasesAndConditions>Injuries>FirstAid: 0.0004885646631009877 - MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth: 0.11401086300611496 - MedicalHealth>DiseasesAndConditions>MentalHealth: 0.000717321818228811 - NewsAndPolitics>Disasters: 0.05041387677192688 - NewsAndPolitics>Weather: 1 - Science>Environment: 0.16117265820503235 - Style&Fashion>PersonalCare>DeodorantAndAntiperspirant: 0.0006022014422342181 - Technology&Computing>Computing>ComputerNetworking: 0.0005461975233629346 - Travel>TravelLocations>PolarTravel: 0.01308488193899393 - id: 9ea68fd3-f953-42c1-9742-976c447fb463 - keyterms_prompt: - - keyterms_prompt - language_code: en_us - language_confidence: 0.9959 - language_confidence_threshold: 0.7 - language_detection: true - language_model: assemblyai_default - multichannel: false - prompt: prompt - punctuate: true - redact_pii: true - redact_pii_audio: true - redact_pii_audio_quality: mp3 - redact_pii_policies: - - us_social_security_number - - credit_card_number - redact_pii_sub: hash - sentiment_analysis: true - speaker_labels: true - speakers_expected: 2 - speech_model: best - speech_threshold: 0.5 - speed_boost: true - status: completed - summarization: true - summary: >- - - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. In some places, the - air quality warnings include the warning to stay inside.\n- Air - pollution levels in Baltimore are considered unhealthy. Exposure - to high levels can lead to a host of health problems. With - climate change, we are seeing more wildfires. Will we be seeing - more of these kinds of wide ranging air quality consequences? - summary_model: informative - summary_type: bullets - text: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. And in some places, - the air quality warnings include the warning to stay inside. We - wanted to better understand what's happening here and why, so we - called Peter de Carlo, an associate professor in the Department - of Environmental Health and Engineering at Johns Hopkins - University Varsity. Good morning, professor. Good morning. What - is it about the conditions right now that have caused this round - of wildfires to affect so many people so far away? Well, there's - a couple of things. The season has been pretty dry already. And - then the fact that we're getting hit in the US. Is because - there's a couple of weather systems that are essentially - channeling the smoke from those Canadian wildfires through - Pennsylvania into the Mid Atlantic and the Northeast and kind of - just dropping the smoke there. So what is it in this haze that - makes it harmful? And I'm assuming it is harmful. It is. The - levels outside right now in Baltimore are considered unhealthy. - And most of that is due to what's called particulate matter, - which are tiny particles, microscopic smaller than the width of - your hair that can get into your lungs and impact your - respiratory system, your cardiovascular system, and even your - neurological your brain. What makes this particularly harmful? - Is it the volume of particulant? Is it something in particular? - What is it exactly? Can you just drill down on that a little bit - more? Yeah. So the concentration of particulate matter I was - looking at some of the monitors that we have was reaching levels - of what are, in science, big 150 micrograms per meter cubed, - which is more than ten times what the annual average should be - and about four times higher than what you're supposed to have on - a 24 hours average. And so the concentrations of these particles - in the air are just much, much higher than we typically see. And - exposure to those high levels can lead to a host of health - problems. And who is most vulnerable? I noticed that in New York - City, for example, they're canceling outdoor activities. And so - here it is in the early days of summer, and they have to keep - all the kids inside. So who tends to be vulnerable in a - situation like this? It's the youngest. So children, obviously, - whose bodies are still developing. The elderly, who are their - bodies are more in decline and they're more susceptible to the - health impacts of breathing, the poor air quality. And then - people who have preexisting health conditions, people with - respiratory conditions or heart conditions can be triggered by - high levels of air pollution. Could this get worse? That's a - good question. In some areas, it's much worse than others. And - it just depends on kind of where the smoke is concentrated. I - think New York has some of the higher concentrations right now, - but that's going to change as that air moves away from the New - York area. But over the course of the next few days, we will see - different areas being hit at different times with the highest - concentrations. I was going to ask you about more fires start - burning. I don't expect the concentrations to go up too much - higher. I was going to ask you how and you started to answer - this, but how much longer could this last? Or forgive me if I'm - asking you to speculate, but what do you think? Well, I think - the fires are going to burn for a little bit longer, but the key - for us in the US. Is the weather system changing. And so right - now, it's kind of the weather systems that are pulling that air - into our mid Atlantic and Northeast region. As those weather - systems change and shift, we'll see that smoke going elsewhere - and not impact us in this region as much. And so I think that's - going to be the defining factor. And I think the next couple of - days we're going to see a shift in that weather pattern and - start to push the smoke away from where we are. And finally, - with the impacts of climate change, we are seeing more - wildfires. Will we be seeing more of these kinds of wide ranging - air quality consequences or circumstances? I mean, that is one - of the predictions for climate change. Looking into the future, - the fire season is starting earlier and lasting longer, and - we're seeing more frequent fires. So, yeah, this is probably - something that we'll be seeing more frequently. This tends to be - much more of an issue in the Western US. So the eastern US. - Getting hit right now is a little bit new. But yeah, I think - with climate change moving forward, this is something that is - going to happen more frequently. That's Peter De Carlo, - associate professor in the Department of Environmental Health - and Engineering at Johns Hopkins University. Sergeant Carlo, - thanks so much for joining us and sharing this expertise with - us. Thank you for having me. - topics: - - topics - utterances: - - channel: channel - confidence: 0.9359033333333334 - end: 26950 - speaker: A - start: 250 - text: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to stay - inside. We wanted to better understand what's happening here - and why, so we called Peter de Carlo, an associate professor - in the Department of Environmental Health and Engineering at - Johns Hopkins University Varsity. Good morning, professor. - words: - - confidence: 0.97503 - end: 650 - speaker: A - start: 250 - text: Smoke - - confidence: 0.99999 - end: 1022 - speaker: A - start: 730 - text: from - - confidence: 0.99843 - end: 1418 - speaker: A - start: 1076 - text: hundreds - - confidence: 0.85 - end: 1614 - speaker: A - start: 1434 - text: of - - confidence: 0.89657 - end: 2346 - speaker: A - start: 1652 - text: wildfires - - confidence: 0.99994 - end: 2526 - speaker: A - start: 2378 - text: in - - confidence: 0.93864 - end: 3130 - speaker: A - start: 2548 - text: Canada - - confidence: 0.999 - end: 3454 - speaker: A - start: 3210 - text: is - - confidence: 0.75366 - end: 3946 - speaker: A - start: 3492 - text: triggering - - confidence: 1 - end: 4174 - speaker: A - start: 3978 - text: air - - confidence: 0.87745 - end: 4558 - speaker: A - start: 4212 - text: quality - - confidence: 0.94739 - end: 5114 - speaker: A - start: 4644 - text: alerts - - confidence: 0.99726 - end: 5466 - speaker: A - start: 5162 - text: throughout - - confidence: 0.79 - end: 5694 - speaker: A - start: 5498 - text: the - - confidence: 0.88 - end: 6382 - speaker: A - start: 5732 - text: US. - webhook_auth: true - webhook_auth_header_name: webhook-secret - webhook_status_code: 200 - webhook_url: https://your-webhook-url.tld/path - word_boost: - - aws - - azure - - google cloud - words: - - channel: channel - confidence: 0.97465 - end: 650 - speaker: speaker - start: 250 - text: Smoke - - channel: channel - confidence: 0.99999 - end: 1022 - speaker: speaker - start: 730 - text: from - - channel: channel - confidence: 0.99844 - end: 1418 - speaker: speaker - start: 1076 - text: hundreds - - channel: channel - confidence: 0.84 - end: 1614 - speaker: speaker - start: 1434 - text: of - - channel: channel - confidence: 0.89572 - end: 2346 - speaker: speaker - start: 1652 - text: wildfires - - channel: channel - confidence: 0.99994 - end: 2526 - speaker: speaker - start: 2378 - text: in - - channel: channel - confidence: 0.93953 - end: 3130 - speaker: speaker - start: 2548 - text: Canada - - channel: channel - confidence: 0.999 - end: 3454 - speaker: speaker - start: 3210 - text: is - - channel: channel - confidence: 0.74794 - end: 3946 - speaker: speaker - start: 3492 - text: triggering - - channel: channel - confidence: 1 - end: 4174 - speaker: speaker - start: 3978 - text: air - - channel: channel - confidence: 0.88077 - end: 4558 - speaker: speaker - start: 4212 - text: quality - - channel: channel - confidence: 0.94814 - end: 5114 - speaker: speaker - start: 4644 - text: alerts - - channel: channel - confidence: 0.99726 - end: 5466 - speaker: speaker - start: 5162 - text: throughout - - channel: channel - confidence: 0.79 - end: 5694 - speaker: speaker - start: 5498 - text: the - - channel: channel - confidence: 0.89 - end: 6382 - speaker: speaker - start: 5732 - text: US. - method: GET - path: /v2/transcript/{transcript_id} - path-parameters: - transcript_id: - docs: ID of the transcript - type: string - response: - docs: The transcript resource - status-code: 200 - type: Transcript - source: - openapi: ../openapi.yml - getParagraphs: - auth: true - display-name: Get paragraphs in transcript - docs: > - To retrieve your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Get the transcript split by paragraphs. The API will attempt to - semantically segment your transcript into paragraphs to create more - reader-friendly transcripts. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - transcript_id: transcript_id - response: - body: - audio_duration: 281 - confidence: 0.9578730257009361 - id: d5a3d302-066e-43fb-b63b-8f57baf185db - paragraphs: - - confidence: 0.73033 - end: 26950 - start: 250 - text: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to stay - inside. We wanted to better understand what's happening here - and why, so we called Peter Decarlo, an associate professor - in the Department of Environmental Health and Engineering at - Johns Hopkins University. Good morning, professor. - words: - - confidence: 0.73033 - end: 650 - start: 250 - text: Smoke - - confidence: 1 - end: 1022 - start: 730 - text: from - - confidence: 0.99992 - end: 1466 - start: 1076 - text: hundreds - - confidence: 1 - end: 1646 - start: 1498 - text: of - - confidence: 0.99667 - end: 56190 - start: 27850 - text: >- - Good morning. So what is it about the conditions right now - that have caused this round of wildfires to affect so many - people so far away? Well, there's a couple of things. The - season has been pretty dry already, and then the fact that - we're getting hit in the US. Is because there's a couple of - weather systems that are essentially channeling the smoke - from those Canadian wildfires through Pennsylvania into the - Mid Atlantic and the Northeast and kind of just dropping the - smoke there. - words: - - confidence: 0.99667 - end: 28262 - start: 27850 - text: Good - - confidence: 0.99742 - end: 28920 - start: 28316 - text: morning. - - confidence: 0.94736 - end: 29702 - start: 29290 - text: So - method: GET - path: /v2/transcript/{transcript_id}/paragraphs - path-parameters: - transcript_id: - docs: ID of the transcript - type: string - response: - docs: Exported paragraphs - status-code: 200 - type: ParagraphsResponse - source: - openapi: ../openapi.yml - getRedactedAudio: - auth: true - display-name: Get redacted audio - docs: > - To retrieve your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Retrieve the redacted audio object containing the status and URL to the - redacted audio. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - transcript_id: transcript_id - response: - body: - redacted_audio_url: >- - https://s3.us-west-2.amazonaws.com/api.assembly.ai.usw2/redacted-audio/785efd9e-0e20-45e1-967b-3db17770ed9f.wav?AWSAccessKeyId=aws-access-key0id&Signature=signature&x-amz-security-token=security-token&Expires=1698966551 - status: redacted_audio_ready - method: GET - path: /v2/transcript/{transcript_id}/redacted-audio - path-parameters: - transcript_id: - docs: ID of the transcript - type: string - response: - docs: >- - The redacted audio object containing the status and URL to the - redacted audio - status-code: 200 - type: RedactedAudioResponse - source: - openapi: ../openapi.yml - getSentences: - auth: true - display-name: Get sentences in transcript - docs: > - To retrieve your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Get the transcript split by sentences. The API will attempt to - semantically segment the transcript into sentences to create more - reader-friendly transcripts. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - path-parameters: - transcript_id: transcript_id - response: - body: - audio_duration: 281 - confidence: 0.9579390654205628 - id: d5a3d302-066e-43fb-b63b-8f57baf185db - sentences: - - channel: channel - confidence: 0.72412 - end: 6350 - speaker: speaker - start: 250 - text: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. - words: - - confidence: 0.72412 - end: 650 - start: 250 - text: Smoke - - confidence: 0.99996 - end: 1022 - start: 730 - text: from - - confidence: 0.99992 - end: 1466 - start: 1076 - text: hundreds - - confidence: 1 - end: 1646 - start: 1498 - text: of - - channel: channel - confidence: 0.99819 - end: 11050 - speaker: speaker - start: 6500 - text: >- - Skylines from Maine to Maryland to Minnesota are gray and - smoggy. - words: - - confidence: 0.99819 - end: 7306 - start: 6500 - text: Skylines - - confidence: 0.99987 - end: 7534 - start: 7338 - text: from - - confidence: 0.9972 - end: 7962 - start: 7572 - text: Maine - - confidence: 1 - end: 8206 - start: 8026 - text: to - - confidence: 0.5192 - end: 8650 - start: 8228 - text: Maryland - - confidence: 1 - end: 8926 - start: 8730 - text: to - method: GET - path: /v2/transcript/{transcript_id}/sentences - path-parameters: - transcript_id: - docs: ID of the transcript - type: string - response: - docs: Exported sentences - status-code: 200 - type: SentencesResponse - source: - openapi: ../openapi.yml - getSubtitles: - auth: true - display-name: Get subtitles for transcript - docs: > - To retrieve your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Export your transcript in SRT or VTT format to use with a video player - for subtitles and closed captions. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - method: GET - path: /v2/transcript/{transcript_id}/{subtitle_format} - path-parameters: - subtitle_format: - docs: The format of the captions - type: SubtitleFormat - transcript_id: - docs: ID of the transcript - type: string - request: - name: GetSubtitlesParams - query-parameters: - chars_per_caption: - docs: The maximum number of characters per caption - type: optional - response: - docs: The exported captions as text - status-code: 200 - type: text - source: - openapi: ../openapi.yml - list: - auth: true - display-name: List transcripts - docs: > - To retrieve your transcriptions on our EU server, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Retrieve a list of transcripts you created. - - Transcripts are sorted from newest to oldest and can be retrieved for - the last 90 days of usage. The previous URL always points to a page with - older transcripts. - - - If you need to retrieve transcripts from more than 90 days ago please - reach out to our Support team at support@assemblyai.com. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - response: - body: - page_details: - current_url: https://api.assemblyai.com/v2/transcript?limit=3 - limit: 3 - next_url: >- - https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229 - prev_url: >- - https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117 - result_count: 3 - transcripts: - - audio_url: http://deleted_by_user - completed: "2024-03-11T21:30:07Z" - created: "2024-03-11T21:29:59Z" - error: error - id: b33f4691-85b7-4f31-be12-a87cef1c1229 - resource_url: >- - https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229 - status: completed - - audio_url: >- - https://storage.googleapis.com/client-docs-samples/nbc.oopsie - created: "2024-03-11T21:23:59Z" - error: >- - Download error, unable to download - https://storage.googleapis.com/client-docs-samples/nbc.oopsie. - Please make sure the file exists and is accessible from the - internet. - id: ce522f10-d204-42e8-a838-6b95098145cc - resource_url: >- - https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc - status: error - - audio_url: https://assembly.ai/nbc.mp3 - completed: "2024-03-11T21:13:03Z" - created: "2024-03-11T21:12:57Z" - error: error - id: 28a73d01-98db-41dd-9e98-2533ba0af117 - resource_url: >- - https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117 - status: completed - method: GET - path: /v2/transcript - request: - name: ListTranscriptParams - query-parameters: - after_id: - docs: Get transcripts that were created after this transcript ID - type: optional - validation: - format: uuid - before_id: - docs: Get transcripts that were created before this transcript ID - type: optional - validation: - format: uuid - created_on: - docs: Only get transcripts created on this date - type: optional - validation: - format: date - limit: - default: 10 - docs: Maximum amount of transcripts to retrieve - type: optional - validation: - max: 200 - min: 1 - status: - docs: Filter by transcript status - type: optional - throttled_only: - default: false - docs: Only get throttled transcripts, overrides the status filter - type: optional - response: - docs: > - A list of transcripts. Transcripts are sorted from newest to oldest. - The previous URL always points to a page with older transcripts. - status-code: 200 - type: TranscriptList - source: - openapi: ../openapi.yml - submit: - auth: true - display-name: Transcribe audio - docs: > - To use our EU server for transcription, replace - `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Create a transcript from a media file that is accessible via a URL. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - examples: - - request: - audio_end_at: 280 - audio_start_from: 10 - audio_url: https://assembly.ai/wildfires.mp3 - auto_chapters: true - auto_highlights: true - boost_param: high - content_safety: true - custom_spelling: - - from: - - dicarlo - to: Decarlo - custom_topics: true - disfluencies: false - dual_channel: false - entity_detection: true - filter_profanity: true - format_text: true - iab_categories: true - language_code: en_us - language_confidence_threshold: 0.7 - language_detection: true - multichannel: true - punctuate: true - redact_pii: true - redact_pii_audio: true - redact_pii_audio_quality: mp3 - redact_pii_policies: - - us_social_security_number - - credit_card_number - redact_pii_sub: hash - sentiment_analysis: true - speaker_labels: true - speakers_expected: 2 - speech_threshold: 0.5 - summarization: true - summary_model: informative - summary_type: bullets - topics: - - topics - webhook_auth_header_name: webhook-secret - webhook_auth_header_value: webhook-secret-value - webhook_url: https://your-webhook-url/path - word_boost: - - aws - - azure - - google cloud - response: - body: - acoustic_model: assemblyai_default - audio_channels: 1 - audio_duration: 281 - audio_end_at: 280 - audio_start_from: 10 - audio_url: https://assembly.ai/wildfires.mp3 - auto_chapters: true - auto_highlights: true - auto_highlights_result: - results: - - count: 1 - rank: 0.08 - text: air quality alerts - timestamps: - - end: 5114 - start: 3978 - - count: 1 - rank: 0.08 - text: wide ranging air quality consequences - timestamps: - - end: 238694 - start: 235388 - - count: 1 - rank: 0.07 - text: more wildfires - timestamps: - - end: 232354 - start: 230972 - - count: 1 - rank: 0.07 - text: air pollution - timestamps: - - end: 156910 - start: 156004 - - count: 3 - rank: 0.07 - text: weather systems - timestamps: - - end: 47958 - start: 47344 - - end: 205818 - start: 205268 - - end: 213434 - start: 211588 - - count: 2 - rank: 0.06 - text: high levels - timestamps: - - end: 121646 - start: 121128 - - end: 155866 - start: 155412 - - count: 1 - rank: 0.06 - text: health conditions - timestamps: - - end: 152666 - start: 152138 - - count: 2 - rank: 0.06 - text: Peter de Carlo - timestamps: - - end: 19930 - start: 18948 - - end: 269194 - start: 268298 - - count: 1 - rank: 0.06 - text: New York City - timestamps: - - end: 126274 - start: 125768 - - count: 1 - rank: 0.05 - text: respiratory conditions - timestamps: - - end: 153786 - start: 152964 - - count: 3 - rank: 0.05 - text: New York - timestamps: - - end: 126034 - start: 125768 - - end: 171938 - start: 171448 - - end: 176322 - start: 176008 - - count: 3 - rank: 0.05 - text: climate change - timestamps: - - end: 230230 - start: 229548 - - end: 245162 - start: 244576 - - end: 263950 - start: 263348 - - count: 1 - rank: 0.05 - text: Johns Hopkins University Varsity - timestamps: - - end: 25490 - start: 23972 - - count: 1 - rank: 0.05 - text: heart conditions - timestamps: - - end: 154506 - start: 153988 - - count: 1 - rank: 0.05 - text: air quality warnings - timestamps: - - end: 13434 - start: 12308 - status: success - boost_param: high - chapters: - - end: 28840 - gist: Smoggy air quality alerts across US - headline: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts across US - start: 250 - summary: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. In some places, - the air quality warnings include the warning to stay inside. - - end: 280340 - gist: >- - What is it about the conditions right now that have caused - this round - headline: >- - High particulate matter in wildfire smoke can lead to - serious health problems - start: 29610 - summary: >- - Air pollution levels in Baltimore are considered unhealthy. - Exposure to high levels can lead to a host of health - problems. With climate change, we are seeing more wildfires. - Will we be seeing more of these kinds of wide ranging air - quality consequences? - confidence: 0.9404651451800253 - content_safety: true - content_safety_labels: - results: - - labels: - - confidence: 0.8142836093902588 - label: disasters - severity: 0.4093044400215149 - sentences_idx_end: 5 - sentences_idx_start: 0 - text: >- - Smoke from hundreds of wildfires in Canada is triggering - air quality alerts throughout the US. Skylines from Maine - to Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to - stay inside. We wanted to better understand what's - happening here and why, so we called Peter de Carlo, an - associate professor in the Department of Environmental - Health and Engineering at Johns Hopkins University - Varsity. Good morning, professor. Good morning. - timestamp: - end: 28840 - start: 250 - severity_score_summary: - disasters: - high: 0 - low: 0.5733263024656846 - medium: 0.42667369753431533 - health_issues: - high: 0.32122030095136983 - low: 0.22863814977924785 - medium: 0.45014154926938227 - status: success - summary: - disasters: 0.9940800441842205 - health_issues: 0.9216489289040967 - custom_topics: true - disfluencies: false - dual_channel: false - entities: - - end: 3130 - entity_type: location - start: 2548 - text: Canada - - end: 6382 - entity_type: location - start: 5498 - text: the US - - end: 7914 - entity_type: location - start: 7492 - text: Maine - - end: 8634 - entity_type: location - start: 8212 - text: Maryland - - end: 9578 - entity_type: location - start: 8932 - text: Minnesota - - end: 19930 - entity_type: person_name - start: 18948 - text: Peter de Carlo - - end: 21194 - entity_type: occupation - start: 20292 - text: associate professor - - end: 23706 - entity_type: organization - start: 21508 - text: Department of Environmental Health and Engineering - - end: 25490 - entity_type: organization - start: 23972 - text: Johns Hopkins University Varsity - - end: 26950 - entity_type: occupation - start: 26076 - text: professor - - end: 45898 - entity_type: location - start: 45184 - text: the US - - end: 50086 - entity_type: nationality - start: 49728 - text: Canadian - entity_detection: true - error: error - filter_profanity: true - format_text: true - iab_categories: true - iab_categories_result: - results: - - labels: - - label: Home&Garden>IndoorEnvironmentalQuality - relevance: 0.988274097442627 - - label: NewsAndPolitics>Weather - relevance: 0.5821335911750793 - - label: >- - MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth - relevance: 0.0042327106930315495 - - label: NewsAndPolitics>Disasters - relevance: 0.0033971222583204508 - - label: BusinessAndFinance>Business>GreenSolutions - relevance: 0.002469958271831274 - - label: MedicalHealth>DiseasesAndConditions>Cancer - relevance: 0.0014376690378412604 - - label: Science>Environment - relevance: 0.0014294233405962586 - - label: Travel>TravelLocations>PolarTravel - relevance: 0.001234519761055708 - - label: MedicalHealth>DiseasesAndConditions>ColdAndFlu - relevance: 0.0010231725173071027 - - label: BusinessAndFinance>Industries>PowerAndEnergyIndustry - relevance: 0.0007445293595083058 - text: >- - Smoke from hundreds of wildfires in Canada is triggering - air quality alerts throughout the US. Skylines from Maine - to Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to - stay inside. We wanted to better understand what's - happening here and why, so we called Peter de Carlo, an - associate professor in the Department of Environmental - Health and Engineering at Johns Hopkins University - Varsity. Good morning, professor. Good morning. - timestamp: - end: 28840 - start: 250 - status: success - summary: - BusinessAndFinance>Business>GreenSolutions: 0.06348437070846558 - BusinessAndFinance>Industries>EnvironmentalServicesIndustry: 0.14393523335456848 - BusinessAndFinance>Industries>PowerAndEnergyIndustry: 0.0012570273829624057 - HealthyLiving: 0.008222488686442375 - HealthyLiving>Wellness>SmokingCessation: 0.001540527562610805 - Home&Garden>IndoorEnvironmentalQuality: 0.9043831825256348 - MedicalHealth>DiseasesAndConditions>Allergies: 0.0010148967849090695 - MedicalHealth>DiseasesAndConditions>Cancer: 0.001097781932912767 - MedicalHealth>DiseasesAndConditions>ColdAndFlu: 0.0022315620444715023 - MedicalHealth>DiseasesAndConditions>HeartAndCardiovascularDiseases: 0.00213034451007843 - MedicalHealth>DiseasesAndConditions>Injuries: 0.0013950627762824297 - MedicalHealth>DiseasesAndConditions>Injuries>FirstAid: 0.0004885646631009877 - MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth: 0.11401086300611496 - MedicalHealth>DiseasesAndConditions>MentalHealth: 0.000717321818228811 - NewsAndPolitics>Disasters: 0.05041387677192688 - NewsAndPolitics>Weather: 1 - Science>Environment: 0.16117265820503235 - Style&Fashion>PersonalCare>DeodorantAndAntiperspirant: 0.0006022014422342181 - Technology&Computing>Computing>ComputerNetworking: 0.0005461975233629346 - Travel>TravelLocations>PolarTravel: 0.01308488193899393 - id: 9ea68fd3-f953-42c1-9742-976c447fb463 - keyterms_prompt: - - keyterms_prompt - language_code: en_us - language_confidence: 0.9959 - language_confidence_threshold: 0.7 - language_detection: true - language_model: assemblyai_default - multichannel: false - prompt: prompt - punctuate: true - redact_pii: true - redact_pii_audio: true - redact_pii_audio_quality: mp3 - redact_pii_policies: - - us_social_security_number - - credit_card_number - redact_pii_sub: hash - sentiment_analysis: true - speaker_labels: true - speakers_expected: 2 - speech_model: best - speech_threshold: 0.5 - speed_boost: true - status: completed - summarization: true - summary: >- - - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. In some places, the - air quality warnings include the warning to stay inside.\n- Air - pollution levels in Baltimore are considered unhealthy. Exposure - to high levels can lead to a host of health problems. With - climate change, we are seeing more wildfires. Will we be seeing - more of these kinds of wide ranging air quality consequences? - summary_model: informative - summary_type: bullets - text: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. And in some places, - the air quality warnings include the warning to stay inside. We - wanted to better understand what's happening here and why, so we - called Peter de Carlo, an associate professor in the Department - of Environmental Health and Engineering at Johns Hopkins - University Varsity. Good morning, professor. Good morning. What - is it about the conditions right now that have caused this round - of wildfires to affect so many people so far away? Well, there's - a couple of things. The season has been pretty dry already. And - then the fact that we're getting hit in the US. Is because - there's a couple of weather systems that are essentially - channeling the smoke from those Canadian wildfires through - Pennsylvania into the Mid Atlantic and the Northeast and kind of - just dropping the smoke there. So what is it in this haze that - makes it harmful? And I'm assuming it is harmful. It is. The - levels outside right now in Baltimore are considered unhealthy. - And most of that is due to what's called particulate matter, - which are tiny particles, microscopic smaller than the width of - your hair that can get into your lungs and impact your - respiratory system, your cardiovascular system, and even your - neurological your brain. What makes this particularly harmful? - Is it the volume of particulant? Is it something in particular? - What is it exactly? Can you just drill down on that a little bit - more? Yeah. So the concentration of particulate matter I was - looking at some of the monitors that we have was reaching levels - of what are, in science, big 150 micrograms per meter cubed, - which is more than ten times what the annual average should be - and about four times higher than what you're supposed to have on - a 24 hours average. And so the concentrations of these particles - in the air are just much, much higher than we typically see. And - exposure to those high levels can lead to a host of health - problems. And who is most vulnerable? I noticed that in New York - City, for example, they're canceling outdoor activities. And so - here it is in the early days of summer, and they have to keep - all the kids inside. So who tends to be vulnerable in a - situation like this? It's the youngest. So children, obviously, - whose bodies are still developing. The elderly, who are their - bodies are more in decline and they're more susceptible to the - health impacts of breathing, the poor air quality. And then - people who have preexisting health conditions, people with - respiratory conditions or heart conditions can be triggered by - high levels of air pollution. Could this get worse? That's a - good question. In some areas, it's much worse than others. And - it just depends on kind of where the smoke is concentrated. I - think New York has some of the higher concentrations right now, - but that's going to change as that air moves away from the New - York area. But over the course of the next few days, we will see - different areas being hit at different times with the highest - concentrations. I was going to ask you about more fires start - burning. I don't expect the concentrations to go up too much - higher. I was going to ask you how and you started to answer - this, but how much longer could this last? Or forgive me if I'm - asking you to speculate, but what do you think? Well, I think - the fires are going to burn for a little bit longer, but the key - for us in the US. Is the weather system changing. And so right - now, it's kind of the weather systems that are pulling that air - into our mid Atlantic and Northeast region. As those weather - systems change and shift, we'll see that smoke going elsewhere - and not impact us in this region as much. And so I think that's - going to be the defining factor. And I think the next couple of - days we're going to see a shift in that weather pattern and - start to push the smoke away from where we are. And finally, - with the impacts of climate change, we are seeing more - wildfires. Will we be seeing more of these kinds of wide ranging - air quality consequences or circumstances? I mean, that is one - of the predictions for climate change. Looking into the future, - the fire season is starting earlier and lasting longer, and - we're seeing more frequent fires. So, yeah, this is probably - something that we'll be seeing more frequently. This tends to be - much more of an issue in the Western US. So the eastern US. - Getting hit right now is a little bit new. But yeah, I think - with climate change moving forward, this is something that is - going to happen more frequently. That's Peter De Carlo, - associate professor in the Department of Environmental Health - and Engineering at Johns Hopkins University. Sergeant Carlo, - thanks so much for joining us and sharing this expertise with - us. Thank you for having me. - topics: - - topics - utterances: - - channel: channel - confidence: 0.9359033333333334 - end: 26950 - speaker: A - start: 250 - text: >- - Smoke from hundreds of wildfires in Canada is triggering air - quality alerts throughout the US. Skylines from Maine to - Maryland to Minnesota are gray and smoggy. And in some - places, the air quality warnings include the warning to stay - inside. We wanted to better understand what's happening here - and why, so we called Peter de Carlo, an associate professor - in the Department of Environmental Health and Engineering at - Johns Hopkins University Varsity. Good morning, professor. - words: - - confidence: 0.97503 - end: 650 - speaker: A - start: 250 - text: Smoke - - confidence: 0.99999 - end: 1022 - speaker: A - start: 730 - text: from - - confidence: 0.99843 - end: 1418 - speaker: A - start: 1076 - text: hundreds - - confidence: 0.85 - end: 1614 - speaker: A - start: 1434 - text: of - - confidence: 0.89657 - end: 2346 - speaker: A - start: 1652 - text: wildfires - - confidence: 0.99994 - end: 2526 - speaker: A - start: 2378 - text: in - - confidence: 0.93864 - end: 3130 - speaker: A - start: 2548 - text: Canada - - confidence: 0.999 - end: 3454 - speaker: A - start: 3210 - text: is - - confidence: 0.75366 - end: 3946 - speaker: A - start: 3492 - text: triggering - - confidence: 1 - end: 4174 - speaker: A - start: 3978 - text: air - - confidence: 0.87745 - end: 4558 - speaker: A - start: 4212 - text: quality - - confidence: 0.94739 - end: 5114 - speaker: A - start: 4644 - text: alerts - - confidence: 0.99726 - end: 5466 - speaker: A - start: 5162 - text: throughout - - confidence: 0.79 - end: 5694 - speaker: A - start: 5498 - text: the - - confidence: 0.88 - end: 6382 - speaker: A - start: 5732 - text: US. - webhook_auth: true - webhook_auth_header_name: webhook-secret - webhook_status_code: 200 - webhook_url: https://your-webhook-url.tld/path - word_boost: - - aws - - azure - - google cloud - words: - - channel: channel - confidence: 0.97465 - end: 650 - speaker: speaker - start: 250 - text: Smoke - - channel: channel - confidence: 0.99999 - end: 1022 - speaker: speaker - start: 730 - text: from - - channel: channel - confidence: 0.99844 - end: 1418 - speaker: speaker - start: 1076 - text: hundreds - - channel: channel - confidence: 0.84 - end: 1614 - speaker: speaker - start: 1434 - text: of - - channel: channel - confidence: 0.89572 - end: 2346 - speaker: speaker - start: 1652 - text: wildfires - - channel: channel - confidence: 0.99994 - end: 2526 - speaker: speaker - start: 2378 - text: in - - channel: channel - confidence: 0.93953 - end: 3130 - speaker: speaker - start: 2548 - text: Canada - - channel: channel - confidence: 0.999 - end: 3454 - speaker: speaker - start: 3210 - text: is - - channel: channel - confidence: 0.74794 - end: 3946 - speaker: speaker - start: 3492 - text: triggering - - channel: channel - confidence: 1 - end: 4174 - speaker: speaker - start: 3978 - text: air - - channel: channel - confidence: 0.88077 - end: 4558 - speaker: speaker - start: 4212 - text: quality - - channel: channel - confidence: 0.94814 - end: 5114 - speaker: speaker - start: 4644 - text: alerts - - channel: channel - confidence: 0.99726 - end: 5466 - speaker: speaker - start: 5162 - text: throughout - - channel: channel - confidence: 0.79 - end: 5694 - speaker: speaker - start: 5498 - text: the - - channel: channel - confidence: 0.89 - end: 6382 - speaker: speaker - start: 5732 - text: US. - method: POST - path: /v2/transcript - request: - body: - extends: - - TranscriptOptionalParams - properties: - audio_url: - docs: The URL of the audio or video file to transcribe. - type: string - content-type: application/json - name: TranscriptParams - response: - docs: Transcript created and queued for processing - status-code: 200 - type: Transcript - source: - openapi: ../openapi.yml - wordSearch: - auth: true - display-name: Search words in transcript - docs: > - To search through a transcription created on our EU server, - replace `api.assemblyai.com` with `api.eu.assemblyai.com`. - - Search through the transcript for keywords. You can search for - individual words, numbers, or phrases containing up to five words or - numbers. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - - root.ServiceUnavailableError - - root.GatewayTimeoutError - method: GET - path: /v2/transcript/{transcript_id}/word-search - path-parameters: - transcript_id: - docs: ID of the transcript - type: string - request: - name: WordSearchParams - query-parameters: - words: - allow-multiple: true - docs: Keywords to search for - type: optional - response: - docs: Word search response - status-code: 200 - type: WordSearchResponse - source: - openapi: ../openapi.yml - source: - openapi: ../openapi.yml diff --git a/fern/generators.yml b/fern/generators.yml index 1500c1c5..c5aa6352 100644 --- a/fern/generators.yml +++ b/fern/generators.yml @@ -9,63 +9,3 @@ api: overrides: ./usm-streaming-overrides.yml - openapi: ../streaming-token.yml - openapi: ../llm-gateway.yml -groups: - postman: - generators: - - name: fernapi/fern-postman - version: 0.4.0 - output: - location: postman - api-key: ${POSTMAN_API_KEY} - workspace-id: 07e228e5-3f91-4223-8e27-bbfe4a81a601 - collection-id: 30498076-4862f578-51cd-41c2-99c4-1063a7c15bac - ruby-sdk: - generators: - - name: fernapi/fern-ruby-sdk - version: 0.6.3 - github: - repository: AssemblyAI/assemblyai-ruby-sdk - mode: pull-request - output: - location: rubygems - package-name: assemblyai - api-key: ${RUBYGEMS_API_KEY} - config: - clientClassName: AssemblyAI - smart-casing: true - csharp-sdk: - generators: - - name: fernapi/fern-csharp-sdk - version: 1.9.11 - output: - location: nuget - package-name: AssemblyAI - api-key: ${NUGET_API_KEY} - github: - repository: AssemblyAI/assemblyai-csharp-sdk - mode: pull-request - config: - namespace: AssemblyAI - explicit-namespaces: true - client-class-name: AssemblyAIClient - base-api-exception-class-name: ApiException - base-exception-class-name: AssemblyAIException - generate-error-types: false - java-sdk: - generators: - - name: fernapi/fern-java-sdk - version: 2.2.0 - output: - location: maven - coordinate: com.assemblyai:assemblyai-java - username: ${MAVEN_USERNAME} - password: ${MAVEN_PASSWORD} - github: - repository: AssemblyAI/assemblyai-java-sdk - mode: pull-request - config: - enable-forward-compatible-enums: true - client-class-name: AssemblyAI - custom-dependencies: - - "implementation javax.websocket:javax.websocket-api:1.1" - smart-casing: true diff --git a/openapi.yml b/openapi.yml index 2efd8e3d..bdf2653a 100644 --- a/openapi.yml +++ b/openapi.yml @@ -42,8 +42,6 @@ paths: To upload a media file to our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. Upload a media file to AssemblyAI's servers. operationId: uploadFile - x-fern-sdk-group-name: files - x-fern-sdk-method-name: upload requestBody: content: application/octet-stream: @@ -82,8 +80,6 @@ paths: To use our EU server for transcription, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. Create a transcript from a media file that is accessible via a URL. operationId: createTranscript - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: submit x-fern-request-name: TranscriptParams requestBody: description: Params to create a transcript @@ -166,9 +162,6 @@ paths: tags: - transcript summary: List transcripts - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: list - x-fern-request-name: ListTranscriptParams operationId: listTranscripts description: | To retrieve your transcriptions on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. @@ -249,8 +242,7 @@ paths: - transcript summary: Get transcript operationId: getTranscript - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: get + x-fern-request-name: GetTranscriptParams description: | To retrieve your transcriptions on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. @@ -308,8 +300,6 @@ paths: To delete your transcriptions on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. Remove the data from the transcript and mark it as deleted. operationId: deleteTranscript - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: delete parameters: - name: transcript_id x-label: Transcript ID @@ -349,8 +339,6 @@ paths: To retrieve your transcriptions on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. Export your transcript in SRT or VTT format to use with a video player for subtitles and closed captions. operationId: getSubtitles - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: getSubtitles x-fern-request-name: GetSubtitlesParams parameters: - name: transcript_id @@ -415,8 +403,7 @@ paths: - transcript summary: Get sentences in transcript operationId: getTranscriptSentences - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: getSentences + x-fern-request-name: GetSentencesParams description: | To retrieve your transcriptions on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. @@ -457,8 +444,7 @@ paths: - transcript summary: Get paragraphs in transcript operationId: getTranscriptParagraphs - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: getParagraphs + x-fern-request-name: GetParagraphsParams description: | To retrieve your transcriptions on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. @@ -502,8 +488,6 @@ paths: To search through a transcription created on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. Search through the transcript for keywords. You can search for individual words, numbers, or phrases containing up to five words or numbers. operationId: wordSearch - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: wordSearch x-fern-request-name: WordSearchParams parameters: - name: transcript_id @@ -557,8 +541,6 @@ paths: To retrieve the redacted audio on the EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com` in the `GET` request above. Retrieve the redacted audio object containing the status and URL to the redacted audio. operationId: getRedactedAudio - x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: getRedactedAudio x-fern-request-name: GetRedactedAudioParams parameters: - name: transcript_id @@ -601,8 +583,8 @@ paths: # Any usage associated with a temporary token will be attributed to the API key that generated it. # Create a temporary authentication token for Streaming Speech-to-Text # operationId: createTemporaryToken - # x-fern-sdk-group-name: realtime - # x-fern-sdk-method-name: createTemporaryToken + # + # # x-fern-request-name: CreateRealtimeTemporaryTokenParams # requestBody: # description: Params to create a temporary authentication token @@ -642,8 +624,8 @@ paths: # To use our EU server with LeMUR, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. # Use the LeMUR task endpoint to input your own LLM prompt. # operationId: lemurTask - # x-fern-sdk-group-name: lemur - # x-fern-sdk-method-name: task + # + # # x-fern-request-name: LemurTaskParams # requestBody: # description: Params to run the task @@ -700,8 +682,8 @@ paths: # Custom Summary allows you to distill a piece of audio into a few impactful sentences. # You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language. # operationId: lemurSummary - # x-fern-sdk-group-name: lemur - # x-fern-sdk-method-name: summary + # + # # x-fern-request-name: LemurSummaryParams # requestBody: # description: Params to generate the summary @@ -758,8 +740,8 @@ paths: # Question & Answer allows you to ask free-form questions about a single transcript or a group of transcripts. # The questions can be any whose answers you find useful, such as judging whether a caller is likely to become a customer or whether all items on a meeting's agenda were covered. # operationId: lemurQuestionAnswer - # x-fern-sdk-group-name: lemur - # x-fern-sdk-method-name: questionAnswer + # + # # x-fern-request-name: LemurQuestionAnswerParams # requestBody: # description: Params to ask questions about the transcripts @@ -813,8 +795,8 @@ paths: # summary: Extract action items # operationId: lemurActionItems # x-label: Extract action items using LeMUR - # x-fern-sdk-group-name: lemur - # x-fern-sdk-method-name: actionItems + # + # # x-fern-request-name: LemurActionItemsParams # description: Use LeMUR to generate a list of action items from a transcript # requestBody: @@ -871,8 +853,8 @@ paths: # To use our EU server with LeMUR, replace `api.assemblyai.com` with `api.eu.assemblyai.com`. # Retrieve a LeMUR response that was previously generated. # operationId: getLemurResponse - # x-fern-sdk-group-name: lemur - # x-fern-sdk-method-name: getResponse + # + # # x-fern-request-name: GetLemurResponseParams # parameters: # - name: request_id @@ -914,8 +896,8 @@ paths: # Delete the data for a previously submitted LeMUR request. # The LLM response data, as well as any context provided in the original request will be removed. # operationId: purgeLemurRequestData - # x-fern-sdk-group-name: lemur - # x-fern-sdk-method-name: purgeRequestData + # + # # x-fern-request-name: PurgeLemurRequestDataParams # parameters: # - name: request_id @@ -994,7 +976,6 @@ components: TranscriptWebhookNotification: description: The notifications sent to the webhook URL. x-label: Transcript webhook notification - x-fern-sdk-group-name: transcripts type: object additionalProperties: false oneOf: @@ -1004,7 +985,6 @@ components: TranscriptReadyNotification: description: The notification when the transcript status is completed or error. x-label: Transcript ready notification - x-fern-sdk-group-name: transcripts type: object additionalProperties: false properties: @@ -1029,7 +1009,6 @@ components: RedactedAudioNotification: description: The notification when the redacted audio is ready. x-label: Redacted audio notification - x-fern-sdk-group-name: transcripts type: object additionalProperties: false allOf: @@ -1039,7 +1018,6 @@ components: type: object additionalProperties: false x-label: Redacted audio response - x-fern-sdk-group-name: transcripts required: - status - redacted_audio_url @@ -1062,7 +1040,7 @@ components: RedactedAudioStatus: x-label: Redacted audio status description: The status of the redacted audio - x-fern-sdk-group-name: transcripts + type: string enum: - redacted_audio_ready @@ -1073,7 +1051,7 @@ components: SubtitleFormat: x-label: Subtitle format description: Format of the subtitles - x-fern-sdk-group-name: transcripts + type: string enum: - srt @@ -1087,7 +1065,7 @@ components: WordSearchResponse: x-label: Word search response type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false properties: id: @@ -1148,7 +1126,7 @@ components: WordSearchMatch: type: object x-label: Word search match - x-fern-sdk-group-name: transcripts + additionalProperties: false properties: text: @@ -1197,7 +1175,7 @@ components: WordSearchTimestamp: x-label: Word search timestamp description: An array of timestamps structured as [`start_time`, `end_time`] in milliseconds - x-fern-sdk-group-name: transcripts + type: array items: x-label: Timestamp @@ -1208,7 +1186,7 @@ components: Timestamp: x-label: Timestamp description: Timestamp containing a start and end property in milliseconds - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false properties: @@ -1229,7 +1207,7 @@ components: TranscriptOptionalParams: x-label: Optional transcript parameters description: The parameters for creating a transcript - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false properties: @@ -1645,7 +1623,7 @@ components: TranscriptParams: x-label: Transcript parameters description: The parameters for creating a transcript - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false allOf: @@ -1711,7 +1689,7 @@ components: type: string x-label: Summary model description: The model to summarize the transcript - x-fern-sdk-group-name: transcripts + enum: - informative - conversational @@ -1728,7 +1706,7 @@ components: type: string x-label: Summary type description: The type of summary - x-fern-sdk-group-name: transcripts + enum: - bullets - bullets_verbose @@ -1751,7 +1729,7 @@ components: type: string x-label: Word boost level description: How much to boost specified words - x-fern-sdk-group-name: transcripts + enum: - low - default @@ -1767,7 +1745,7 @@ components: TranscriptCustomSpelling: x-label: Custom spelling description: Object containing words or phrases to replace, and the word or phrase to replace with - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false properties: @@ -1789,7 +1767,7 @@ components: TranscriptUtterance: type: object x-label: Utterance - x-fern-sdk-group-name: transcripts + additionalProperties: false properties: confidence: @@ -1953,7 +1931,7 @@ components: SubstitutionPolicy: x-label: Redact PII substitution type: string - x-fern-sdk-group-name: transcripts + description: The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. enum: - entity_name @@ -1968,7 +1946,7 @@ components: x-label: Redact PII audio quality type: string description: Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. - x-fern-sdk-group-name: transcripts + enum: - mp3 - wav @@ -1992,7 +1970,7 @@ components: PiiPolicy: x-label: PII policy description: The type of PII to redact - x-fern-sdk-group-name: transcripts + type: string enum: - account_number @@ -2259,7 +2237,7 @@ components: x-label: Speech model type: string description: The speech model to use for the transcription. - x-fern-sdk-group-name: transcripts + enum: - best - slam-1 @@ -2286,7 +2264,7 @@ components: description: | The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages). The default value is 'en_us'. - x-fern-sdk-group-name: transcripts + enum: - en - en_au @@ -2600,7 +2578,7 @@ components: x-label: Status type: string description: The status of your transcript. Possible values are queued, processing, completed, or error. - x-fern-sdk-group-name: transcripts + enum: - queued - processing @@ -2629,7 +2607,7 @@ components: x-label: Status type: string description: The status of the transcript. Either completed or error. - x-fern-sdk-group-name: transcripts + enum: - completed - error @@ -2648,7 +2626,7 @@ components: x-label: Transcript description: A transcript object type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false properties: id: @@ -3763,7 +3741,7 @@ components: description: | The result of the Topic Detection model, if it is enabled. See [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information. - x-fern-sdk-group-name: transcripts + type: object required: - status @@ -3873,7 +3851,7 @@ components: description: | An array of results for the Content Moderation model, if it is enabled. See [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information. - x-fern-sdk-group-name: transcripts + type: object required: - status @@ -3953,7 +3931,7 @@ components: Chapter: x-label: Chapter description: Chapter of the audio file - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false required: @@ -3995,7 +3973,7 @@ components: Entity: x-label: Entity description: A detected entity - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false required: @@ -4026,7 +4004,7 @@ components: EntityType: x-label: Entity type description: The type of entity for the detected entity - x-fern-sdk-group-name: transcripts + type: string enum: - account_number @@ -4292,7 +4270,7 @@ components: SentimentAnalysisResult: x-label: Sentiment Analysis result description: The result of the Sentiment Analysis model - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false required: @@ -4346,7 +4324,7 @@ components: Sentiment: x-label: Sentiment - x-fern-sdk-group-name: transcripts + enum: - POSITIVE - NEUTRAL @@ -4362,7 +4340,7 @@ components: TopicDetectionResult: x-label: Topic detection result description: The result of the topic detection model - x-fern-sdk-group-name: transcripts + type: object additionalProperties: false required: @@ -4450,7 +4428,7 @@ components: ContentSafetyLabel: x-label: Content Moderation label type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - label @@ -4485,7 +4463,7 @@ components: ContentSafetyLabelResult: x-label: Content Moderation label result type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - text @@ -4536,7 +4514,7 @@ components: SeverityScoreSummary: x-label: Severity score summary type: object - x-fern-sdk-group-name: transcripts + required: - low - medium @@ -4568,7 +4546,7 @@ components: description: | An array of results for the Key Phrases model, if it is enabled. See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information. - x-fern-sdk-group-name: transcripts + type: object required: - status @@ -4709,7 +4687,7 @@ components: AutoHighlightResult: x-label: Auto highlight result type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - count @@ -4750,7 +4728,7 @@ components: TranscriptWord: x-label: Word type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - confidence @@ -4799,7 +4777,7 @@ components: TranscriptSentence: x-label: Sentence type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - text @@ -4886,7 +4864,7 @@ components: SentencesResponse: x-label: Sentences response type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - id @@ -5020,7 +4998,7 @@ components: TranscriptParagraph: x-label: Paragraph type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - text @@ -5097,7 +5075,7 @@ components: ParagraphsResponse: x-label: Paragraphs response type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - id @@ -5209,7 +5187,7 @@ components: x-label: Page details description: Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts. type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - limit @@ -5253,7 +5231,7 @@ components: ListTranscriptParams: x-label: List transcript parameters type: object - x-fern-sdk-group-name: transcripts + # Don't use this type in Fern SDKs as it is already generated from the endpoint parameters x-fern-ignore: true additionalProperties: false @@ -5302,7 +5280,7 @@ components: TranscriptListItem: x-label: Transcript list item type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - id @@ -5365,7 +5343,7 @@ components: x-label: Transcript list description: A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts. type: object - x-fern-sdk-group-name: transcripts + additionalProperties: false required: - page_details @@ -5427,7 +5405,7 @@ components: UploadedFile: x-label: Uploaded file type: object - x-fern-sdk-group-name: files + additionalProperties: false required: - upload_url @@ -5446,7 +5424,7 @@ components: CreateRealtimeTemporaryTokenParams: x-label: Create Streaming STT temporary token parameters type: object - x-fern-sdk-group-name: realtime + additionalProperties: false properties: expires_in: @@ -5460,7 +5438,7 @@ components: RealtimeTemporaryTokenResponse: x-label: Streaming STT temporary token response type: object - x-fern-sdk-group-name: realtime + additionalProperties: false required: - token @@ -5476,7 +5454,7 @@ components: AudioIntelligenceModelStatus: x-label: Audio intelligence model status - x-fern-sdk-group-name: transcripts + type: string description: Either success, or unavailable in the rare case that the model failed enum: @@ -5490,7 +5468,7 @@ components: PurgeLemurRequestDataResponse: x-label: Purge LeMUR request data response - x-fern-sdk-group-name: lemur + type: object additionalProperties: false properties: @@ -5522,7 +5500,7 @@ components: # This is to have a type that can be used to get the ID so it can be deleted LemurBaseResponse: x-label: LeMUR base response - x-fern-sdk-group-name: lemur + type: object additionalProperties: false properties: @@ -5544,7 +5522,7 @@ components: LemurStringResponse: x-label: LeMUR string response - x-fern-sdk-group-name: lemur + type: object allOf: - type: object @@ -5572,7 +5550,7 @@ components: LemurTaskResponse: x-label: LeMUR task response - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurStringResponse" @@ -5592,7 +5570,7 @@ components: LemurSummaryResponse: x-label: LeMUR summary response - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurStringResponse" @@ -5612,7 +5590,7 @@ components: LemurActionItemsResponse: x-label: LeMUR action items response - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurStringResponse" @@ -5642,7 +5620,7 @@ components: LemurQuestionAnswerResponse: x-label: LeMUR question & answer response - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurBaseResponse" @@ -5673,7 +5651,7 @@ components: LemurQuestionAnswer: x-label: Question & answer - x-fern-sdk-group-name: lemur + type: object description: An answer generated by LeMUR and its question additionalProperties: false @@ -5691,7 +5669,7 @@ components: LemurResponse: x-label: LeMUR response - x-fern-sdk-group-name: lemur + type: object oneOf: - $ref: "#/components/schemas/LemurStringResponse" @@ -5699,7 +5677,7 @@ components: LemurBaseParams: x-label: LeMUR base parameters - x-fern-sdk-group-name: lemur + type: object additionalProperties: false required: [final_model] @@ -5768,7 +5746,7 @@ components: LemurTaskParams: x-label: LeMUR task parameters - x-fern-sdk-group-name: lemur + type: object allOf: - type: object @@ -5829,7 +5807,7 @@ components: LemurSummaryParams: x-label: LeMUR summary parameters - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurBaseParams" @@ -5852,7 +5830,7 @@ components: LemurQuestionAnswerParams: x-label: LeMUR question & answer parameters - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurBaseParams" @@ -5890,7 +5868,7 @@ components: LemurQuestion: x-label: LeMUR question - x-fern-sdk-group-name: lemur + type: object additionalProperties: false required: [question] @@ -5927,7 +5905,7 @@ components: LemurActionItemsParams: x-label: LeMUR action items parameters - x-fern-sdk-group-name: lemur + type: object allOf: - $ref: "#/components/schemas/LemurBaseParams" @@ -5953,7 +5931,7 @@ components: LemurModel: x-label: LeMUR model - x-fern-sdk-group-name: lemur + type: string description: | The model that is used for the final prompt after compression is performed. @@ -6036,7 +6014,7 @@ components: LemurUsage: x-label: Usage description: The usage numbers for the LeMUR request - x-fern-sdk-group-name: lemur + type: object additionalProperties: false required: From 3e647399ca567b984e81abcae13ad51c98895463 Mon Sep 17 00:00:00 2001 From: Martin Schweiger Date: Tue, 25 Nov 2025 15:20:03 +0800 Subject: [PATCH 2/2] openapi schema changes --- openapi.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/openapi.yml b/openapi.yml index bdf2653a..777a2620 100644 --- a/openapi.yml +++ b/openapi.yml @@ -1250,9 +1250,9 @@ components: x-label: Minimum speakers expected description: List of languages expected in the audio file. Defaults to `["all"]` when unspecified. type: array - objects: - x-label: language - type: string + items: + x-label: Language code + $ref: "#/components/schemas/TranscriptLanguageCode" fallback_language: x-label: Fallback language description: | @@ -1269,7 +1269,7 @@ components: x-label: Code switching confidence threshold description: | The confidence threshold for code switching detection. If the code switching confidence is below this threshold, the transcript will be processed in the language with the highest `language_detection_confidence` score. - type: float + type: number minimum: 0 maximum: 1 default: 0.3 @@ -2682,9 +2682,9 @@ components: x-label: Minimum speakers expected description: List of languages expected in the audio file. Defaults to `["all"]` when unspecified. type: array - objects: - x-label: language - type: string + items: + x-label: Language code + $ref: "#/components/schemas/TranscriptLanguageCode" fallback_language: x-label: Fallback language description: | @@ -2701,7 +2701,7 @@ components: x-label: Code switching confidence threshold description: | The confidence threshold for code switching detection. If the code switching confidence is below this threshold, the transcript will be processed in the language with the highest `language_detection_confidence` score. - type: float + type: number minimum: 0 maximum: 1 default: 0.3