modulepackage
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.
- API version: 3.0.1
- Package version: 2.3.0
- Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://www.voicebase.com/contact-us/
Installation
Install the client:
$ go get github.com/grokify/go-voicebase-v3/v3
Add the following to your Go source:
import(
"github.com/grokify/go-voicebase-v3/v3"
)
Documentation for API Endpoints
All URIs are relative to https://apis.voicebase.com
Class | Method | HTTP request | Description |
---|---|---|---|
DefinitionApi | CreateKeywordSpottingGroup | Put /v3/definition/spotting/groups/{groupId} | Create or update keyword spotting group |
DefinitionApi | CreateVocabulary | Put /v3/definition/vocabularies/{vocabularyId} | Create or update a custom vocabulary |
DefinitionApi | DeleteKeywordSpottingGroupById | Delete /v3/definition/spotting/groups/{groupId} | Delete keyword spotting group |
DefinitionApi | DeleteVocabularyById | Delete /v3/definition/vocabularies/{vocabularyId} | Delete a custom vocabulary |
DefinitionApi | GetClassifier | Get /v3/definition/prediction/classifiers/{classifierId} | Retrieve details about a predictive classification model |
DefinitionApi | GetClassifiers | Get /v3/definition/prediction/classifiers | List predictive classification models |
DefinitionApi | GetDetector | Get /v3/definition/prediction/detectors/{detectorId} | Retrieve details about a detection model |
DefinitionApi | GetDetectors | Get /v3/definition/prediction/detectors | List detection models |
DefinitionApi | GetKeywordSpottingGroupById | Get /v3/definition/spotting/groups/{groupId} | Retrieve a keyword spotting Group |
DefinitionApi | GetKeywordSpottingGroups | Get /v3/definition/spotting/groups | List keyword spotting groups |
DefinitionApi | GetSearchableFields | Get /v3/definition/media/search | Retrieve the list of extended metadata searchable fields |
DefinitionApi | GetVocabularies | Get /v3/definition/vocabularies | List custom vocabularies |
DefinitionApi | GetVocabularyById | Get /v3/definition/vocabularies/{vocabularyId} | Retrieve a custom vocabulary. |
DefinitionApi | SetSearchableFields | Put /v3/definition/media/search | Define extended metadata searchable fields |
KeyManagementApi | CreateKey | Post /v3/profile/keys | Create API Key |
KeyManagementApi | DeleteKeyById | Delete /v3/profile/keys/{keyId} | Delete API key |
KeyManagementApi | GetKeyById | Get /v3/profile/keys/{keyId} | Retrieve details about an API key |
KeyManagementApi | GetKeys | Get /v3/profile/keys | List API Keys |
MediaApi | DeleteMediaById | Delete /v3/media/{mediaId} | Delete a media, transcripts and analytics results |
MediaApi | GetMediaById | Get /v3/media/{mediaId} | Retrieve transcript and analytical results from a media record |
MediaApi | GetMetadataById | Get /v3/media/{mediaId}/metadata | Retrieve metadata associated with a media record |
MediaApi | GetProgressById | Get /v3/media/{mediaId}/progress | Retrieve processing progress |
MediaApi | GetStreamByMediaIdAndName | Get /v3/media/{mediaId}/streams/{streamName} | Downloads the media identified by the stream name |
MediaApi | GetStreamsById | Get /v3/media/{mediaId}/streams | List streams |
MediaApi | GetSubtitleDfxpById | Get /v3/media/{mediaId}/transcript/dfxp | Retrieve DFXP transcript |
MediaApi | GetSubtitleWebVttById | Get /v3/media/{mediaId}/transcript/webvtt | Retrieve WEBVTT transcript |
MediaApi | GetSubtitlesById | Get /v3/media/{mediaId}/transcript/srt | Retrieve SRT transcript |
MediaApi | GetTextById | Get /v3/media/{mediaId}/transcript/text | Retrieve text transcript |
MediaApi | GetTranscript | Get /v3/media/{mediaId}/transcript | Retrieve transcript |
MediaApi | MediaQuery | Get /v3/media | List media records |
MediaApi | PostMedia | Post /v3/media | Upload a media file for transcription and analysis |
MediaApi | PostMediaById | Post /v3/media/{mediaId} | Align a transcript and re-run the job |
MediaApi | SetMetadataById | Put /v3/media/{mediaId}/metadata | Update media metadata |
Documentation For Models
- VbAudioRedactorConfiguration
- VbCallbackConfiguration
- VbCallbackFormatEnum
- VbCallbackStreamEnum
- VbCallbackTypeEnum
- VbChannelConfiguration
- VbClass
- VbClassifier
- VbClassifierConfiguration
- VbClassifierModel
- VbClassifierModelsResponse
- VbConfiguration
- VbContentFilteringConfiguration
- VbDetectedSegment
- VbDetection
- VbDetector
- VbDetectorConfiguration
- VbDetectorModel
- VbDetectorModelsResponse
- VbDiarization
- VbError
- VbErrorResponse
- VbFormattingConfiguration
- VbFrequency
- VbGroup
- VbHttpMethodEnum
- VbIncludeTypeEnum
- VbIngestConfiguration
- VbJob
- VbKey
- VbKeyConfiguration
- VbKeysResponse
- VbKeyword
- VbKeywordGroup
- VbKeywordGroupsResponse
- VbKnowledge
- VbKnowledgeConfiguration
- VbMediaQueryResponse
- VbMediaSummary
- VbMention
- VbMessage
- VbMetadata
- VbOccurrence
- VbParameter
- VbParameterDefinition
- VbPrediction
- VbPredictionConfiguration
- VbPriorityEnum
- VbProgress
- VbProgressTask
- VbPublishConfiguration
- VbRedactorConfiguration
- VbReference
- VbSearchableFields
- VbSpeechModelConfiguration
- VbSpotting
- VbSpottingConfiguration
- VbSpottingGroupConfiguration
- VbStatusEnum
- VbStereoConfiguration
- VbStream
- VbStreams
- VbTaskStatusEnum
- VbTopic
- VbTrackConfiguration
- VbTranscript
- VbTranscriptConfiguration
- VbTranscriptFormat
- VbTranscriptRedactorConfiguration
- VbVocabulariesResponse
- VbVocabulary
- VbVocabularyConfiguration
- VbVocabularyScript
- VbVocabularyScriptConfiguration
- VbVocabularyTerm
- VbVocabularyTermConfiguration
- VbVocabularyType
- VbWord
- VbWordTypeEnum
- VbMedia
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
Support
# Functions
No description provided by the author
BuildVocabulariesForStrings takes a list of strings and converts them to a list of `VbVocabulary` structs for use in uploading media.
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
# Structs
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