interfaces

Documentation

Overview

This package provides the types for the Deepgram PreRecorded API.

Index

• func SecondsToTimestamp(seconds float64) string
• type Alternative
• type Average
• type Channel
• type Entity
• type ErrorResponse
• type Hit
• type Intent
• type Intents
• type IntentsInfo
• type Metadata
• type ModelInfo
• type Paragraph
• type Paragraphs
• type PreRecordedResponse
  • func (resp *PreRecordedResponse) ToSRT() (string, error)
  • func (resp *PreRecordedResponse) ToWebVTT() (string, error)
• type PreRecordedTranscriptionOptions
• type Result
• type Search
• type Segment
• type Sentence
• type SentimentInfo
• type Sentiments
• type Summaries
• type Summary
• type SummaryInfo
• type SummaryV1
• type SummaryV2
• type Topic
• type Topics
• type TopicsInfo
• type Translation
• type Utterance
• type Warning
• type Word

Functions

func SecondsToTimestamp

func SecondsToTimestamp(seconds float64) string

Types

type Alternative

type Alternative struct {
	Transcript  string       `json:"transcript,omitempty"`
	Confidence  float64      `json:"confidence,omitempty"`
	Words       []Word       `json:"words,omitempty"`
	Paragraphs  *Paragraphs  `json:"paragraphs,omitempty"`
	Entities    *[]Entity    `json:"entities,omitempty"`
	Summaries   *[]SummaryV1 `json:"summaries,omitempty"`
	Translation *Translation `json:"translation,omitempty"`
}

type Average

type Average struct {
	Sentiment      string  `json:"sentiment,omitempty"`
	SentimentScore float64 `json:"sentiment_score,omitempty"`
}

type Channel

type Channel struct {
	Search             *[]Search     `json:"search,omitempty"`
	Alternatives       []Alternative `json:"alternatives,omitempty"`
	DetectedLanguage   string        `json:"detected_language,omitempty"`
	LanguageConfidence float64       `json:"language_confidence,omitempty"`
}

type Entity

type Entity struct {
	Label      string  `json:"label,omitempty"`
	Value      string  `json:"value,omitempty"`
	Confidence float64 `json:"confidence,omitempty"`
	StartWord  float64 `json:"start_word,omitempty"`
	EndWord    float64 `json:"end_word,omitempty"`
}

type ErrorResponse

type ErrorResponse interfaces.DeepgramError

ErrorResponse is the Deepgram specific response error

type Hit

type Hit struct {
	Confidence float64 `json:"confidence,omitempty"`
	Start      float64 `json:"start,omitempty"`
	End        float64 `json:"end,omitempty"`
	Snippet    string  `json:"snippet,omitempty"`
}

type Intent

type Intent struct {
	Intent          string  `json:"intent,omitempty"`
	ConfidenceScore float64 `json:"confidence_score,omitempty"`
}

type Intents

type Intents struct {
	Segments []Segment `json:"segments,omitempty"`
}

type IntentsInfo

type IntentsInfo struct {
	ModelUUID    string `json:"model_uuid,omitempty"`
	InputTokens  int    `json:"input_tokens,omitempty"`
	OutputTokens int    `json:"output_tokens,omitempty"`
}

type Metadata

type Metadata struct {
	TransactionKey string               `json:"transaction_key,omitempty"`
	RequestID      string               `json:"request_id,omitempty"`
	Sha256         string               `json:"sha256,omitempty"`
	Created        string               `json:"created,omitempty"`
	Duration       float64              `json:"duration,omitempty"`
	Channels       int                  `json:"channels,omitempty"`
	Models         []string             `json:"models,omitempty"`
	ModelInfo      map[string]ModelInfo `json:"model_info,omitempty"`
	Warnings       *[]Warning           `json:"warnings,omitempty"`
	SummaryInfo    *SummaryInfo         `json:"summary_info,omitempty"`
	IntentsInfo    *IntentsInfo         `json:"intents_info,omitempty"`
	SentimentInfo  *SentimentInfo       `json:"sentiment_info,omitempty"`
	TopicsInfo     *TopicsInfo          `json:"topics_info,omitempty"`
	Extra          map[string]string    `json:"extra,omitempty"`
}

type ModelInfo

type ModelInfo struct {
	Name    string `json:"name,omitempty"`
	Version string `json:"version,omitempty"`
	Arch    string `json:"arch,omitempty"`
}

type Paragraph

type Paragraph struct {
	Sentences      []Sentence `json:"sentences,omitempty"`
	NumWords       int        `json:"num_words,omitempty"`
	Start          float64    `json:"start,omitempty"`
	End            float64    `json:"end,omitempty"`
	Speaker        *int       `json:"speaker,omitempty"`
	Sentiment      *string    `json:"sentiment,omitempty"`
	SentimentScore *float64   `json:"sentiment_score,omitempty"`
}

type Paragraphs

type Paragraphs struct {
	Transcript string      `json:"transcript,omitempty"`
	Paragraphs []Paragraph `json:"paragraphs,omitempty"`
}

type PreRecordedResponse

type PreRecordedResponse struct {
	RequestID string    `json:"request_id,omitempty"` // for ?callback=...
	Metadata  *Metadata `json:"metadata,omitempty"`
	Results   *Result   `json:"results,omitempty"`
}

