schemas

package
v1.17.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 3, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Copyright © 2022 AssemblyAI support@assemblyai.com

Index

Constants

This section is empty.

Variables

View Source 
var LanguageMap = map[string]string{
	"en":    "Global English",
	"en-au": "Australian English",
	"en_uk": "British English",
	"en-US": "US English",
	"es":    "Spanish",
	"fr":    "French",
	"de":    "German",
	"it":    "Italian",
	"pt":    "Portuguese",
	"nl":    "Dutch",
	"hi":    "Hindi",
	"ja":    "Japanese",
}
View Source 
var PIIRedactionPolicyMap = map[string]string{
	"banking_information":       "Banking Information",
	"blood_type":                "Blood Type",
	"credit_card_cvv":           "Credit Card CVV",
	"credit_card_expiration":    "Credit Card Expiration",
	"credit_card_number":        "Credit Card Number",
	"date":                      "Date",
	"drivers_license":           "Drivers License",
	"drug":                      "Drug",
	"email_address":             "Email Address",
	"event":                     "Event",
	"injury":                    "Injury",
	"language":                  "Language",
	"location":                  "Location",
	"medical_condition":         "Medical Condition",
	"medical_process":           "Medical Process",
	"money_amount":              "Money Amount",
	"nationality":               "Nationality",
	"number_sequence":           "Number Sequence",
	"occupation":                "Occupation",
	"organization":              "Organization",
	"person_age":                "Person Age",
	"person_name":               "Person Name",
	"phone_number":              "Phone Number",
	"political_affiliation":     "Political Affiliation",
	"religion":                  "Religion",
	"us_social_security_number": "US Social Security Number",
}
View Source 
var SummarizationModelMap = map[string][]string{
	"conversational": {"headline", "paragraph", "bullets", "bullets_verbose"},
	"catchy":         {"gist", "headline"},
	"informative":    {"headline", "paragraph", "bullets", "bullets_verbose"},
}
View Source 
var SummarizationTypeMap = map[string]string{
	"paragraph":       "Paragraph",
	"headline":        "Headline",
	"gist":            "Gist",
	"bullets":         "Bullets",
	"bullets_verbose": "Bullets Verbose",
}
View Source 
var SummarizationTypeMapReverse = map[string]string{
	"paragraph":       "Paragraph",
	"headline":        "Headline",
	"gist":            "Gist",
	"bullets":         "Bullets",
	"bullets_verbose": "Bullets Verbose",
}
View Source 
var ValidFileTypes = []string{
	"3ga",
	"8svx",
	"aac",
	"ac3",
	"aif",
	"aiff",
	"alac",
	"amr",
	"ape",
	"au",
	"dss",
	"flac",
	"flv",
	"m4a",
	"m4b",
	"m4p",
	"m4r",
	"mp3",
	"mpga",
	"ogg",
	"oga",
	"mogg",
	"opus",
	"qcp",
	"tta",
	"voc",
	"wav",
	"wma",
	"wv",
	"webm",
	"MTS",
	"M2TS",
	"TS",
	"mov",
	"mp2",
	"mp4",
	"m4p",
	"m4v",
	"mxf",
}

Functions

This section is empty.

Types

type Account 

type Account struct {
	Error          *string        `json:"error,omitempty"`
	IsVerified     bool           `json:"is_verified"`
	CurrentBalance CurrentBalance `json:"current_balance"`
	Id             *int           `json:"id,omitempty"`
}

type AutoHighlightsResult 

type AutoHighlightsResult struct {
	Results []AutoHighlightsResultResult `json:"results,omitempty"`
	Status  *string                      `json:"status,omitempty"`
}

type AutoHighlightsResultResult 

type AutoHighlightsResultResult struct {
	Count      *int64      `json:"count,omitempty"`
	Rank       *float64    `json:"rank,omitempty"`
	Text       string      `json:"text,omitempty"`
	Timestamps []Timestamp `json:"timestamps,omitempty"`
}

type Chapter 

type Chapter struct {
	Summary  string `json:"summary,omitempty"`
	Headline string `json:"headline,omitempty"`
	Gist     string `json:"gist,omitempty"`
	Start    *int64 `json:"start,omitempty"`
	End      *int64 `json:"end,omitempty"`
}

type CheckIfTokenValidResponse 

type CheckIfTokenValidResponse struct {
	IsVerified     bool   `json:"is_verified"`
	CurrentBalance string `json:"current_balance"`
}

type Client 

