AudioUrl¶

class oci.generative_ai_inference.models.AudioUrl(**kwargs)¶

Bases: object

Provide a base64 encoded audio or an audio uri if it’s supported.

Attributes:

`DETAIL_AUTO`	A constant which can be used with the detail property of a AudioUrl.
`DETAIL_HIGH`	A constant which can be used with the detail property of a AudioUrl.
`DETAIL_LOW`	A constant which can be used with the detail property of a AudioUrl.
`detail`	Gets the detail of this AudioUrl.
`url`	[Required] Gets the url of this AudioUrl.

Methods:

__init__(**kwargs)

Initializes a new AudioUrl object with values from keyword arguments.

DETAIL_AUTO = 'AUTO'¶: A constant which can be used with the detail property of a AudioUrl. This constant has a value of “AUTO”

DETAIL_HIGH = 'HIGH'¶: A constant which can be used with the detail property of a AudioUrl. This constant has a value of “HIGH”

DETAIL_LOW = 'LOW'¶: A constant which can be used with the detail property of a AudioUrl. This constant has a value of “LOW”

__init__(**kwargs)¶

Initializes a new AudioUrl object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

url (str) – The value to assign to the url property of this AudioUrl.
detail (str) – The value to assign to the detail property of this AudioUrl. Allowed values for this property are: “AUTO”, “HIGH”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property detail¶

Gets the detail of this AudioUrl. The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded audio to tokens.

Allowed values for this property are: “AUTO”, “HIGH”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The detail of this AudioUrl.
Return type: str

property url¶

[Required] Gets the url of this AudioUrl. The base64 encoded audio data or an audio uri if it’s supported.

Example for an mp3 audio:

`{

“type”: “AUDIO”, “audioUrl”: {

“url”: “data:audio/mp3;base64,<base64 encoded audio content>”

}

}`

Example with an audio uri:

`{

“type”: “AUDIO”, “audioUrl”: {

“url”: “data:audio/mp3;uri,<audio uri>”

}

}`

Returns: The url of this AudioUrl.
Return type: str