textapi

type Aspect struct {
	Aspect             string  `json:"aspect"`
	AspectConfidence   float32 `json:"aspect_confidence"`
	Polarity           string  `json:"polarity"`
	PolarityConfidence float32 `json:"polarity_confidence"`
}

type AspectBasedSentimentParams struct {
	// Either URL or Text is required.
	Text string
	URL  string

	// The domain that document belongs to.
	Domain string
}

type AspectBasedSentimentResponse struct {
	Text      string   `json:"text"`
	Domain    string   `json:"domain"`
	Aspects   []Aspect `json:"aspects"`
	Sentences []struct {
		Text               string   `json:"text"`
		Polarity           string   `json:"polarity"`
		PolarityConfidence float32  `json:"polarity_confidence"`
		Aspects            []Aspect `json:"aspects"`
	} `json:"sentences"`
}

type Auth struct {
	// ApplicationID and ApplicationKey identify the client using Text API.
	// These fields are always required
	ApplicationID  string
	ApplicationKey string
}

type Category struct {
	// IPTC SubjectCode
	Code       string  `json:"code"`
	Label      string  `json:"label"`
	Confidence float32 `json:"confidence"`
}

type ClassifyByTaxonomyParams struct {
	// Either URL or Text is required.
	URL  string
	Text string

	// Valid languages are en, de, fr, es, it, pt and auto.
	// Default is en.
	Language string

	// Valid taxonomies are iab-qag and iptc-subjectcode.
	Taxonomy string
}

type ClassifyByTaxonomyResponse struct {
	Text       string `json:"text"`
	Language   string `json:"language"`
	Taxonomy   string `json:"taxonomy"`
	Categories []struct {
		Id        string  `json:"id"`
		Label     string  `json:"label"`
		Score     float32 `json:"score"`
		Confident bool    `json:"confident"`
		Links     []struct {
			Link string `json:"link"`
			Rel  string `json:"rel"`
		} `json:"links"`
	} `json:"categories"`
}

type ClassifyParams struct {
	// Either URL or Text is required.
	URL  string
	Text string

	// Valid languages are en, de, fr, es, it, pt and auto.
	// Default is en.
	Language string
}

type ClassifyResponse struct {
	Text       string     `json:"text"`
	Language   string     `json:"language"`
	Categories []Category `json:"categories"`
}

type Client struct {
	RateLimits *RateLimits
	// contains filtered or unexported fields
}

type CombinedParams struct {
	URL       string
	Text      string
	Endpoints []string
}

type CombinedResponse struct {
	Text            string
	Article         ExtractResponse
	Summary         SummarizeResponse
	Concepts        ConceptsResponse
	Entities        EntitiesResponse
	Hashtags        HashtagsResponse
	Language        LanguageResponse
	Sentiment       SentimentResponse
	Classifications ClassifyResponse
}

type Concept struct {
	SurfaceForms []SurfaceForm `json:"surfaceForms"`
	Types        []string      `json:"types"`
	Support      int           `json:"support"`
}

type ConceptsParams struct {
	// Either URL or Text is required.
	URL  string
	Text string

	// Valid languages are en, de, fr, es, it, pt and auto.
	// Default is en.
	Language string
}

type ConceptsResponse struct {
	Text     string             `json:"text"`
	Language string             `json:"language"`
	Concepts map[string]Concept `json:"concepts"`
}

type DateTime struct {
	time.Time
}

type ElsaParams struct {
	// Either URL or Text is required.
	URL  string
	Text string
}

type ElsaResponse struct {
	Text     string   `json:"text"`
	Entities []Entity `json:"entities"`
}

type EntitiesParams struct {
	// Either URL or Text is required.
	URL  string
	Text string
}

type EntitiesResponse struct {
	Text     string              `json:"text"`
	Entities map[string][]string `json:"entities"`
}

type Entity struct {
	Mentions         []Mention `json:"mentions"`
	OverallSentiment Sentiment `json:"overall_sentiment"`
	Type             string    `json:"type"`
	Links            []Link    `json:"links"`
}

type Error struct {
	Message string `json:"error"`
}

type ExtractParams struct {
	// Either URL or HTML is required.
	URL  string
	HTML string // Raw HTML of web page

	// Whether to extract the best image of the article.
	BestImage bool
}

type ExtractResponse struct {
	Title       string   `json:"title"`
	Article     string   `json:"article"`
	Image       string   `json:"image"`
	Author      string   `json:"author"`
	PublishDate DateTime `json:"publishDate"`
	Videos      []string `json:"videos"`
	Feeds       []string `json:"feeds"`
	Tags        []string `json:"tags"`
}

type HashtagsParams struct {
	// Either URL or Text is required.
	URL  string
	Text string

	// Valid languages are en, de, fr, es, it, pt and auto.
	// Default is en.
	Language string
}

type HashtagsResponse struct {
	Text     string   `json:"text"`
	Language string   `json:"language"`
	Hashtags []string `json:"hashtags"`
}

type ImageTag struct {
	Tag        string  `json:"tag"`
	Confidence float32 `json:"confidence"`
}

type ImageTagsParams struct {
	URL string
}

type ImageTagsResponse struct {
	Image string     `json:"string"`
	Tags  []ImageTag `json:"tags"`
}

type LanguageParams struct {
	// Either URL or Text is required.
	URL  string
	Text string
}

type LanguageResponse struct {
	Text       string  `json:"text"`
	Language   string  `json:"lang"`
	Confidence float32 `json:"confidence"`
}

type Link struct {
	URI        string   `json:"uri"`
	Provider   string   `json:"provider"`
	Types      []string `json:"types"`
	Confidence float64  `json:"confidence"`
}

type Mention struct {
	Offset     int       `json:"offset"`
	Confidence float64   `json:"confidence"`
	Text       string    `json:"text"`
	Sentiment  Sentiment `json:sentiment`
}

type RateLimits struct {
	Limit     int
	Remaining int
	Reset     int
}

type Sentiment struct {
	Polarity   string  `json:"polarity"`
	Confidence float64 `json:"confidence"`
}

type SentimentParams struct {
	// Either URL or Text is required.
	Text string
	URL  string

	// Default is en.
	Language string

	// The analyze mode.
	// Valid option are tweet suitable for short text (default).
	// And document which is more suitable for longer bodies of text.
	Mode string
}

type SentimentResponse struct {
	Text                   string  `json:"text"`
	Polarity               string  `json:"polarity"`
	PolarityConfidence     float32 `json:"polarity_confidence"`
	Subjectivity           string  `json:"subjectivity"`
	SubjectivityConfidence float32 `json:"subjectivity_confidence"`
}

type SummarizeParams struct {
	// Either URL or a pair of Title and Text is required.
	URL   string
	Text  string
	Title string

	// Summarize mode
	// Valid options are default, and short.
	// short mode produces relatively shorter sentences.
	Mode string

	// Quantity of sentences in default mode.
	// Not applicable to short mode.
	NumberOfSentences     int
	PercentageOfSentences int
}

type SummarizeResponse struct {
	Text      string   `json:"text"`
	Sentences []string `json:"sentences"`
}

type SurfaceForm struct {
	String string  `json:"string"`
	Score  float32 `json:"score"`
	Offset int     `json:"offset"`
}