********************************* response/result structs ********************************* PreRecordedResponse is the PreRecorded Transcription

func (*PreRecordedResponse) ToSRT

func (resp *PreRecordedResponse) ToSRT() (string, error)

ToSRT implements output for SRT

func (*PreRecordedResponse) ToWebVTT

func (resp *PreRecordedResponse) ToWebVTT() (string, error)

ToWebVTT implements output for VTT

type PreRecordedTranscriptionOptions

type PreRecordedTranscriptionOptions interfaces.PreRecordedTranscriptionOptions

********************************* Request/Input structs *********************************

type Result

type Result struct {
	Channels   []Channel   `json:"channels,omitempty"`
	Utterances []Utterance `json:"utterances,omitempty"`
	Summary    *SummaryV2  `json:"summary,omitempty"`
	Sentiments *Sentiments `json:"sentiments,omitempty"`
	Topics     *Topics     `json:"topics,omitempty"`
	Intents    *Intents    `json:"intents,omitempty"`
}

type Search

type Search struct {
	Query string `json:"query,omitempty"`
	Hits  []Hit  `json:"hits,omitempty"`
}

type Segment

type Segment struct {
	Text           string    `json:"text,omitempty"`
	StartWord      int       `json:"start_word,omitempty"`
	EndWord        int       `json:"end_word,omitempty"`
	Sentiment      *string   `json:"sentiment,omitempty"`
	SentimentScore *float64  `json:"sentiment_score,omitempty"`
	Topics         *[]Topic  `json:"topics,omitempty"`
	Intents        *[]Intent `json:"intents,omitempty"`
}

type Sentence

type Sentence struct {
	Text           string   `json:"text,omitempty"`
	Start          float64  `json:"start,omitempty"`
	End            float64  `json:"end,omitempty"`
	Sentiment      *string  `json:"sentiment,omitempty"`
	SentimentScore *float64 `json:"sentiment_score,omitempty"`
}

type SentimentInfo

type SentimentInfo struct {
	ModelUUID    string `json:"model_uuid,omitempty"`
	InputTokens  int    `json:"input_tokens,omitempty"`
	OutputTokens int    `json:"output_tokens,omitempty"`
}

type Sentiments

type Sentiments struct {
	Segments []Segment `json:"segments,omitempty"`
	Average  Average   `json:"average,omitempty"`
}

type Summaries

type Summaries SummaryV1 // internal reference to old name

type Summary

type Summary SummaryV2 // internal reference to old name

type SummaryInfo

type SummaryInfo struct {
	InputTokens  int    `json:"input_tokens,omitempty"`
	OutputTokens int    `json:"output_tokens,omitempty"`
	ModelUUID    string `json:"model_uuid,omitempty"`
}

********************************* share/common structs *********************************

type SummaryV1

type SummaryV1 struct {
	Summary   string `json:"summary,omitempty"`
	StartWord int    `json:"start_word,omitempty"`
	EndWord   int    `json:"end_word,omitempty"`
}

type SummaryV2

type SummaryV2 struct {
	Short  string `json:"short,omitempty"`
	Result string `json:"result,omitempty"`
}

type Topic

type Topic struct {
	Topic           string  `json:"topic,omitempty"`
	ConfidenceScore float64 `json:"confidence_score,omitempty"`
}

type Topics

type Topics struct {
	Segments []Segment `json:"segments,omitempty"`
}

type TopicsInfo

type TopicsInfo struct {
	ModelUUID    string `json:"model_uuid,omitempty"`
	InputTokens  int    `json:"input_tokens,omitempty"`
	OutputTokens int    `json:"output_tokens,omitempty"`
}

type Translation

type Translation struct {
	Language    string `json:"language,omitempty"`
	Translation string `json:"translation,omitempty"`
}

type Utterance

type Utterance struct {
	Start          float64  `json:"start,omitempty"`
	End            float64  `json:"end,omitempty"`
	Confidence     float64  `json:"confidence,omitempty"`
	Channel        int      `json:"channel,omitempty"`
	Transcript     string   `json:"transcript,omitempty"`
	Words          []Word   `json:"words,omitempty"`
	Speaker        *int     `json:"speaker,omitempty"`
	Sentiment      *string  `json:"sentiment,omitempty"`
	SentimentScore *float64 `json:"sentiment_score,omitempty"`
	ID             string   `json:"id,omitempty"`
}

type Warning

type Warning struct {
	Parameter string `json:"parameter,omitempty"`
	Type      string `json:"type,omitempty"`
	Message   string `json:"message,omitempty"`
}

type Word

type Word struct {
	Word              string   `json:"word,omitempty"`
	Start             float64  `json:"start,omitempty"`
	End               float64  `json:"end,omitempty"`
	Confidence        float64  `json:"confidence,omitempty"`
	Speaker           *int     `json:"speaker,omitempty"`
	SpeakerConfidence *float64 `json:"speaker_confidence,omitempty"`
	PunctuatedWord    string   `json:"punctuated_word,omitempty"`
	Sentiment         *string  `json:"sentiment,omitempty"`
	SentimentScore    *float64 `json:"sentiment_score,omitempty"`
}