package
3.0.4
Repository: https://github.com/grokify/go-voicebase-v3.git
Documentation: pkg.go.dev

# README

Go API client for voicebase

APIs for speech recognition and speech analytics, powering insights every business needs.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

Installation

Put the package under your project folder and add the following in import:

    "./voicebase"

Documentation for API Endpoints

All URIs are relative to https://apis.voicebase.com

ClassMethodHTTP requestDescription
DefinitionApiCreateKeywordSpottingGroupPut /v3/definition/spotting/groups/{groupId}Create or update keyword spotting group
DefinitionApiCreateVocabularyPut /v3/definition/vocabularies/{vocabularyId}Create or update a custom vocabulary
DefinitionApiDeleteKeywordSpottingGroupByIdDelete /v3/definition/spotting/groups/{groupId}Delete keyword spotting group
DefinitionApiDeleteVocabularyByIdDelete /v3/definition/vocabularies/{vocabularyId}Delete a custom vocabulary
DefinitionApiGetClassifierGet /v3/definition/prediction/classifiers/{classifierId}Retrieve details about a predictive classification model
DefinitionApiGetClassifiersGet /v3/definition/prediction/classifiersList predictive classification models
DefinitionApiGetDetectorGet /v3/definition/prediction/detectors/{detectorId}Retrieve details about a detection model
DefinitionApiGetDetectorsGet /v3/definition/prediction/detectorsList detection models
DefinitionApiGetKeywordSpottingGroupByIdGet /v3/definition/spotting/groups/{groupId}Retrieve a keyword spotting Group
DefinitionApiGetKeywordSpottingGroupsGet /v3/definition/spotting/groupsList keyword spotting groups
DefinitionApiGetSearchableFieldsGet /v3/definition/media/searchRetrieve the list of extended metadata searchable fields
DefinitionApiGetVocabulariesGet /v3/definition/vocabulariesList custom vocabularies
DefinitionApiGetVocabularyByIdGet /v3/definition/vocabularies/{vocabularyId}Retrieve a custom vocabulary.
DefinitionApiSetSearchableFieldsPut /v3/definition/media/searchDefine extended metadata searchable fields
KeyManagementApiCreateKeyPost /v3/profile/keysCreate API Key
KeyManagementApiDeleteKeyByIdDelete /v3/profile/keys/{keyId}Delete API key
KeyManagementApiGetKeyByIdGet /v3/profile/keys/{keyId}Retrieve details about an API key
KeyManagementApiGetKeysGet /v3/profile/keysList API Keys
MediaApiDeleteMediaByIdDelete /v3/media/{mediaId}Delete a media, transcripts and analytics results
MediaApiGetMediaByIdGet /v3/media/{mediaId}Retrieve transcript and analytical results from a media record
MediaApiGetMetadataByIdGet /v3/media/{mediaId}/metadataRetrieve metadata associated with a media record
MediaApiGetProgressByIdGet /v3/media/{mediaId}/progressRetrieve processing progress
MediaApiGetStreamByMediaIdAndNameGet /v3/media/{mediaId}/streams/{streamName}Downloads the media identified by the stream name
MediaApiGetStreamsByIdGet /v3/media/{mediaId}/streamsList streams
MediaApiGetSubtitleDfxpByIdGet /v3/media/{mediaId}/transcript/dfxpRetrieve DFXP transcript
MediaApiGetSubtitleWebVttByIdGet /v3/media/{mediaId}/transcript/webvttRetrieve WEBVTT transcript
MediaApiGetSubtitlesByIdGet /v3/media/{mediaId}/transcript/srtRetrieve SRT transcript
MediaApiGetTextByIdGet /v3/media/{mediaId}/transcript/textRetrieve text transcript
MediaApiGetTranscriptGet /v3/media/{mediaId}/transcriptRetrieve transcript
MediaApiMediaQueryGet /v3/mediaList media records
MediaApiPostMediaPost /v3/mediaUpload a media file for transcription and analysis
MediaApiPostMediaByIdPost /v3/media/{mediaId}Align a transcript and re-run the job
MediaApiSetMetadataByIdPut /v3/media/{mediaId}/metadataUpdate media metadata

Documentation For Models

Documentation For Authorization

Authorization

  • Type: API key

Example

	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
		Key: "APIKEY",
		Prefix: "Bearer", // Omit if not necessary.
	})
    r, err := client.Service.Operation(auth, args)

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

List of VbStatusEnum.
List of VbCallbackTypeEnum.
List of VbCallbackFormatEnum.
List of VbWordTypeEnum.
List of VbStatusEnum.
List of VbStatusEnum.
List of VbPriorityEnum.
List of VbIncludeTypeEnum.
List of VbIncludeTypeEnum.
List of VbIncludeTypeEnum.
List of VbIncludeTypeEnum.
List of VbIncludeTypeEnum.
List of VbIncludeTypeEnum.
List of VbCallbackFormatEnum.
List of VbPriorityEnum.
List of VbCallbackTypeEnum.
List of VbPriorityEnum.
List of VbCallbackStreamEnum.
POST
List of VbHttpMethodEnum.
List of VbWordTypeEnum.
List of VbHttpMethodEnum.
List of VbCallbackStreamEnum.
List of VbStatusEnum.
List of VbStatusEnum.
List of VbVocabularyType.
List of VbCallbackFormatEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbTaskStatusEnum.
List of VbVocabularyType.
List of VbCallbackFormatEnum.
List of VbCallbackTypeEnum.
List of VbWordTypeEnum.
List of VbCallbackFormatEnum.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the Voicebase V3 API API v3.0.1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
Sound attributes to replace spoken words in the audio when reported by a detector.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author