Vulavula Logo
Vulavula API

​Schemas

​BatchTranscriptionCreateResponse

  • batch_idstring · required
  • blob_endpointstring · required
  • sas_tokenstring · required

​BatchTranscriptionDto

  • statusstring · enum · required
    Enum values:
    REQUESTED
    UPLOADED
    PROCESSING
    COMPLETE
    FAILED
    RETRYING
  • id
  • customer_id

    Services customer id.

  • project_id

    Services project id.

  • keychain_id

    Keychain ID.

  • language_code
  • created_at
  • updated_at

​BatchTranscriptionStatus

string · enum
Enum values:
REQUESTED
UPLOADED
PROCESSING
COMPLETE
FAILED
RETRYING

​Body_add_document_to_knowledgebase_api_v1_search_knowledgebase__knowledgebase_id__document_post

  • filestring · binary · required

    The file to upload

​Body_handle_transcribe_fast_api_v2alpha_transcribe_fast_post

  • uploadstring · binary · required

​Body_sync_file_transcription_api_v2alpha_transcribe_sync_file_post

  • filestring · binary · required

​ClassifyRequest

  • inputsstring[] · required
  • examplesobject[] · required

​ClassifyResponse

  • probabilitiesobject[] · required

​CreateKnowledgeBaseResponse

  • idstring · uuid · required
  • knowledgebase_namestring · required

​CreateKnowledgebaseRequest

  • knowledgebase_namestring · required

​DiarisationResultDto

  • timelineobject[] · required
  • wordsobject[] · required

​EntityRecognitionRequest

  • encoded_textstring · required
  • webhook

​EntityRecognitionResponse

  • idstring · required
  • entitiesobject[] · required

​Example

  • intentstring · required
  • examplestring · required

​HTTPValidationError

  • detailobject[]

​IntentScore

  • intentstring · required
  • scorenumber · required

​Knowledgebase

  • idstring · uuid · required
  • knowledgebase_namestring · required
  • documentsobject[] · required

​KnowledgebaseDocument

  • idstring · uuid · required
  • knowledgebase_idstring · uuid · required
  • filenamestring · required

​Label

  • labelstring · required
  • scorenumber · required

​NamedEntity

  • entitystring · required
  • wordstring · required
  • startinteger · required
  • endinteger · required

​SearchQueryRequest

  • querystring · required
  • language

​SearchResult

  • textstring · required
  • scorenumber · required

​SearchResultsResponse

  • search_resultsobject[] · required

​Sentiment

  • textstring · required
  • labelsobject[] · required

​SentimentAnalysisRequest

  • encoded_textstring · required
  • webhook

​SentimentAnalysisResponse

  • idstring · required
  • sentimentsobject[] · required

​SyncTranscribeRequest

  • file_namestring · required
  • audio_blobrequired
  • file_sizeinteger · required
  • language_code
  • channels
  • sample_rate
  • frame_rate

​TimelineItemDto

  • start_timenumber · required
  • end_timenumber · required
  • typestring · required
  • speaker_id
  • text

​TranscribeUsageReport

  • total_invocationsinteger · required
  • total_successful_invocationsinteger · required
  • total_failed_invocationsinteger · required
  • total_pending_invocationsinteger · required
  • total_seconds_transcribednumber · required
  • total_tokensinteger · required
  • start_date_timestring · required
  • end_date_timestring · required
  • intervalstring · required
  • usageobject[]
    Default: []

​TranscribeUsageReportItem

  • periodstring · required
  • invocationsinteger · required
  • successful_invocationsinteger · required
  • failed_invocationsinteger · required
  • pending_invocationsinteger · required
  • seconds_transcribednumber · required
  • tokensinteger · required

​TranscriptionDto

  • id
  • upload_file_size
  • audio_length_seconds
  • sample_rate
  • channels
  • frame_rate
  • mime_type
  • language_code
  • diarisation_result
  • transcription_text
  • transcription_status
  • error_message
  • status_datetime
  • upload_datetime
  • warnings

​TranslationRequest

  • input_textstring · required
  • source_langstring · required
  • target_langstring · required
  • customer_id
  • project_id
  • keychain_id

​ValidationError

  • locarray · required
  • msgstring · required
  • typestring · required

​VersionInfo

  • versionstring · required

    Internal package version

  • git_commitstring · required

    Git commit reference

  • release_namestring · required

    Global Vulavula Release this service belongs to

  • release_datestring · required

    Date of the release

​WordLevelDetailsDto

  • wordstring · required
  • start_timenumber · required
  • end_timenumber · required
  • speaker_idstring · required
  • confidence
  • weight
  • word_intensity
  • best_path