type Client struct {
	Hl                string `json:"hl"`
	ClientName        string `json:"clientName"`
	ClientVersion     string `json:"clientVersion"`
	AndroidSDKVersion int64  `json:"androidSdkVersion"`
	UserAgent         string `json:"userAgent"`
	TimeZone          string `json:"timeZone"`
	UtcOffsetMinutes  int64  `json:"utcOffsetMinutes"`
}

type ContentPlaybackContext 

type ContentPlaybackContext struct {
	Html5Preference string `json:"html5Preference"`
}

type ContentSafetyLabels 

type ContentSafetyLabels struct {
	Status               *string                     `json:"status,omitempty"`
	Results              []ContentSafetyLabelsResult `json:"results,omitempty"`
	Summary              *Summary                    `json:"summary,omitempty"`
	SeverityScoreSummary *SeverityScoreSummary       `json:"severity_score_summary,omitempty"`
}

type ContentSafetyLabelsResult 

type ContentSafetyLabelsResult struct {
	Text      string     `json:"text,omitempty"`
	Labels    []Label    `json:"labels,omitempty"`
	Timestamp *Timestamp `json:"timestamp,omitempty"`
}

type Context 

type Context struct {
	Client Client `json:"client"`
}

type CurrentBalance 

type CurrentBalance struct {
	Amount   float64 `json:"amount"`
	Currency string  `json:"currency"`
}

type CustomSpelling added in v1.12.1 

type CustomSpelling struct {
	From []string `json:"from"`
	To   string   `json:"to"`
}

type Entity 

type Entity struct {
	EntityType string `json:"entity_type,omitempty"`
	Text       string `json:"text,omitempty"`
	Start      *int64 `json:"start,omitempty"`
	End        *int64 `json:"end,omitempty"`
}

type FluffyLabel 

type FluffyLabel struct {
	Relevance *float64 `json:"relevance,omitempty"`
	Label     string   `json:"label,omitempty"`
}

type Format 

type Format struct {
	Itag             *int64       `json:"itag,omitempty"`
	URL              *string      `json:"url,omitempty"`
	MIMEType         *string      `json:"mimeType,omitempty"`
	Bitrate          *int64       `json:"bitrate,omitempty"`
	Width            *int64       `json:"width,omitempty"`
	Height           *int64       `json:"height,omitempty"`
	InitRange        *interface{} `json:"initRange,omitempty"`
	IndexRange       *interface{} `json:"indexRange,omitempty"`
	LastModified     *string      `json:"lastModified,omitempty"`
	ContentLength    *string      `json:"contentLength,omitempty"`
	Quality          *string      `json:"quality,omitempty"`
	FPS              *int64       `json:"fps,omitempty"`
	QualityLabel     *string      `json:"qualityLabel,omitempty"`
	ProjectionType   *interface{} `json:"projectionType,omitempty"`
	AverageBitrate   *int64       `json:"averageBitrate,omitempty"`
	ApproxDurationMS *string      `json:"approxDurationMs,omitempty"`
	ColorInfo        *interface{} `json:"colorInfo,omitempty"`
	HighReplication  *bool        `json:"highReplication,omitempty"`
	AudioQuality     *string      `json:"audioQuality,omitempty"`
	AudioSampleRate  *string      `json:"audioSampleRate,omitempty"`
	AudioChannels    *int64       `json:"audioChannels,omitempty"`
	LoudnessDB       *float64     `json:"loudnessDb,omitempty"`
	SignatureCipher  *string      `json:"signatureCipher,omitempty"`
}

type IabCategoriesResult 

type IabCategoriesResult struct {
	Status  *string                     `json:"status,omitempty"`
	Results []IabCategoriesResultResult `json:"results,omitempty"`
	Summary map[string]float64          `json:"summary,omitempty"`
}

type IabCategoriesResultResult 

type IabCategoriesResultResult struct {
	Text      string        `json:"text,omitempty"`
	Labels    []FluffyLabel `json:"labels,omitempty"`
	Timestamp *Timestamp    `json:"timestamp,omitempty"`
}

type Label 

type Label struct {
	Label      string   `json:"label,omitempty"`
	Confidence *float64 `json:"confidence,omitempty"`
	Severity   *float64 `json:"severity"`
}

type PlayabilityStatus 

type PlayabilityStatus struct {
	Status          *string      `json:"status,omitempty"`
	Reason          *string      `json:"reason,omitempty"`
	PlayableInEmbed *bool        `json:"playableInEmbed,omitempty"`
	Miniplayer      *interface{} `json:"miniplayer,omitempty"`
	ContextParams   *string      `json:"contextParams,omitempty"`
}

type PlaybackContext 

