diff --git a/api-reference/v2/live/callback/post-chapterization.mdx b/api-reference/v2/live/callback/post-chapterization.mdx index 7b843ff..2d83ac0 100644 --- a/api-reference/v2/live/callback/post-chapterization.mdx +++ b/api-reference/v2/live/callback/post-chapterization.mdx @@ -1,5 +1,5 @@ --- -title: Chapterization -description: Payload definition for the callback event `live.post_chapterization`. +title: Chapterization (deprecated) +description: "**[Deprecated]** Chapterization no longer returns results. Use Audio-to-LLM on pre-recorded transcription instead." openapi-schema: CallbackLivePostChapterizationMessage ---- \ No newline at end of file +--- diff --git a/api-reference/v2/live/message/post-chapterization.mdx b/api-reference/v2/live/message/post-chapterization.mdx index 7b046c0..7115418 100644 --- a/api-reference/v2/live/message/post-chapterization.mdx +++ b/api-reference/v2/live/message/post-chapterization.mdx @@ -1,5 +1,5 @@ --- -title: Chapterization -description: Payload definition for the message `post_chapterization`. +title: Chapterization (deprecated) +description: "**[Deprecated]** Chapterization no longer returns results. Use Audio-to-LLM on pre-recorded transcription instead." openapi-schema: PostChapterizationMessage ---- \ No newline at end of file +--- diff --git a/asyncapi.yaml b/asyncapi.yaml index 91fbcbd..df49e84 100644 --- a/asyncapi.yaml +++ b/asyncapi.yaml @@ -298,9 +298,9 @@ components: $ref: "#/components/schemas/PostFinalTranscriptMessage" postChapterization: name: post_chapterization - title: Chapterization + title: Chapterization (deprecated) contentType: application/json - summary: This message contains the informations about the post chapterization of the audio chunk. + summary: "**[Deprecated]** Chapterization no longer returns results. Use audio_to_llm on pre-recorded transcription instead; Audio-to-LLM is more powerful and fully customizable via custom prompts." payload: $ref: "#/components/schemas/PostChapterizationMessage" postSummarization: @@ -905,6 +905,8 @@ components: - { $ref: "#/components/schemas/ErrorObject" } results: { type: string } chapterization: + deprecated: true + description: "**[Deprecated]** Chapterization no longer returns results. Use audio_to_llm on pre-recorded transcription instead; Audio-to-LLM is more powerful and fully customizable via custom prompts." type: object properties: success: { type: boolean } @@ -931,6 +933,8 @@ components: PostChapterizationMessage: type: object + deprecated: true + description: "**[Deprecated]** Chapterization no longer returns results. Use audio_to_llm on pre-recorded transcription instead; Audio-to-LLM is more powerful and fully customizable via custom prompts." required: [session_id, created_at, type, data] properties: session_id: { $ref: "#/components/schemas/UUID" } diff --git a/chapters/audio-intelligence/audio-to-llm.mdx b/chapters/audio-intelligence/audio-to-llm.mdx index f1d9727..1bd8578 100644 --- a/chapters/audio-intelligence/audio-to-llm.mdx +++ b/chapters/audio-intelligence/audio-to-llm.mdx @@ -9,7 +9,7 @@ import PrerecordedBadge from "/snippets/badges/prerecorded.mdx" **Audio-to-LLM** runs once the transcription is generated. You provide **one or more prompts**; each prompt is executed against the **transcript text** from the same job using the configured model, yielding **one LLM response per prompt**. Use it to extract action items, answer questions about the recording, or run any text analysis you express in natural language. -Unlike the built-in [Summarization](/chapters/audio-intelligence/summarization) feature — which produces a fixed-format summary — Audio-to-LLM lets you write **your own instructions**: ask for a summary in the exact format, tone, and level of detail your product needs, or combine a summary with other analyses (action items, compliance checks) in a single request. +Unlike the built-in [Summarization](/chapters/audio-intelligence/summarization) feature, which produces a fixed-format summary, Audio-to-LLM lets you write **your own instructions**: ask for a summary in the exact format, tone, and level of detail your product needs, or combine a summary with other analyses (action items, compliance checks) in a single request. It also replaces the deprecated [Chapterization](/chapters/audio-intelligence/chapterization) add-on for chapter-style structuring of long audio, with full control over format and content via custom prompts. ## Usage diff --git a/chapters/audio-intelligence/chapterization.mdx b/chapters/audio-intelligence/chapterization.mdx index 38a8993..96eff37 100644 --- a/chapters/audio-intelligence/chapterization.mdx +++ b/chapters/audio-intelligence/chapterization.mdx @@ -1,6 +1,6 @@ --- title: "Chapterization" -description: "The Chapterization model segments the audio into distinct chapters, each with a descriptive headline and summaries" +description: "Chapterization is deprecated and no longer returns results. Use Audio-to-LLM for customizable chapter-style structuring of long audio." --- import PrerecordedBadge from "/snippets/badges/prerecorded.mdx" @@ -8,88 +8,11 @@ import LiveBadge from "/snippets/badges/live.mdx" - -This feature is in **Alpha** state.
-Breaking changes may still be introduced to this API, but advance notice will be sent. -We're looking for feedback to improve this feature, [share yours on Discord](https://discord.gg/T22a4ETUQp). + +This feature is **deprecated** and **no longer returns results**. - -The chapterization model segments the audio -into logical chapters based on the audio and content, and makes it easier to navigate long audios such as meeting recordings. +Use [Audio-to-LLM](/chapters/audio-intelligence/audio-to-llm) instead. It is more powerful and fully customizable: you write your own prompts to segment long audio, generate headlines and summaries, or structure the transcript however your product needs. + -Each chapter will contain its start and end time, as well as a summary, headline, bottom line "gist" and keywords. - -## Usage - -Enable chapterization by setting the appropriate flag: - - -```json Pre-recorded -{ - "chapterization": true -} -``` -```json Live -{ - "post_processing": { - "chapterization": true - }, - "messages_config": { - "receive_post_processing_events": true - } -} -``` - -## Result -The transcription result will contain a `"chapterization"` key with the output of the model: - - -```json Pre-recorded -{ - "transcription":{...}, - "chapterization": { - "success": true, - "is_empty": false, - "results": [ - { - "summary": "In a world where minimalism is valued, yet excess is desired, hope for the future remains. The past predicts the present, which is yet to be determined.", - "headline": "Headline: \"Embracing Hope: The Interconnectedness of Past, Present, and Future\"", - "gist": "Embracing Hope: Past, Present, Future Interconnected", - "keywords": [ - "Split infinity", - "less is more", - "too much", - "hope", - "present" - ], - "start": 0.0, - "end": 19.83977, - }], - "exec_time": 5.078396797180176, - "error": null - } -} -``` -```json Live -{ - "session_id": "550e8400-e29b-41d4-a716-446655440000", - "created_at": "2025-09-19T12:46:00Z", - "type": "post_chapterization", - "error": null, - "data": { - "results": [ - { - "headline": "Project kickoff", - "start": 0, - "end": 60, - "keywords": [ - "timeline", - "owner" - ] - } - ] - } -} -``` - \ No newline at end of file +The `chapterization` parameter remains in the API for backward compatibility, but enabling it will not produce chapter results. New integrations should use Audio-to-LLM. diff --git a/chapters/audio-intelligence/index.mdx b/chapters/audio-intelligence/index.mdx index f702893..5352e0c 100644 --- a/chapters/audio-intelligence/index.mdx +++ b/chapters/audio-intelligence/index.mdx @@ -1,9 +1,9 @@ --- title: Audio Intelligence -description: "Turn speech into actionable insights with translation, summarization, entities, chapters, sentiment and more" +description: "Turn speech into actionable insights with translation, summarization, entities, sentiment, custom LLM prompts and more" --- -Audio intelligence turns raw speech into structured, useful data on top of transcription. Once the words are captured, these features help you understand, organize, and act on the content — from instant translation to key-point summaries, entity detection, chapter markers, emotions, and even custom LLM prompts. +Audio intelligence turns raw speech into structured, useful data on top of transcription. Once the words are captured, these features help you understand, organize, and act on the content: from instant translation to key-point summaries, entity detection, emotions, and custom LLM prompts. Use these capabilities alongside Live or Pre-recorded STT to automate workflows like meeting notes, voice agents, compliance redaction, knowledge extraction, and multilingual publishing. @@ -53,7 +53,7 @@ Use these capabilities alongside Live or Pre-recorded STT to automate workflows icon="bookmark" href="/chapters/audio-intelligence/chapterization" > - Segment long audio into chapters with headlines and summaries for easy navigation. + Deprecated. Prefer Audio-to-LLM for customizable chapter-style structuring of long audio. -This feature is in **Alpha** state.
+This feature is in **Beta** state.
Breaking changes may still be introduced to this API, but an advanced notice will be sent. We're looking for feedback to improve this feature, [share yours on Discord](https://discord.gg/T22a4ETUQp). diff --git a/chapters/audio-intelligence/structured-data-extraction.mdx b/chapters/audio-intelligence/structured-data-extraction.mdx deleted file mode 100644 index b670a8a..0000000 --- a/chapters/audio-intelligence/structured-data-extraction.mdx +++ /dev/null @@ -1,432 +0,0 @@ ---- -title: 'Structured Data Extraction' -description: 'Thanks to structured data extract you can now extract directly nested json structure directly from the audio conversation.' ---- - -# Available Classes -- Addresses -- Appointments -- DateTimeEntities -- Documents -- Events -- Facilities -- FlightBookings -- GeopoliticalEntities -- HealthRecords -- HotelBookings -- Locations -- Moneys -- NonGeopoliticalEntities -- Organizations -- PaymentCardIndustry -- Persons -- Products -- Quantities -- Questions -- Speakers -- TradingActions -- Vehicles - - - -## HealthRecords -A list of Health Records mentionned in the conversation with the followinf properties: - -- **blood_type** (BloodType): The blood type of the person -- **weight** (List[Measurement]): The weight of the person -- **height** (List[Measurement]): The height of the person -- **bmi** (List[Measurement]): The body mass index of the person -- **blood_pressure** (List[Measurement]): The blood pressure of the person -- **heart_rate** (List[Measurement]): The heart rate of the person -- **temperature** (List[Measurement]): The temperature of the person -- **allergies** (List[str]): The allergies of the person -- **injuries** (List[Injury]): The injuries of the person -- **medications** (List[Medications]): The medications of the person -- **vaccinations** (List[Vaccination]): The vaccinations of the person -- **diseases** (List[str]): The diseases of the person -- **surgeries** (List[Surgery]): The surgeries of the person -- **hospitalizations** (List[Hospitalization]): The hospitalizations of the person -- **family_history** (List[str]): The family history of the person -- **lifestyle** (List[str]): The lifestyle of the person -- **diet** (List[str]): The diet of the person -- **exercise** (List[str]): The exercise of the person -- **sleep** (List[str]): The sleep of the person -- **mental_health** (List[str]): The mental health of the person -- **substance_use** (List[str]): The substance use of the person -- **sexual_health** (List[str]): The sexual health of the person -- **reproductive_health** (List[str]): The reproductive health of the person -- **pregnancy** (List[Pregnancy]): The pregnancy of the person -- **children** (List[Childrens]): The children of the person -- **pets** (List[Pet]): The pets of the person -- **insurance** (List[str]): The insurance of the person - -```json results -{ - "health_records": [ - { - "blood_type": "BloodType(ENUM)", - "weight": [ - { - "value": "str", - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" - } - ], - "height": [ - { - "value": "str", - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" - } - ], - "bmi": [ - { - "value": "str", - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" - } - ], - "blood_pressure": [ - { - "value": "str", - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" - } - ], - "heart_rate": [ - { - "value": "str", - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" - } - ], - "temperature": [ - { - "value": "str", - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" - } - ], - "allergies": ["str"], - "injuries": [ - { - "injury_name": "str", - "injury_description": "str", - "injury_severity": "str", - "injury_date": "str", - "injury_cause": "str", - "injury_location": "str", - "injury_treatment": "str" - } - ], - "medications": [ - { - "medication_name": "str", - "medication_dosage": "str", - "medication_frequency": "str", - "medication_duration": "str", - "medication_start_date": "str", - "medication_end_date": "str", - "medication_prescription": "str", - "medication_reason": "str", - "medication_side_effects": "str", - "medication_warnings": "str", - "medication_instructions": "str", - "medication_doctor": "str" - } - ], - "vaccinations": [ - { - "vaccination_name": "str", - "vaccination_date": "str", - "vaccination_location": "str", - "vaccination_doctor": "str" - } - ], - "diseases": ["str"], - "surgeries": [ - { - "surgery_name": "str", - "surgery_date": "str", - "surgery_location": "str", - "surgery_doctor": "str" - } - ], - "hospitalizations": [ - { - "hospital_name": "str", - "hospital_date": "str", - "hospital_location": "str", - "hospital_doctor": "str" - } - ], - "family_history": ["str"], - "lifestyle": ["str"], - "diet": ["str"], - "exercise": ["str"], - "sleep": ["str"], - "mental_health": ["str"], - "substance_use": ["str"], - "sexual_health": ["str"], - "reproductive_health": ["str"], - "pregnancy": [ - { - "pregnancy_date": "str", - "pregnancy_location": "str", - "pregnancy_doctor": "str", - "pregnancy_outcome": "str" - } - ], - "children": [ - { - "child_name": "str", - "child_age": "str", - "child_gender": "str" - } - ], - "pets": [ - { - "pet_name": "str", - "pet_age": "str", - "pet_species": "str", - "pet_breed": "str", - "pet_gender": "str" - } - ], - "insurance": ["str"] - } - ] -} -``` - -### Blood Type (Enum) - - **A_POSITIVE** - - **A_NEGATIVE** - - **B_POSITIVE** - - **B_NEGATIVE** - - **AB_POSITIVE** - - **AB_NEGATIVE** - - **O_POSITIVE** - - **O_NEGATIVE** - -### Injuries -- **injury_name** (str): The name of the injury -- **injury_description** (str): The description of the injury -- **injury_severity** (str): The severity of the injury -- **injury_date** (str): The date of the injury -- **injury_cause** (str): The cause of the injury -- **injury_location** (str): The location of the injury -- **injury_treatment** (str): The treatment of the injury - -```json results -{ - "injury_name": "str", - "injury_description": "str", - "injury_severity": "str", - "injury_date": "str", - "injury_cause": "str", - "injury_location": "str", - "injury_treatment": "str" -} -``` - -### Medications -- **medication_name** (str): The name of the medication -- **medication_dosage** (str): The dosage of the medication -- **medication_frequency** (str): The frequency of the medication -- **medication_duration** (str): The duration of the medication -- **medication_start_date** (str): The start date of the medication -- **medication_end_date** (str): The end date of the medication -- **medication_prescription** (str): The prescription of the medication -- **medication_reason** (str): The doctor who prescribed the medication -- **medication_side_effects** (str): The side effects of the medication -- **medication_warnings** (str): The warnings of the medication -- **medication_instructions** (str): The instructions of the medication -- **medication_doctor** (str): The notes of the medication - -```json results -{ - "medication_name": "str", - "medication_dosage": "str", - "medication_frequency": "str", - "medication_duration": "str", - "medication_start_date": "str", - "medication_end_date": "str", - "medication_prescription": "str", - "medication_reason": "str", - "medication_side_effects": "str", - "medication_warnings": "str", - "medication_instructions": "str", - "medication_doctor": "str" -} -``` - -### Vaccination -- **vaccination_name** (str): The name of the vaccination -- **vaccination_date** (str): The date of the vaccination -- **vaccination_location** (str): The location of the vaccination -- **vaccination_doctor** (str): The doctor of the vaccination - -```json results -{ - "vaccination_name": "str", - "vaccination_date": "str", - "vaccination_location": "str", - "vaccination_doctor": "str" -} -``` - -### Surgery -- **surgery_name** (str): The name of the surgery -- **surgery_date** (str): The date of the surgery -- **surgery_location** (str): The location of the surgery -- **surgery_doctor** (str): The doctor of the surgery - -```json results -{ - "surgery_name": "str", - "surgery_date": "str", - "surgery_location": "str", - "surgery_doctor": "str" -} -``` - -### Hospitalization -- **hospital_name** (str): The name of the hospital -- **hospital_date** (str): The date of the hospitalization -- **hospital_location** (str): The location of the hospital -- **hospital_doctor** (str): The doctor of the hospital - -```json results -{ - "hospital_name": "str", - "hospital_date": "str", - "hospital_location": "str", - "hospital_doctor": "str" -} -``` - -### Pregnancy -- **pregnancy_date** (str): The date of the pregnancy -- **pregnancy_location** (str): The location of the pregnancy -- **pregnancy_doctor** (str): The doctor of the pregnancy -- **pregnancy_outcome** (str): The outcome of the pregnancy - -```json results -{ - "pregnancy_date": "str", - "pregnancy_location": "str", - "pregnancy_doctor": "str", - "pregnancy_outcome": "str" -} -``` - -### Children -- **child_name** (str): The name of the child -- **child_age** (str): The age of the child -- **child_gender** (str): The gender of the child assigned at birth - -```json results -{ - "child_name": "str", - "child_age": "str", - "child_gender": "str" -} -``` - -### Pet -- **pet_name** (str): The name of the pet -- **pet_age** (str): The age of the pet -- **pet_species** (str): The species of the pet -- **pet_breed** (str): The breed of the pet -- **pet_gender** (str): The gender of the pet - -```json results -{ - "pet_name": "str", - "pet_age": "str", - "pet_species": "str", - "pet_breed": "str", - "pet_gender": "str" -} -``` - - -## Locations -A list of locations containing the following properties: - -- **city** (str): The name of the city -- **state** (str): The name of the state -- **zipcode** (str): The zipcode of the location -- **country** (str): The name of the country - -```json results -{ - "locations": [ - { - "city": "str", - "state": "str", - "zipcode": "str", - "country": "str" - } - ] -} -``` - - - - - - - - - -## Common Classes -### Measurement -A measurement will have the following properties: -- **value** (float): The value of the measurement -- **unit** (str): The unit of the measurement -- **date** (str): The date of the measurement -- **subject** (str): The subject of the measurement -- **speaker** (str): The speaker mentioning the measurement - -```json results -{ - "value": 42.42, - "unit": "str", - "date": "str", - "subject": "str", - "speaker": "str" -} -``` - -### Quantities -A list of quantities mentionned in the conversation with the following properties: -- **value** (float): The value of the quantity -- **unit** (str): The unit of the quantity -- **subject** (str): The subject of the quantity -- **speaker** (str): The speaker mentioning the quantity - -```json results -{ - "value": 42.42, - "unit": "str", - "subject": "str", - "speaker": "str" -} -``` - -- **ZMW** -: : \ No newline at end of file diff --git a/chapters/live-stt/audio-intelligence.mdx b/chapters/live-stt/audio-intelligence.mdx index 635a9cc..502610f 100644 --- a/chapters/live-stt/audio-intelligence.mdx +++ b/chapters/live-stt/audio-intelligence.mdx @@ -42,7 +42,7 @@ Audio intelligence turns raw speech into structured, useful data on top of trans icon="bookmark" href="/chapters/audio-intelligence/chapterization" > - Segment long audio into chapters with headlines and summaries for easy navigation. + Deprecated. Prefer Audio-to-LLM for customizable chapter-style structuring of long audio. - Segment long audio into chapters with headlines and summaries for easy navigation. + Deprecated. Prefer Audio-to-LLM for customizable chapter-style structuring of long audio.