interfaces

Documentation

Overview

TODO: Need to look into this before the v1 release

Index

• type Alternative
• type Channel
• type Entity
• type Hit
• type Metadata
• type Paragraph
• type Paragraphs
• type PreRecordedResponse
• type Result
• type Search
• type Sentence
• type Summaries
• type Summary
• type SummaryV1
• type SummaryV2
• type Topic
• type Topics
• type Utterance
• type Warning
• type Word

Types

type Alternative

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

type Channel

type Channel struct {
	Search           []Search      `json:"search,omitempty"`
	Alternatives     []Alternative `json:"alternatives,omitempty"`
	DetectedLanguage string        `json:"detected_language,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 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 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]struct {
		Name    string `json:"name,omitempty"`
		Version string `json:"version,omitempty"`
		Arch    string `json:"arch,omitempty"`
	} `json:"model_info,omitempty"`
	Warnings []Warning `json:"warnings,omitempty"`
}

share/common structs

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"`
}

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

type Result

type Result struct {
	Channels   []Channel   `json:"channels,omitempty"`
	Utterances []Utterance `json:"utterances,omitempty"`
	Summary    SummaryV2   `json:"summary,omitempty"`
}

type Search

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

type Sentence

type Sentence struct {
	Text  string  `json:"text,omitempty"`
	Start float64 `json:"start,omitempty"`
	End   float64 `json:"end,omitempty"`
}

type Summaries

type Summaries SummaryV1 // internal reference to old name

type Summary

type Summary SummaryV2 // internal reference to old name

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"`
	Confidence float64 `json:"confidence,omitempty"`
}

type Topics

type Topics struct {
	Text      string  `json:"text,omitempty"`
	StartWord int     `json:"start_word,omitempty"`
	EndWord   int     `json:"end_word,omitempty"`
	Topics    []Topic `json:"topics,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"`
	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"`
}