voicebase

type APIClient struct {

	// API Services
	DefinitionApi    *DefinitionApiService
	KeyManagementApi *KeyManagementApiService
	MediaApi         *MediaApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

type DefinitionApiService service

type KeyManagementApiService service

type MediaApiService service

type VbAudioRedactorConfiguration struct {
	Tone int32 `json:"tone,omitempty"`

	Gain float32 `json:"gain,omitempty"`
}

type VbCallbackConfiguration struct {
	Url string `json:"url,omitempty"`

	Method *VbHttpMethodEnum `json:"method,omitempty"`

	Type_ *VbCallbackTypeEnum `json:"type,omitempty"`

	Include []VbIncludeTypeEnum `json:"include,omitempty"`

	Stream *VbCallbackStreamEnum `json:"stream,omitempty"`

	Format *VbCallbackFormatEnum `json:"format,omitempty"`
}

type VbCallbackFormatEnum string

type VbCallbackStreamEnum string

type VbCallbackTypeEnum string

type VbChannelConfiguration struct {

	// Speaker name on this channel. Defaults to \"SpeakerN\" where N is the channel number.
	SpeakerName string `json:"speakerName,omitempty"`

	// A description of the speaker role. Only used as metadata.
	SpeakerRole string `json:"speakerRole,omitempty"`

	// Whether this channel should be ignored for all processing.
	Ignore bool `json:"ignore,omitempty"`
}

type VbClass struct {
	ClassLabel string `json:"classLabel,omitempty"`

	ClassValue int32 `json:"classValue,omitempty"`
}

type VbClassifier struct {
	ClassifierId string `json:"classifierId,omitempty"`

	ClassifierName string `json:"classifierName,omitempty"`

	ClassifierDisplayName string `json:"classifierDisplayName,omitempty"`

	ClassifierType string `json:"classifierType,omitempty"`

	PredictedClassLabel string `json:"predictedClassLabel,omitempty"`

	PredictionScore float64 `json:"predictionScore,omitempty"`

	PredictedClass int32 `json:"predictedClass,omitempty"`
}

type VbClassifierConfiguration struct {

	// Classifier identifier, usually a UUID.
	ClassifierId string `json:"classifierId,omitempty"`

	// A name identifying classifiers offered by Voicebase to all customers
	ClassifierName string `json:"classifierName,omitempty"`

	// Provide a specific version (e.g. \"3.1.3\"), specify a minimum (e.g. \"3.1+\") or get the \"latest\". Defaults to \"latest\" if not specified.
	Version string `json:"version,omitempty"`

	// List of parameter values to the classifier
	Parameters []VbParameter `json:"parameters,omitempty"`
}

type VbClassifierModel struct {
	ClassifierId string `json:"classifierId,omitempty"`

	// Use this name for referring to the classifier in a configuration provided with the media for processing
	ClassifierName string `json:"classifierName,omitempty"`

	// Use this version in conjuction with the classifier name for referring to this classifier in a configuration provided with the media for processing
	ClassifierVersion string `json:"classifierVersion,omitempty"`

	ClassifierDescription string `json:"classifierDescription,omitempty"`

	ClassifierType string `json:"classifierType,omitempty"`

	// Set of possible classes identified by the classifier
	Classes []VbClass `json:"classes,omitempty"`

	// Set of possible parameters for this classifier
	Parameters []VbParameterDefinition `json:"parameters,omitempty"`
}

type VbClassifierModelsResponse struct {
	Classifiers []VbClassifierModel `json:"classifiers,omitempty"`
}

type VbConfiguration struct {
	SpeechModel *VbSpeechModelConfiguration `json:"speechModel,omitempty"`

	// Allows to specify other languages to enable recognition when conversations occur in multiple languages
	AdditionalSpeechModels []VbSpeechModelConfiguration `json:"additionalSpeechModels,omitempty"`

	Priority *VbPriorityEnum `json:"priority,omitempty"`

	Ingest *VbIngestConfiguration `json:"ingest,omitempty"`

	Prediction *VbPredictionConfiguration `json:"prediction,omitempty"`

	Spotting *VbSpottingConfiguration `json:"spotting,omitempty"`

	Knowledge *VbKnowledgeConfiguration `json:"knowledge,omitempty"`

	Transcript *VbTranscriptConfiguration `json:"transcript,omitempty"`

	Vocabularies []VbVocabularyConfiguration `json:"vocabularies,omitempty"`

	Publish *VbPublishConfiguration `json:"publish,omitempty"`
}

type VbContentFilteringConfiguration struct {

	// Whether swear word filtering is enabled or not
	EnableProfanityFiltering bool `json:"enableProfanityFiltering,omitempty"`
}

type VbDetectedSegment struct {
	SpeakerName string `json:"speakerName,omitempty"`

	Occurrences []VbOccurrence `json:"occurrences,omitempty"`
}

type VbDetection struct {
	DetectorClass int32 `json:"detectorClass,omitempty"`

	DetectorClassLabel string `json:"detectorClassLabel,omitempty"`

	DetectedSegments []VbDetectedSegment `json:"detectedSegments,omitempty"`
}

type VbDetector struct {
	DetectorId string `json:"detectorId,omitempty"`

	DetectorName string `json:"detectorName,omitempty"`

	DetectorDisplayName string `json:"detectorDisplayName,omitempty"`

	DetectorType string `json:"detectorType,omitempty"`

	Detections []VbDetection `json:"detections,omitempty"`
}

type VbDetectorConfiguration struct {

	// Detector identifier, a UUID
	DetectorId string `json:"detectorId,omitempty"`

	// A name identifying a detector offered by Voicebase to all customers
	DetectorName string `json:"detectorName,omitempty"`

	// Provide a specific version (e.g. \"3.1.3\"), specify a minimum (e.g. \"3.1+\") or get the \"latest\". Defaults to \"latest\" if not specified.
	Version string `json:"version,omitempty"`

	// List of parameter values to the detector
	Parameters []VbParameter `json:"parameters,omitempty"`

	Redactor *VbRedactorConfiguration `json:"redactor,omitempty"`
}

type VbDetectorModel struct {
	DetectorId string `json:"detectorId,omitempty"`

	// Use this detector name when refering to this detector in a configuration for media processing
	DetectorName string `json:"detectorName,omitempty"`

	// Use this version in conjuction with the detector name for referring to this detector in a configuration provided with the media for processing
	DetectorVersion string `json:"detectorVersion,omitempty"`

	// Describes the function of this detector and its restrictions
	DetectorDescription string `json:"detectorDescription,omitempty"`

	// Detector type, one of ( 'binary', 'multiclass').  Binary detectors only report positive cases.
	DetectorType string `json:"detectorType,omitempty"`

	// Set of possible classes for segments identified by this detector
	Classes []VbClass `json:"classes,omitempty"`

	// Set of possible parameters for this detector
	Parameters []VbParameterDefinition `json:"parameters,omitempty"`
}

type VbDetectorModelsResponse struct {
	Detectors []VbDetectorModel `json:"detectors,omitempty"`
}

type VbDiarization struct {
	Band string `json:"band,omitempty"`

	Env string `json:"env,omitempty"`

	Gender string `json:"gender,omitempty"`

	Length int64 `json:"length,omitempty"`

	SpeakerLabel string `json:"speakerLabel,omitempty"`

	Start int64 `json:"start,omitempty"`
}

type VbError struct {
	Code int32 `json:"code,omitempty"`

	Error_ string `json:"error,omitempty"`
}

type VbErrorResponse struct {

	// Status Code
	Status int32 `json:"status,omitempty"`

	// The errors
	Errors []VbError `json:"errors,omitempty"`

	// The warnings
	Warnings []VbMessage `json:"warnings,omitempty"`

	// ref.
	Reference string `json:"reference,omitempty"`
}

type VbFormattingConfiguration struct {

	// Whether number formatting is enabled or not
	EnableNumberFormatting bool `json:"enableNumberFormatting,omitempty"`
}

type VbFrequency struct {
	E float64 `json:"e,omitempty"`

	F float64 `json:"f,omitempty"`
}

type VbGroup struct {
	GroupName string `json:"groupName,omitempty"`

	Spotted bool `json:"spotted,omitempty"`

	Score float64 `json:"score,omitempty"`

	SpottedKeywords []VbKeyword `json:"spottedKeywords,omitempty"`
}

type VbHttpMethodEnum string

type VbIncludeTypeEnum string

type VbIngestConfiguration struct {

	// Speaker name. Defaults to \"Speaker\". If this attribute is specified, all channels are mixed into a single one.
	SpeakerName string `json:"speakerName,omitempty"`

	// A description of the speaker role. Only used as metadata.
	SpeakerRole string `json:"speakerRole,omitempty"`

	// List of channels to process, mutually exclusive with \"tracks\", \"stereo\" and \"speakerName\"
	Channels []VbChannelConfiguration `json:"channels,omitempty"`

	// Indicates to process two channels of the media.
	Stereo *VbStereoConfiguration `json:"stereo,omitempty"`

	// List of tracks to process, mutually exclusive with \"channels\", \"stereo\" and \"speakerName\"
	Tracks []VbTrackConfiguration `json:"tracks,omitempty"`
}

type VbJob struct {
	MediaId string `json:"mediaId,omitempty"`

	JobId string `json:"jobId,omitempty"`

	Progress *VbProgress `json:"progress,omitempty"`
}

type VbKey struct {
	Id string `json:"id,omitempty"`

	BearerToken string `json:"bearerToken,omitempty"`

	LastSix string `json:"lastSix,omitempty"`

	Issued time.Time `json:"issued,omitempty"`

	ExpirationDate time.Time `json:"expirationDate,omitempty"`

	Expired bool `json:"expired,omitempty"`

	Scope string `json:"scope,omitempty"`
}

type VbKeyConfiguration struct {

	// Number of milliseconds that the key must be valid for
	TtlMillis int64 `json:"ttlMillis,omitempty"`

	// Expiration date expressed in ISO-8601 format
	ExpirationDate time.Time `json:"expirationDate,omitempty"`

	Ephemeral bool `json:"ephemeral,omitempty"`

	// Restriction of the scope of the token in the form of media:get?extendedFilter=speakers:agent
	Scope string `json:"scope,omitempty"`
}

type VbKeysResponse struct {
	Keys []VbKey `json:"keys,omitempty"`
}

type VbKeyword struct {
	Keyword string `json:"keyword,omitempty"`

	Relevance float64 `json:"relevance,omitempty"`

	Mentions []VbMention `json:"mentions,omitempty"`
}

type VbKeywordGroup struct {
	GroupName string `json:"groupName,omitempty"`

	Keywords []string `json:"keywords,omitempty"`
}

type VbKeywordGroupsResponse struct {
	Groups []VbKeywordGroup `json:"groups,omitempty"`
}

type VbKnowledge struct {
	Keywords []VbKeyword `json:"keywords,omitempty"`

	Topics []VbTopic `json:"topics,omitempty"`
}

type VbKnowledgeConfiguration struct {

	// Whether knowledge discovery is enabled or not
	EnableDiscovery bool `json:"enableDiscovery,omitempty"`

	// Whether semantic discovery is allowed to use external data sources or not
	EnableExternalDataSources bool `json:"enableExternalDataSources,omitempty"`
}

type VbMedia struct {

	// Media format version. E.g. 3.0.1
	FormatVersion string `json:"formatVersion,omitempty"`

	// Media unique identifier.
	MediaId string `json:"mediaId,omitempty"`

	// Processing state.
	Status *VbStatusEnum `json:"status,omitempty"`

	// Creation timestamp
	DateCreated time.Time `json:"dateCreated,omitempty"`

	// User defined data associated with this record.
	Metadata *VbMetadata `json:"metadata,omitempty"`

	// The MIME type of the media submitted for processing. E.g. audio/x-wav, audio/mpeg
	MediaContentType string `json:"mediaContentType,omitempty"`

	// Duration of the audio/video submitted for processing expressed in milliseconds
	Length int64 `json:"length,omitempty"`

	// Semantic knowledge discovery section. If knoweledge discovery was requested, this section contains the results.
	Knowledge *VbKnowledge `json:"knowledge,omitempty"`

	// If kewyword spotting was requested, this section contains the results.
	Spotting *VbSpotting `json:"spotting,omitempty"`

	// If any predictions (classifiers, detectors) were requested, this section contains the results.
	Prediction *VbPrediction `json:"prediction,omitempty"`

	// This section contains the transcript in a variety of formats
	Transcript *VbTranscript `json:"transcript,omitempty"`

	// This section contains warnings about the media
	Warnings []VbMessage `json:"warnings,omitempty"`

	// Theaudio/video streams available.
	Streams []VbStream `json:"streams,omitempty"`

	Job *VbJob `json:"_job,omitempty"`
}

type VbMediaQueryResponse struct {
	Media []VbMediaSummary `json:"media,omitempty"`
}

type VbMediaSummary struct {

	// Media format version. E.g. 3.0.1
	FormatVersion string `json:"formatVersion,omitempty"`

	// Media unique identifier.
	MediaId string `json:"mediaId,omitempty"`

	// Processing state.
	Status *VbStatusEnum `json:"status,omitempty"`

	// Creation timestamp
	DateCreated time.Time `json:"dateCreated,omitempty"`

	// User defined data associated with this record.
	Metadata *VbMetadata `json:"metadata,omitempty"`
}

type VbMention struct {
	SpeakerName string `json:"speakerName,omitempty"`

	Occurrences []VbOccurrence `json:"occurrences,omitempty"`
}

type VbMessage struct {
	Code int32 `json:"code,omitempty"`

	Message string `json:"message,omitempty"`
}

type VbMetadata struct {
	Title string `json:"title,omitempty"`

	Description string `json:"description,omitempty"`

	ExternalId string `json:"externalId,omitempty"`

	Extended map[string]interface{} `json:"extended,omitempty"`
}

type VbOccurrence struct {
	S int64 `json:"s,omitempty"`

	E int64 `json:"e,omitempty"`

	Exact string `json:"exact,omitempty"`
}

type VbParameter struct {

	// Parameter name
	Parameter string `json:"parameter,omitempty"`

	// The value for a parameter.
	Value string `json:"value,omitempty"`
}

type VbParameterDefinition struct {
	Name string `json:"name,omitempty"`

	// whether the parameter is optional or not
	Optional bool `json:"optional,omitempty"`

	// Parameter type, one of ( \"String\", \"Integer\", \"Float\", \"Boolean\" )
	Type_ string `json:"type,omitempty"`

	// List of possible values for this parameter, only provided if there is a finite number of values accepted.
	ValueSet []string `json:"valueSet,omitempty"`

	DefaultValue string `json:"defaultValue,omitempty"`
}

type VbPrediction struct {
	Classifiers []VbClassifier `json:"classifiers,omitempty"`

	Detectors []VbDetector `json:"detectors,omitempty"`
}

type VbPredictionConfiguration struct {
	Classifiers []VbClassifierConfiguration `json:"classifiers,omitempty"`

	Detectors []VbDetectorConfiguration `json:"detectors,omitempty"`
}

type VbPriorityEnum string

type VbProgress struct {
	Finish string `json:"finish,omitempty"`

	JobId string `json:"jobId,omitempty"`

	Start string `json:"start,omitempty"`

	Status *VbTaskStatusEnum `json:"status,omitempty"`

	Tasks []VbProgressTask `json:"tasks,omitempty"`
}

type VbProgressTask struct {
	TaskId string `json:"taskId,omitempty"`

	Display string `json:"display,omitempty"`

	Phase string `json:"phase,omitempty"`

	Status *VbTaskStatusEnum `json:"status,omitempty"`

	Dependencies []string `json:"dependencies,omitempty"`

	Dependents []string `json:"dependents,omitempty"`
}

type VbPublishConfiguration struct {
	Callbacks []VbCallbackConfiguration `json:"callbacks,omitempty"`
}

type VbRedactorConfiguration struct {
	Transcript *VbTranscriptRedactorConfiguration `json:"transcript,omitempty"`

	Audio *VbAudioRedactorConfiguration `json:"audio,omitempty"`
}

type VbReference struct {
	Name string `json:"name,omitempty"`

	Score float64 `json:"score,omitempty"`
}

type VbSearchableFields struct {
	Fields []string `json:"fields,omitempty"`
}

type VbSpeechModelConfiguration struct {

	// Specifies the language using the ISO-639-1 standard two-letter code followed by a dash and a non-standarized region code.
	Language string `json:"language,omitempty"`

	// Allows to turn on additional features of the speech engine
	Features []string `json:"features,omitempty"`

	// This allows to request speech recognition with additional extensions for specific jargon or use cases with the purpose to improve transcription accuracy
	Extensions []string `json:"extensions,omitempty"`
}

type VbSpotting struct {
	Groups []VbGroup `json:"groups,omitempty"`
}

type VbSpottingConfiguration struct {

	// List of keyword spotting groups
	Groups []VbSpottingGroupConfiguration `json:"groups,omitempty"`
}

type VbSpottingGroupConfiguration struct {

	// Name of a pre-defined keyword spotting group
	GroupName string `json:"groupName,omitempty"`
}

type VbStatusEnum string

type VbStereoConfiguration struct {

	// Description of the speaker on the left channel (Channel 0)
	Left *VbChannelConfiguration `json:"left,omitempty"`

	// Description of the speaker on the right channel (Channel 1)
	Right *VbChannelConfiguration `json:"right,omitempty"`
}

type VbStream struct {
	Status int32 `json:"status,omitempty"`

	StreamName string `json:"streamName,omitempty"`

	StreamLocation string `json:"streamLocation,omitempty"`

	Comment string `json:"comment,omitempty"`
}

type VbStreams struct {
	Streams []VbStream `json:"streams,omitempty"`
}

type VbTaskStatusEnum string

type VbTopic struct {
	TopicName string `json:"topicName,omitempty"`

	Relevance float64 `json:"relevance,omitempty"`

	SubTopics []VbReference `json:"subTopics,omitempty"`

	Keywords []VbKeyword `json:"keywords,omitempty"`
}

type VbTrackConfiguration struct {

	// Track index.
	TrackIndex int32 `json:"trackIndex,omitempty"`

	// Speaker name. Defaults to \"Speaker\". If this attribute is specified, all channels are mixed into a single one.
	SpeakerName string `json:"speakerName,omitempty"`

	// A description of the speaker role. Only used as metadata.
	SpeakerRole string `json:"speakerRole,omitempty"`

	// List of channels to process, mutually exclusive with \"speakerName\"
	Channels []VbChannelConfiguration `json:"channels,omitempty"`
}

type VbTranscript struct {
	Confidence float64 `json:"confidence,omitempty"`

	Words []VbWord `json:"words,omitempty"`

	AlternateFormats []VbTranscriptFormat `json:"alternateFormats,omitempty"`
}

type VbTranscriptConfiguration struct {
	Formatting *VbFormattingConfiguration `json:"formatting,omitempty"`

	ContentFiltering *VbContentFilteringConfiguration `json:"contentFiltering,omitempty"`
}

type VbTranscriptFormat struct {
	Format string `json:"format,omitempty"`

	ContentType string `json:"contentType,omitempty"`

	ContentEncoding string `json:"contentEncoding,omitempty"`

	Charset string `json:"charset,omitempty"`

	Data string `json:"data,omitempty"`
}

type VbTranscriptRedactorConfiguration struct {

	// Sequence of characters to replace words within a transcript when reported by a detector
	Replacement string `json:"replacement,omitempty"`
}

type VbVocabulariesResponse struct {
	Vocabularies []VbVocabulary `json:"vocabularies,omitempty"`
}

type VbVocabulary struct {
	VocabularyName string `json:"vocabularyName,omitempty"`

	VocabularyType VbVocabularyType `json:"vocabularyType,omitempty"`

	Terms []VbVocabularyTerm `json:"terms,omitempty"`

	Scripts []VbVocabularyScript `json:"scripts,omitempty"`
}

type VbVocabularyConfiguration struct {
	VocabularyName string `json:"vocabularyName,omitempty"`

	Terms []VbVocabularyTermConfiguration `json:"terms,omitempty"`

	Scripts []VbVocabularyScriptConfiguration `json:"scripts,omitempty"`
}

type VbVocabularyScript struct {
	Script string `json:"script,omitempty"`
}

type VbVocabularyScriptConfiguration struct {
	Script string `json:"script,omitempty"`
}

type VbVocabularyTerm struct {
	Term string `json:"term,omitempty"`

	SoundsLike []string `json:"soundsLike,omitempty"`

	Weight int32 `json:"weight,omitempty"`
}

type VbVocabularyTermConfiguration struct {
	Term string `json:"term,omitempty"`

	SoundsLike []string `json:"soundsLike,omitempty"`

	Weight int32 `json:"weight,omitempty"`
}

type VbVocabularyType string

type VbWord struct {
	P int32 `json:"p,omitempty"`

	C float64 `json:"c,omitempty"`

	S int64 `json:"s,omitempty"`

	E int64 `json:"e,omitempty"`

	Frq []VbFrequency `json:"frq,omitempty"`

	M *VbWordTypeEnum `json:"m,omitempty"`

	V float64 `json:"v,omitempty"`

	W string `json:"w,omitempty"`
}

type VbWordTypeEnum string