Package com.dropbox.core.v2.riviera

Class DbxUserGetTranscriptAsyncBuilder

java.lang.Object
com.dropbox.core.v2.riviera.DbxUserGetTranscriptAsyncBuilder
public class DbxUserGetTranscriptAsyncBuilder extends Object
The request builder returned by DbxUserRivieraRequests.getTranscriptAsyncBuilder().

Use this class to set optional request parameters and complete the request.

  • Method Details

    • withFileIdOrUrl

      public DbxUserGetTranscriptAsyncBuilder withFileIdOrUrl(FileIdOrUrl fileIdOrUrl)
      Set value for optional field.
      Parameters:
      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:<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`.
      Returns:
      this builder

    • withTimestampLevel

      public DbxUserGetTranscriptAsyncBuilder withTimestampLevel(TimestampLevel timestampLevel)
      Set value for optional field.

      If left unset or set to null, defaults to TimestampLevel.UNKNOWN.

      Parameters:
      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. Must not be null. Defaults to TimestampLevel.UNKNOWN when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withIncludedSpecialWords

      public DbxUserGetTranscriptAsyncBuilder withIncludedSpecialWords(String includedSpecialWords)
      Set value for optional field.

      If left unset or set to null, defaults to "".

      Parameters:
      includedSpecialWords - 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. Must not be null. Defaults to "" when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withAudioLanguage

      public DbxUserGetTranscriptAsyncBuilder withAudioLanguage(String audioLanguage)
      Set value for optional field.

      If left unset or set to null, defaults to "".

      Parameters:
      audioLanguage - 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. Must not be null. Defaults to "" when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • start

      public LaunchResultBase start() throws DbxApiException, DbxException
      Issues the request.
      Throws:
      DbxApiException
      DbxException