Audio

Audio values to BAML functions can be created in client libraries. This document explains how to use these functions both at compile time and runtime to handle audio data. For more details, refer to audio types.

Usage Examples

async def test_audio_input(): # Create an Audio object from a URL audio = Audio.from_url("https://actions.google.com/sounds/v1/emergency/beeper_emergency_call.ogg") res = await b.TestAudioInput(audio=audio)

# Create an Audio object from Base64 data
audio_b64 = "iVB0xyz..."
audio = Audio.from_base64("audio/ogg", audio_b64)
res = await b.TestAudioInput(audio=audio)

```typescript
import { b } from '../baml_client'
import { Audio } from "@boundaryml/baml"

// Create an Audio object from a URL
let res = await b.TestAudioInput(
    Audio.fromUrl('https://actions.google.com/sounds/v1/emergency/beeper_emergency_call.ogg')
)

// Create an Audio object from Base64 data
const audio_b64 = "iVB0xyz..."
res = await b.TestAudioInput(
    Audio.fromBase64('audio/ogg', audio_b64)
)

// Browser-specific methods
const fileAudio = await Audio.fromFile(file)
const blobAudio = await Audio.fromBlob(blob, 'audio/ogg')
const fetchedAudio = await Audio.fromUrlAsync('https://example.com/audio.ogg')

import { useTestAudioInput } from '../baml_client/react/hooks'
import { Audio } from "../baml_client/react/media"

export function TestAudioInput() {
    const { mutate } = useTestAudioInput()

    const handleClick = async () => {
        const audio = await Audio.fromUrl('https://actions.google.com/sounds/v1/emergency/beeper_emergency_call.ogg')
        mutate(audio)
    }

    return (
      <div>
          <button onClick={handleClick}>
              Test Audio Input
          </button>
      </div>
    )
}

package main

import (
    "context"
    
    b "example.com/myproject/baml_client"
)

func testAudioInput() error {
    ctx := context.Background()
    
    // Create an Audio from a URL
    aud, err := b.NewAudioFromUrl("https://actions.google.com/sounds/v1/emergency/beeper_emergency_call.ogg", nil)
    if err != nil {
        return err
    }
    
    result, err := b.TestAudioInput(ctx, aud)
    if err != nil {
        return err
    }

    // Create an Audio from Base64 data
    audioB64 := "SUQzAwAAAAABAAAAAAAAAAAAAAA..."
    aud2, err := b.NewAudioFromBase64(audioB64, stringPtr("audio/mp3"))
    if err != nil {
        return err
    }
    
    result2, err := b.TestAudioInput(ctx, aud2)
    if err != nil {
        return err
    }
    
    return nil
}

// Helper function for string pointer
func stringPtr(s string) *string {
    return &s
}

use myproject::baml_client::sync_client::B;
use myproject::baml_client::new_audio_from_url;

fn test_audio_input() {
    // Create an Audio from a URL
    let audio = new_audio_from_url(
        "https://actions.google.com/sounds/v1/emergency/beeper_emergency_call.ogg",
        None,
    );
    let res = B.TestAudioInput.call(&audio).unwrap();
}

# Ruby implementation is in development.

API Reference

Static Methods

<ParamField path="from_url" type="(url: str, media_type: Optional[str] = None) -> Audio"

Creates an Audio object from a URL. Optionally specify the media type, otherwise it will be inferred from the URL. </ParamField>

<ParamField path="from_base64" type="(media_type: str, base64: str) -> Audio"

Creates an Audio object using Base64 encoded data along with the given MIME type. </ParamField>

Instance Methods

<ParamField path="is_url" type="() -> bool"

Check if the audio is stored as a URL. </ParamField>

<ParamField path="as_url" type="() -> str"

Get the URL of the audio if it's stored as a URL. Raises an exception if the audio is not stored as a URL. </ParamField>

<ParamField path="as_base64" type="() -> list[str]"

Get the base64 data and media type if the audio is stored as base64. Returns [base64_data, media_type]. Raises an exception if the audio is not stored as base64. </ParamField>

<ParamField path="baml_serialize" type="() -> dict"

Convert the audio to a dictionary representation. Returns either {"url": str} or {"base64": str, "media_type": str}. </ParamField>

Static Methods

<ParamField path="fromUrl" type="(url: string, mediaType?: string) => Audio"

Creates an Audio object from a URL. Optionally specify the media type, otherwise it will be inferred from the URL. </ParamField>

<ParamField path="fromBase64" type="(mediaType: string, base64: string) => Audio"

Creates an Audio object using Base64 encoded data along with the given MIME type. </ParamField>

<ParamField path="fromFile" type="(file: File) => Promise<Audio>"

<Info>Only available in browser environments. @boundaryml/baml/browser</Info> Creates an Audio object from a File object. Available in browser environments only. </ParamField>

<ParamField path="fromBlob" type="(blob: Blob, mediaType?: string) => Promise<Audio>"

<Info>Only available in browser environments. @boundaryml/baml/browser</Info> Creates an Audio object from a Blob object. Available in browser environments only. </ParamField>

<ParamField path="fromUrlToBase64" type="(url: string) => Promise<Audio>"

<Info>Only available in browser environments.</Info> Creates an Audio object by fetching from a URL. Available in browser environments only. </ParamField>

Instance Methods

<ParamField path="isUrl" type="() => boolean"

Check if the audio is stored as a URL. </ParamField>

<ParamField path="asUrl" type="() => string"

Get the URL of the audio if it's stored as a URL. Throws an Error if the audio is not stored as a URL. </ParamField>

<ParamField path="asBase64" type="() => [string, string]"

Get the base64 data and media type if the audio is stored as base64. Returns [base64Data, mediaType]. Throws an Error if the audio is not stored as base64. </ParamField>

<ParamField path="toJSON" type="() => { url: string } | { base64: string; media_type: string }"

Convert the audio to a JSON representation. Returns either a URL object or a base64 object with media type. </ParamField>

Static Methods

<ParamField path="NewAudioFromUrl" type="(url string, mediaType *string) (*Audio, error)"

Creates an Audio object from a URL. Optionally specify the media type, otherwise it will be inferred from the URL. </ParamField>

<ParamField path="NewAudioFromBase64" type="(base64 string, mediaType *string) (*Audio, error)"

Creates an Audio object using Base64 encoded data along with the given MIME type. </ParamField>

Instance Methods

<ParamField path="IsUrl" type="() bool"

Check if the audio is stored as a URL. </ParamField>

<ParamField path="AsUrl" type="() (string, error)"

Get the URL of the audio if it's stored as a URL. Returns an error if the audio is not stored as a URL. </ParamField>

<ParamField path="AsBase64" type="() (string, string, error)"

Get the base64 data and media type if the audio is stored as base64. Returns (base64Data, mediaType, error). Returns an error if the audio is not stored as base64. </ParamField>

<ParamField path="ToJSON" type="() (map[string]interface{}, error)"

Convert the audio to a map representation. Returns either {"url": string} or {"base64": string, "media_type": string}. </ParamField>

Static Methods

<ParamField path="new_audio_from_url" type="(url: &str, media_type: Option<&str>) -> BamlAudio"

Creates an Audio from a URL. Optionally specify the media type. </ParamField>

<ParamField path="new_audio_from_base64" type="(base64: &str, media_type: Option<&str>) -> BamlAudio"

Creates an Audio from Base64 encoded data with an optional MIME type. </ParamField>

Ruby implementation is in development.

URL Handling

Audio URLs are processed according to your client's media_url_handler configuration:

• OpenAI: By default converts to base64 (send_base64) for compatibility.
• Vertex AI: By default uses send_url_add_mime_type to include MIME type.
• Anthropic: By default keeps URLs as-is (send_url).
• Google AI: By default keeps URLs as-is (send_url).
• AWS Bedrock: By default converts to base64 (send_base64).

Note: OpenAI requires audio to be base64-encoded, which is why the default is send_base64.