type PlaybackContext struct {
	ContentPlaybackContext ContentPlaybackContext `json:"contentPlaybackContext"`
}

type PostHogProperties 

type PostHogProperties struct {
	Poll              bool   `json:"poll,omitempty"`
	Json              bool   `json:"json,omitempty"`
	SpeakerLabels     bool   `json:"speaker_labels,omitempty"`
	Punctuate         bool   `json:"punctuate,omitempty"`
	FormatText        bool   `json:"format_text,omitempty"`
	DualChannel       *bool  `json:"dual_channel,omitempty"`
	RedactPii         bool   `json:"redact_pii,omitempty"`
	AutoHighlights    bool   `json:"auto_highlights,omitempty"`
	ContentModeration bool   `json:"content_safety,omitempty"`
	TopicDetection    bool   `json:"iab_categories,omitempty"`
	SentimentAnalysis bool   `json:"sentiment_analysis,omitempty"`
	AutoChapters      bool   `json:"auto_chapters,omitempty"`
	EntityDetection   bool   `json:"entity_detection,omitempty"`
	Version           string `json:"version,omitempty"`
	OS                string `json:"os,omitempty"`
	Arch              string `json:"arch,omitempty"`
	Method            string `json:"method,omitempty"`
	I                 bool   `json:"i,omitempty"`
	LatestVersion     string `json:"latest_version,omitempty"`
}

type PrintErrorProps 

type PrintErrorProps struct {
	Error   error
	Message string
}

type Profanity 

type Profanity struct {
	Low    json.Number `json:"low,omitempty"`
	Medium json.Number `json:"medium,omitempty"`
	High   json.Number `json:"high,omitempty"`
}

type RedactPiiPolicy 

type RedactPiiPolicy string
const (
	MedicalProcess         RedactPiiPolicy = "medical_process"
	MedicalCondition       RedactPiiPolicy = "medical_condition"
	BloodType              RedactPiiPolicy = "blood_type"
	Drug                   RedactPiiPolicy = "drug"
	Injury                 RedactPiiPolicy = "injury"
	NumberSequence         RedactPiiPolicy = "number_sequence"
	EmailAddress           RedactPiiPolicy = "email_address"
	DateOfBirth            RedactPiiPolicy = "date_of_birth"
	PhoneNumber            RedactPiiPolicy = "phone_number"
	USSocialSecurityNumber RedactPiiPolicy = "us_social_security_number"
	CreditCardNumber       RedactPiiPolicy = "credit_card_number"
	CreditCardExpiration   RedactPiiPolicy = "credit_card_expiration"
	Date                   RedactPiiPolicy = "date"
	Nationality            RedactPiiPolicy = "nationality"
	Event                  RedactPiiPolicy = "event"
	Language               RedactPiiPolicy = "language"
	Location               RedactPiiPolicy = "location"
	MoneyAmount            RedactPiiPolicy = "money_amount"
	PersonName             RedactPiiPolicy = "person_name"
	PersonAge              RedactPiiPolicy = "person_age"
	Organization           RedactPiiPolicy = "organization"
	PoliticalAffiliation   RedactPiiPolicy = "political_affiliation"
	Occupation             RedactPiiPolicy = "occupation"
	Religion               RedactPiiPolicy = "religion"
	DriversLicense         RedactPiiPolicy = "drivers_license"
	BankingInformation     RedactPiiPolicy = "banking_information"
)

type Release added in v1.12.1 

type Release struct {
	URL              *string      `json:"url,omitempty"`
	AssetsURL        *string      `json:"assets_url,omitempty"`
	UploadURL        *string      `json:"upload_url,omitempty"`
	HTMLURL          *string      `json:"html_url,omitempty"`
	ID               *int64       `json:"id,omitempty"`
	Author           *interface{} `json:"author,omitempty"`
	NodeID           *string      `json:"node_id,omitempty"`
	TagName          *string      `json:"tag_name,omitempty"`
	TargetCommitish  *string      `json:"target_commitish,omitempty"`
	Name             *string      `json:"name,omitempty"`
	Draft            *bool        `json:"draft,omitempty"`
	Prerelease       *bool        `json:"prerelease,omitempty"`
	CreatedAt        *string      `json:"created_at,omitempty"`
	PublishedAt      *string      `json:"published_at,omitempty"`
	Assets           *interface{} `json:"assets,omitempty"`
	TarballURL       *string      `json:"tarball_url,omitempty"`
	ZipballURL       *string      `json:"zipball_url,omitempty"`
	Body             *string      `json:"body,omitempty"`
	Message          *string      `json:"message,omitempty"`
	DocumentationUrl *string      `json:"documentation_url,omitempty"`
}

