Class TranscriptionCreateParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class TranscriptionCreateParams implements Params
Creates an asynchronous transcription job for audio files. Supports two modes:
Vault-based (recommended): Pass
vault_idandobject_idto transcribe audio from your vault. The transcript will automatically be saved back to the vault when complete.Direct URL (legacy): Pass
audio_urlfor direct transcription without automatic storage.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTranscriptionCreateParams.BuilderA builder for TranscriptionCreateParams.
public final classTranscriptionCreateParams.Bodypublic final classTranscriptionCreateParams.BoostParamHow much to boost custom vocabulary
public final classTranscriptionCreateParams.FormatOutput format for the transcript when using vault mode
-
Method Summary
Modifier and Type Method Description final Optional<String>audioUrl()URL of the audio file to transcribe (legacy mode, no auto-storage) final Optional<Boolean>autoHighlights()Automatically extract key phrases and topics final Optional<TranscriptionCreateParams.BoostParam>boostParam()How much to boost custom vocabulary final Optional<Boolean>contentSafetyLabels()Enable content moderation and safety labeling final Optional<TranscriptionCreateParams.Format>format()Output format for the transcript when using vault mode final Optional<Boolean>formatText()Format text with proper capitalization final Optional<String>languageCode()Language code (e.g., 'en_us', 'es', 'fr'). final Optional<Boolean>languageDetection()Enable automatic language detection final Optional<String>objectId()Object ID of the audio file in the vault (use with vault_id) final Optional<Boolean>punctuate()Add punctuation to the transcript final Optional<Boolean>speakerLabels()Enable speaker identification and labeling final Optional<Long>speakersExpected()Expected number of speakers (improves accuracy when known) final Optional<List<String>>speechModels()Priority-ordered speech models to use final Optional<String>vaultId()Vault ID containing the audio file (use with object_id) final Optional<List<String>>wordBoost()Custom vocabulary words to boost (e.g. final JsonField<String>_audioUrl()Returns the raw JSON value of audioUrl. final JsonField<Boolean>_autoHighlights()Returns the raw JSON value of autoHighlights. final JsonField<TranscriptionCreateParams.BoostParam>_boostParam()Returns the raw JSON value of boostParam. final JsonField<Boolean>_contentSafetyLabels()Returns the raw JSON value of contentSafetyLabels. final JsonField<TranscriptionCreateParams.Format>_format()Returns the raw JSON value of format. final JsonField<Boolean>_formatText()Returns the raw JSON value of formatText. final JsonField<String>_languageCode()Returns the raw JSON value of languageCode. final JsonField<Boolean>_languageDetection()Returns the raw JSON value of languageDetection. final JsonField<String>_objectId()Returns the raw JSON value of objectId. final JsonField<Boolean>_punctuate()Returns the raw JSON value of punctuate. final JsonField<Boolean>_speakerLabels()Returns the raw JSON value of speakerLabels. final JsonField<Long>_speakersExpected()Returns the raw JSON value of speakersExpected. final JsonField<List<String>>_speechModels()Returns the raw JSON value of speechModels. final JsonField<String>_vaultId()Returns the raw JSON value of vaultId. final JsonField<List<String>>_wordBoost()Returns the raw JSON value of wordBoost. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final TranscriptionCreateParams.BuildertoBuilder()final TranscriptionCreateParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static TranscriptionCreateParamsnone()final static TranscriptionCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of TranscriptionCreateParams. -
-
Method Detail
-
audioUrl
final Optional<String> audioUrl()
URL of the audio file to transcribe (legacy mode, no auto-storage)
-
autoHighlights
final Optional<Boolean> autoHighlights()
Automatically extract key phrases and topics
-
boostParam
final Optional<TranscriptionCreateParams.BoostParam> boostParam()
How much to boost custom vocabulary
-
contentSafetyLabels
final Optional<Boolean> contentSafetyLabels()
Enable content moderation and safety labeling
-
format
final Optional<TranscriptionCreateParams.Format> format()
Output format for the transcript when using vault mode
-
formatText
final Optional<Boolean> formatText()
Format text with proper capitalization
-
languageCode
final Optional<String> languageCode()
Language code (e.g., 'en_us', 'es', 'fr'). If not specified, language will be auto-detected
-
languageDetection
final Optional<Boolean> languageDetection()
Enable automatic language detection
-
objectId
final Optional<String> objectId()
Object ID of the audio file in the vault (use with vault_id)
-
speakerLabels
final Optional<Boolean> speakerLabels()
Enable speaker identification and labeling
-
speakersExpected
final Optional<Long> speakersExpected()
Expected number of speakers (improves accuracy when known)
-
speechModels
final Optional<List<String>> speechModels()
Priority-ordered speech models to use
-
wordBoost
final Optional<List<String>> wordBoost()
Custom vocabulary words to boost (e.g., legal terms)
-
_audioUrl
final JsonField<String> _audioUrl()
Returns the raw JSON value of audioUrl.
Unlike audioUrl, this method doesn't throw if the JSON field has an unexpected type.
-
_autoHighlights
final JsonField<Boolean> _autoHighlights()
Returns the raw JSON value of autoHighlights.
Unlike autoHighlights, this method doesn't throw if the JSON field has an unexpected type.
-
_boostParam
final JsonField<TranscriptionCreateParams.BoostParam> _boostParam()
Returns the raw JSON value of boostParam.
Unlike boostParam, this method doesn't throw if the JSON field has an unexpected type.
-
_contentSafetyLabels
final JsonField<Boolean> _contentSafetyLabels()
Returns the raw JSON value of contentSafetyLabels.
Unlike contentSafetyLabels, this method doesn't throw if the JSON field has an unexpected type.
-
_format
final JsonField<TranscriptionCreateParams.Format> _format()
Returns the raw JSON value of format.
Unlike format, this method doesn't throw if the JSON field has an unexpected type.
-
_formatText
final JsonField<Boolean> _formatText()
Returns the raw JSON value of formatText.
Unlike formatText, this method doesn't throw if the JSON field has an unexpected type.
-
_languageCode
final JsonField<String> _languageCode()
Returns the raw JSON value of languageCode.
Unlike languageCode, this method doesn't throw if the JSON field has an unexpected type.
-
_languageDetection
final JsonField<Boolean> _languageDetection()
Returns the raw JSON value of languageDetection.
Unlike languageDetection, this method doesn't throw if the JSON field has an unexpected type.
-
_objectId
final JsonField<String> _objectId()
Returns the raw JSON value of objectId.
Unlike objectId, this method doesn't throw if the JSON field has an unexpected type.
-
_punctuate
final JsonField<Boolean> _punctuate()
Returns the raw JSON value of punctuate.
Unlike punctuate, this method doesn't throw if the JSON field has an unexpected type.
-
_speakerLabels
final JsonField<Boolean> _speakerLabels()
Returns the raw JSON value of speakerLabels.
Unlike speakerLabels, this method doesn't throw if the JSON field has an unexpected type.
-
_speakersExpected
final JsonField<Long> _speakersExpected()
Returns the raw JSON value of speakersExpected.
Unlike speakersExpected, this method doesn't throw if the JSON field has an unexpected type.
-
_speechModels
final JsonField<List<String>> _speechModels()
Returns the raw JSON value of speechModels.
Unlike speechModels, this method doesn't throw if the JSON field has an unexpected type.
-
_vaultId
final JsonField<String> _vaultId()
Returns the raw JSON value of vaultId.
Unlike vaultId, this method doesn't throw if the JSON field has an unexpected type.
-
_wordBoost
final JsonField<List<String>> _wordBoost()
Returns the raw JSON value of wordBoost.
Unlike wordBoost, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final TranscriptionCreateParams.Builder toBuilder()
-
_body
final TranscriptionCreateParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static TranscriptionCreateParams none()
-
builder
final static TranscriptionCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of TranscriptionCreateParams.
-
-
-
-