Struct GetTranscriptArgs 

#[non_exhaustive]
pub struct GetTranscriptArgs {
    pub file_id_or_url: Option<FileIdOrUrl>,
    pub timestamp_level: TimestampLevel,
    pub included_special_words: String,
    pub audio_language: String,
}

Available on crate feature dbx_riviera only.

Arguments for the asynchronous get_transcript_async route. Exactly one of file_id, path, or url must be supplied via file_id_or_url to identify the audio or video asset to transcribe.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

file_id_or_url: Option<FileIdOrUrl>

Identifier of the media asset to transcribe. Callers must set exactly one of the oneof variants: - file_id: a Dropbox-issued file id (format: “id:”) for a file the authenticated user has access to. - path: an absolute Dropbox path, e.g. “/folder/recording.mp4”. - url: either a Dropbox shared link (www.dropbox.com) or an external HTTPS URL pointing to a supported audio/video file. - Dropbox shared links are resolved internally using the caller’s authenticated identity and the link’s visibility / download settings. They therefore require an authenticated user context (anonymous url requests against Dropbox links are rejected with an ACCESS_ERROR). Links protected by a password are rejected with shared_link_password_protected; links with downloads disabled are rejected with link_download_disabled_error. - External URLs are fetched over HTTPS through the backend’s egress proxy and must point at a supported audio/video file extension. The referenced asset must be an audio or video file in a supported format; requests against files with no audio track return a no_audio_error.

timestamp_level: TimestampLevel

Granularity of the time offsets returned for each transcript segment. Defaults to `SENTENCE.

• SENTENCE: one segment per spoken sentence (recommended). - WORD: one segment per word, useful for fine-grained alignment such as captioning or highlight-as-you-listen experiences.

included_special_words: String

Comma-delimited list of non-lexical filler words to preserve in the transcript output, e.g. "uh, ah, uhm". By default these fillers are stripped. Unrecognized tokens are ignored. Leave empty to use the default filtering behavior.

audio_language: String

Optional BCP-47 language tag hinting the spoken language of the source audio (e.g. “en-US”, “ja-JP”). When empty, the service auto-detects the language; supplying a hint improves accuracy and latency for short or ambiguous clips. Unsupported languages fall back to auto-detection.

Implementations

impl GetTranscriptArgs

pub fn with_file_id_or_url(self, value: FileIdOrUrl) -> Self

pub fn with_timestamp_level(self, value: TimestampLevel) -> Self

pub fn with_included_special_words(self, value: String) -> Self

pub fn with_audio_language(self, value: String) -> Self

Trait Implementations

impl Clone for GetTranscriptArgs

fn clone(&self) -> GetTranscriptArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetTranscriptArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetTranscriptArgs

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetTranscriptArgs

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for GetTranscriptArgs

fn eq(&self, other: &GetTranscriptArgs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GetTranscriptArgs

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for GetTranscriptArgs

impl StructuralPartialEq for GetTranscriptArgs