type SentimentAnalysisResult 

type SentimentAnalysisResult struct {
	Channel    string                    `json:"channel,omitempty"`
	Text       string                    `json:"text,omitempty"`
	Start      *int64                    `json:"start,omitempty"`
	End        *int64                    `json:"end,omitempty"`
	Sentiment  string                    `json:"sentiment,omitempty"`
	Confidence *float64                  `json:"confidence,omitempty"`
	Speaker    string                    `json:"speaker,omitempty"`
	Words      []SentimentAnalysisResult `json:"words,omitempty"`
}

type SeverityScoreSummary 

type SeverityScoreSummary struct {
	Profanity *Profanity `json:"profanity,omitempty"`
}

type StreamingData 

type StreamingData struct {
	ExpiresInSeconds *string  `json:"expiresInSeconds,omitempty"`
	Formats          []Format `json:"formats,omitempty"`
	AdaptiveFormats  []Format `json:"adaptiveFormats,omitempty"`
}

type Summary 

type Summary struct {
	Profanity *float64 `json:"profanity,omitempty"`
	Nsfw      *float64 `json:"nsfw,omitempty"`
}

type SummaryObject added in v1.17.1 

type SummaryObject struct {
	Summary  string `json:"summary"`
	Headline string `json:"headline"`
	Gist     string `json:"gist"`
	Start    int    `json:"start"`
	End      int    `json:"end"`
}

type Timestamp 

type Timestamp struct {
	Start *int64 `json:"start,omitempty"`
	End   *int64 `json:"end,omitempty"`
}

type TranscribeFlags 

type TranscribeFlags struct {
	Poll bool `json:"poll"`
	Json bool `json:"json"`
	Srt  bool `json:"srt"`
}

type TranscribeParams 

type TranscribeParams struct {
	AudioURL               string           `json:"audio_url"`
	AutoChapters           bool             `json:"auto_chapters"`
	AutoHighlights         bool             `json:"auto_highlights"`
	BoostParam             *string          `json:"boost_param,omitempty"`
	ContentModeration      bool             `json:"content_safety"`
	CustomSpelling         []CustomSpelling `json:"custom_spelling,omitempty"`
	DualChannel            bool             `json:"dual_channel"`
	Disfluencies           bool             `json:"disfluencies"`
	EntityDetection        bool             `json:"entity_detection"`
	FormatText             bool             `json:"format_text"`
	LanguageCode           *string          `json:"language_code,omitempty"`
	LanguageDetection      bool             `json:"language_detection"`
	Punctuate              bool             `json:"punctuate"`
	RedactPii              bool             `json:"redact_pii"`
	RedactPiiPolicies      []string         `json:"redact_pii_policies"`
	SentimentAnalysis      bool             `json:"sentiment_analysis"`
	SpeakerLabels          bool             `json:"speaker_labels"`
	Summarization          bool             `json:"summarization,omitempty"`
	SummaryModel           string           `json:"summary_model,omitempty"`
	SummaryType            string           `json:"summary_type,omitempty"`
	TopicDetection         bool             `json:"iab_categories"`
	WebhookAuthHeaderName  string           `json:"webhook_auth_header_name,omitempty"`
	WebhookAuthHeaderValue string           `json:"webhook_auth_header_value,omitempty"`
	WebhookURL             string           `json:"webhook_url,omitempty"`
	WordBoost              []string         `json:"word_boost,omitempty"`
}

type TranscriptResponse 

type TranscriptResponse struct {
	AcousticModel            *string                    `json:"acoustic_model,omitempty"`
	AudioDuration            *int64                     `json:"audio_duration,omitempty"`
	AudioEndAt               *interface{}               `json:"audio_end_at,omitempty"`
	AudioStartFrom           *interface{}               `json:"audio_start_from,omitempty"`
	AudioURL                 *string                    `json:"audio_url,omitempty"`
	AutoChapters             *bool                      `json:"auto_chapters,omitempty"`
	AutoHighlights           *bool                      `json:"auto_highlights,omitempty"`
	AutoHighlightsResult     *AutoHighlightsResult      `json:"auto_highlights_result,omitempty"`
	BoostParam               interface{}                `json:"boost_param"`
	Chapters                 *[]Chapter                 `json:"chapters,omitempty"`
	ClusterID                interface{}                `json:"cluster_id"`
	Confidence               *float64                   `json:"confidence,omitempty"`
	ContentSafety            *bool                      `json:"content_safety,omitempty"`
	ContentSafetyLabels      *ContentSafetyLabels       `json:"content_safety_labels,omitempty"`
	CustomSpelling           interface{}                `json:"custom_spelling"`
	Disfluencies             *bool                      `json:"disfluencies,omitempty"`
	DualChannel              *bool                      `json:"dual_channel,omitempty"`
	Entities                 *[]Entity                  `json:"entities,omitempty"`
	EntityDetection          *bool                      `json:"entity_detection,omitempty"`
	Error                    *string                    `json:"error,omitempty"`
	FilterProfanity          *bool                      `json:"filter_profanity,omitempty"`
	FormatText               *bool                      `json:"format_text,omitempty"`
	IabCategories            *bool                      `json:"iab_categories,omitempty"`
	IabCategoriesResult      *IabCategoriesResult       `json:"iab_categories_result,omitempty"`
	ID                       *string                    `json:"id,omitempty"`
	LanguageCode             *string                    `json:"language_code,omitempty"`
	LanguageDetection        *bool                      `json:"language_detection,omitempty"`
	LanguageModel            *string                    `json:"language_model,omitempty"`
	Punctuate                *bool                      `json:"punctuate,omitempty"`
	RedactPii                *bool                      `json:"redact_pii,omitempty"`
	RedactPiiAudio           *bool                      `json:"redact_pii_audio,omitempty"`
	RedactPiiAudioQuality    interface{}                `json:"redact_pii_audio_quality"`
	RedactPiiPolicies        interface{}                `json:"redact_pii_policies"`
	RedactPiiSub             interface{}                `json:"redact_pii_sub"`
	SentimentAnalysis        *bool                      `json:"sentiment_analysis,omitempty"`
	SentimentAnalysisResults *[]SentimentAnalysisResult `json:"sentiment_analysis_results,omitempty"`
	SpeakerLabels            bool                       `json:"speaker_labels,omitempty"`
	SpeedBoost               *bool                      `json:"speed_boost,omitempty"`
	Status                   *string                    `json:"status,omitempty"`
	Summarization            *bool                      `json:"summarization,omitempty"`
	Summary                  *interface{}               `json:"summary,omitempty"`
	SummaryType              *string                    `json:"summary_type,omitempty"`
	Text                     *string                    `json:"text,omitempty"`
	Throttled                interface{}                `json:"throttled"`
	Utterances               *[]SentimentAnalysisResult `json:"utterances,omitempty"`
	WebhookAuth              *bool                      `json:"webhook_auth,omitempty"`
	WebhookAuthHeaderName    interface{}                `json:"webhook_auth_header_name"`
	WebhookStatusCode        interface{}                `json:"webhook_status_code"`
	WebhookURL               interface{}                `json:"webhook_url"`
	WordBoost                []interface{}              `json:"word_boost,omitempty"`
	Words                    []SentimentAnalysisResult  `json:"words,omitempty"`
}

type UploadResponse 

type UploadResponse struct {
	UploadURL string `json:"upload_url"`
}

type YoutubeBodyMetaInfo 

type YoutubeBodyMetaInfo struct {
	Context         Context         `json:"context"`
	VideoID         string          `json:"videoId"`
	Params          string          `json:"params"`
	PlaybackContext PlaybackContext `json:"playbackContext"`
	RacyCheckOk     bool            `json:"racyCheckOk"`
	ContentCheckOk  bool            `json:"contentCheckOk"`
}

type YoutubeMetaInfo 

type YoutubeMetaInfo struct {
	AdPlacements      []interface{}      `json:"adPlacements,omitempty"`
	Annotations       []interface{}      `json:"annotations,omitempty"`
	Attestation       *interface{}       `json:"attestation,omitempty"`
	Captions          *interface{}       `json:"captions,omitempty"`
	Endscreen         *interface{}       `json:"endscreen,omitempty"`
	FrameworkUpdates  *interface{}       `json:"frameworkUpdates,omitempty"`
	Microformat       *interface{}       `json:"microformat,omitempty"`
	PlayabilityStatus *PlayabilityStatus `json:"playabilityStatus,omitempty"`
	PlaybackTracking  *interface{}       `json:"playbackTracking,omitempty"`
	PlayerAds         []interface{}      `json:"playerAds,omitempty"`
	PlayerConfig      *interface{}       `json:"playerConfig,omitempty"`
	ResponseContext   *interface{}       `json:"responseContext,omitempty"`
	Storyboards       *interface{}       `json:"storyboards,omitempty"`
	StreamingData     *StreamingData     `json:"streamingData,omitempty"`
	TrackingParams    *string            `json:"trackingParams,omitempty"`
	VideoDetails      *interface{}       `json:"videoDetails,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.