textanalytics

package
v59.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 10, 2021 License: MIT Imports: 7 Imported by: 356

Documentation

Overview

Package textanalytics implements the Azure ARM Textanalytics service API version v2.1.

The Text Analytics API is a suite of text analytics web services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	Endpoint string
}

BaseClient is the base client for Textanalytics.

func New 

func New(endpoint string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults 

func NewWithoutDefaults(endpoint string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

func (BaseClient) DetectLanguage 

func (client BaseClient) DetectLanguage(ctx context.Context, showStats *bool, languageBatchInput *LanguageBatchInput) (result LanguageBatchResult, err error)

DetectLanguage scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported. Parameters: showStats - (optional) if set to true, response will contain input and document level statistics. languageBatchInput - collection of documents to analyze.

func (BaseClient) DetectLanguagePreparer 

func (client BaseClient) DetectLanguagePreparer(ctx context.Context, showStats *bool, languageBatchInput *LanguageBatchInput) (*http.Request, error)

DetectLanguagePreparer prepares the DetectLanguage request.

func (BaseClient) DetectLanguageResponder 

func (client BaseClient) DetectLanguageResponder(resp *http.Response) (result LanguageBatchResult, err error)

DetectLanguageResponder handles the response to the DetectLanguage request. The method always closes the http.Response Body.

func (BaseClient) DetectLanguageSender 

func (client BaseClient) DetectLanguageSender(req *http.Request) (*http.Response, error)

DetectLanguageSender sends the DetectLanguage request. The method will close the http.Response Body if it receives an error.

func (BaseClient) Entities 

func (client BaseClient) Entities(ctx context.Context, showStats *bool, multiLanguageBatchInput *MultiLanguageBatchInput) (result EntitiesBatchResult, err error)

Entities to get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages. Parameters: showStats - (optional) if set to true, response will contain input and document level statistics. multiLanguageBatchInput - collection of documents to analyze.

func (BaseClient) EntitiesPreparer 

func (client BaseClient) EntitiesPreparer(ctx context.Context, showStats *bool, multiLanguageBatchInput *MultiLanguageBatchInput) (*http.Request, error)

EntitiesPreparer prepares the Entities request.

func (BaseClient) EntitiesResponder 

func (client BaseClient) EntitiesResponder(resp *http.Response) (result EntitiesBatchResult, err error)

EntitiesResponder handles the response to the Entities request. The method always closes the http.Response Body.

func (BaseClient) EntitiesSender 

func (client BaseClient) EntitiesSender(req *http.Request) (*http.Response, error)

EntitiesSender sends the Entities request. The method will close the http.Response Body if it receives an error.

func (BaseClient) KeyPhrases 

func (client BaseClient) KeyPhrases(ctx context.Context, showStats *bool, multiLanguageBatchInput *MultiLanguageBatchInput) (result KeyPhraseBatchResult, err error)

KeyPhrases see the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by key phrase extraction. Parameters: showStats - (optional) if set to true, response will contain input and document level statistics. multiLanguageBatchInput - collection of documents to analyze. Documents can now contain a language field to indicate the text language

func (BaseClient) KeyPhrasesPreparer 

func (client BaseClient) KeyPhrasesPreparer(ctx context.Context, showStats *bool, multiLanguageBatchInput *MultiLanguageBatchInput) (*http.Request, error)

KeyPhrasesPreparer prepares the KeyPhrases request.

func (BaseClient) KeyPhrasesResponder 

func (client BaseClient) KeyPhrasesResponder(resp *http.Response) (result KeyPhraseBatchResult, err error)

KeyPhrasesResponder handles the response to the KeyPhrases request. The method always closes the http.Response Body.

func (BaseClient) KeyPhrasesSender 

func (client BaseClient) KeyPhrasesSender(req *http.Request) (*http.Response, error)

KeyPhrasesSender sends the KeyPhrases request. The method will close the http.Response Body if it receives an error.

func (BaseClient) Sentiment 

func (client BaseClient) Sentiment(ctx context.Context, showStats *bool, multiLanguageBatchInput *MultiLanguageBatchInput) (result SentimentBatchResult, err error)

Sentiment scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview#supported-languages">Text Analytics Documentation</a> for details about the languages that are supported by sentiment analysis. Parameters: showStats - (optional) if set to true, response will contain input and document level statistics. multiLanguageBatchInput - collection of documents to analyze.

func (BaseClient) SentimentPreparer 

func (client BaseClient) SentimentPreparer(ctx context.Context, showStats *bool, multiLanguageBatchInput *MultiLanguageBatchInput) (*http.Request, error)

SentimentPreparer prepares the Sentiment request.

func (BaseClient) SentimentResponder 

func (client BaseClient) SentimentResponder(resp *http.Response) (result SentimentBatchResult, err error)

SentimentResponder handles the response to the Sentiment request. The method always closes the http.Response Body.

func (BaseClient) SentimentSender 

func (client BaseClient) SentimentSender(req *http.Request) (*http.Response, error)

SentimentSender sends the Sentiment request. The method will close the http.Response Body if it receives an error.

type DetectedLanguage 

type DetectedLanguage struct {
	// Name - Long name of a detected language (e.g. English, French).
	Name *string `json:"name,omitempty"`
	// Iso6391Name - A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).
	Iso6391Name *string `json:"iso6391Name,omitempty"`
	// Score - A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true.
	Score *float64 `json:"score,omitempty"`
}

DetectedLanguage ...

type DocumentStatistics 

type DocumentStatistics struct {
	// CharactersCount - Number of text elements recognized in the document.
	CharactersCount *int32 `json:"charactersCount,omitempty"`
	// TransactionsCount - Number of transactions for the document.
	TransactionsCount *int32 `json:"transactionsCount,omitempty"`
}

DocumentStatistics ...

type EntitiesBatchResult 

type EntitiesBatchResult struct {
	autorest.Response `json:"-"`
	// Documents - READ-ONLY; Response by document
	Documents *[]EntitiesBatchResultItem `json:"documents,omitempty"`
	// Errors - READ-ONLY; Errors and Warnings by document
	Errors *[]ErrorRecord `json:"errors,omitempty"`
	// Statistics - READ-ONLY; (Optional) if showStats=true was specified in the request this field will contain information about the request payload.
	Statistics *RequestStatistics `json:"statistics,omitempty"`
}

EntitiesBatchResult ...

func (EntitiesBatchResult) MarshalJSON 

func (ebr EntitiesBatchResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EntitiesBatchResult.

type EntitiesBatchResultItem 

type EntitiesBatchResultItem struct {
	// ID - Unique, non-empty document identifier.
	ID *string `json:"id,omitempty"`
	// Entities - READ-ONLY; Recognized entities in the document.
	Entities *[]EntityRecord `json:"entities,omitempty"`
	// Statistics - (Optional) if showStats=true was specified in the request this field will contain information about the document payload.
	Statistics *DocumentStatistics `json:"statistics,omitempty"`
}

EntitiesBatchResultItem ...

func (EntitiesBatchResultItem) MarshalJSON 

func (ebri EntitiesBatchResultItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EntitiesBatchResultItem.

type EntityRecord 

type EntityRecord struct {
	// Name - Entity formal name.
	Name *string `json:"name,omitempty"`
	// Matches - List of instances this entity appears in the text.
	Matches *[]MatchRecord `json:"matches,omitempty"`
	// WikipediaLanguage - Wikipedia language for which the WikipediaId and WikipediaUrl refers to.
	WikipediaLanguage *string `json:"wikipediaLanguage,omitempty"`
	// WikipediaID - Wikipedia unique identifier of the recognized entity.
	WikipediaID *string `json:"wikipediaId,omitempty"`
	// WikipediaURL - READ-ONLY; URL for the entity's Wikipedia page.
	WikipediaURL *string `json:"wikipediaUrl,omitempty"`
	// BingID - Bing unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search API to fetch additional relevant information.
	BingID *string `json:"bingId,omitempty"`
	// Type - Entity type from Named Entity Recognition model
	Type *string `json:"type,omitempty"`
	// SubType - Entity sub type from Named Entity Recognition model
	SubType *string `json:"subType,omitempty"`
}

EntityRecord ...

func (EntityRecord) MarshalJSON 

func (er EntityRecord) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EntityRecord.

type ErrorRecord 

type ErrorRecord struct {
	// ID - Input document unique identifier the error refers to.
	ID *string `json:"id,omitempty"`
	// Message - Error message.
	Message *string `json:"message,omitempty"`
}

ErrorRecord ...

type ErrorResponse 

type ErrorResponse struct {
	Code       *string        `json:"code,omitempty"`
	Message    *string        `json:"message,omitempty"`
	Target     *string        `json:"target,omitempty"`
	InnerError *InternalError `json:"innerError,omitempty"`
}

ErrorResponse ...

type InternalError 

type InternalError struct {
	Code       *string        `json:"code,omitempty"`
	Message    *string        `json:"message,omitempty"`
	InnerError *InternalError `json:"innerError,omitempty"`
}

InternalError ...

type KeyPhraseBatchResult 

type KeyPhraseBatchResult struct {
	autorest.Response `json:"-"`
	// Documents - READ-ONLY; Response by document
	Documents *[]KeyPhraseBatchResultItem `json:"documents,omitempty"`
	// Errors - READ-ONLY; Errors and Warnings by document
	Errors *[]ErrorRecord `json:"errors,omitempty"`
	// Statistics - READ-ONLY; =(Optional) if showStats=true was specified in the request this field will contain information about the request payload.
	Statistics *RequestStatistics `json:"statistics,omitempty"`
}

KeyPhraseBatchResult ...

func (KeyPhraseBatchResult) MarshalJSON 

func (kpbr KeyPhraseBatchResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyPhraseBatchResult.

type KeyPhraseBatchResultItem 

type KeyPhraseBatchResultItem struct {
	// ID - Unique, non-empty document identifier.
	ID *string `json:"id,omitempty"`
	// KeyPhrases - READ-ONLY; A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.
	KeyPhrases *[]string `json:"keyPhrases,omitempty"`
	// Statistics - (Optional) if showStats=true was specified in the request this field will contain information about the document payload.
	Statistics *DocumentStatistics `json:"statistics,omitempty"`
}

KeyPhraseBatchResultItem ...

func (KeyPhraseBatchResultItem) MarshalJSON 

func (kpbri KeyPhraseBatchResultItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyPhraseBatchResultItem.

type LanguageBatchInput 

type LanguageBatchInput struct {
	Documents *[]LanguageInput `json:"documents,omitempty"`
}

LanguageBatchInput ...

type LanguageBatchResult 

type LanguageBatchResult struct {
	autorest.Response `json:"-"`
	// Documents - READ-ONLY; Response by document
	Documents *[]LanguageBatchResultItem `json:"documents,omitempty"`
	// Errors - READ-ONLY; Errors and Warnings by document
	Errors *[]ErrorRecord `json:"errors,omitempty"`
	// Statistics - READ-ONLY; (Optional) if showStats=true was specified in the request this field will contain information about the request payload.
	Statistics *RequestStatistics `json:"statistics,omitempty"`
}

LanguageBatchResult ...

func (LanguageBatchResult) MarshalJSON 

func (lbr LanguageBatchResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LanguageBatchResult.

type LanguageBatchResultItem 

type LanguageBatchResultItem struct {
	// ID - Unique, non-empty document identifier.
	ID *string `json:"id,omitempty"`
	// DetectedLanguages - A list of extracted languages.
	DetectedLanguages *[]DetectedLanguage `json:"detectedLanguages,omitempty"`
	// Statistics - (Optional) if showStats=true was specified in the request this field will contain information about the document payload.
	Statistics *DocumentStatistics `json:"statistics,omitempty"`
}

LanguageBatchResultItem ...

type LanguageInput 

type LanguageInput struct {
	CountryHint *string `json:"countryHint,omitempty"`
	// ID - Unique, non-empty document identifier.
	ID   *string `json:"id,omitempty"`
	Text *string `json:"text,omitempty"`
}

LanguageInput ...

type MatchRecord 

type MatchRecord struct {
	// WikipediaScore - (optional) If a well-known item with Wikipedia link is recognized, a decimal number denoting the confidence level of the Wikipedia info will be returned.
	WikipediaScore *float64 `json:"wikipediaScore,omitempty"`
	// EntityTypeScore - (optional) If an entity type is recognized, a decimal number denoting the confidence level of the entity type will be returned.
	EntityTypeScore *float64 `json:"entityTypeScore,omitempty"`
	// Text - Entity text as appears in the request.
	Text *string `json:"text,omitempty"`
	// Offset - Start position (in Unicode characters) for the entity match text.
	Offset *int32 `json:"offset,omitempty"`
	// Length - Length (in Unicode characters) for the entity match text.
	Length *int32 `json:"length,omitempty"`
}

MatchRecord ...

type MultiLanguageBatchInput 

type MultiLanguageBatchInput struct {
	Documents *[]MultiLanguageInput `json:"documents,omitempty"`
}

MultiLanguageBatchInput ...

type MultiLanguageInput 

type MultiLanguageInput struct {
	// Language - This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,
	Language *string `json:"language,omitempty"`
	// ID - Unique, non-empty document identifier.
	ID   *string `json:"id,omitempty"`
	Text *string `json:"text,omitempty"`
}

MultiLanguageInput ...

type RequestStatistics 

type RequestStatistics struct {
	// DocumentsCount - Number of documents submitted in the request.
	DocumentsCount *int32 `json:"documentsCount,omitempty"`
	// ValidDocumentsCount - Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.
	ValidDocumentsCount *int32 `json:"validDocumentsCount,omitempty"`
	// ErroneousDocumentsCount - Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.
	ErroneousDocumentsCount *int32 `json:"erroneousDocumentsCount,omitempty"`
	// TransactionsCount - Number of transactions for the request.
	TransactionsCount *int64 `json:"transactionsCount,omitempty"`
}

RequestStatistics ...

type SentimentBatchResult 

type SentimentBatchResult struct {
	autorest.Response `json:"-"`
	// Documents - READ-ONLY; Response by document
	Documents *[]SentimentBatchResultItem `json:"documents,omitempty"`
	// Errors - READ-ONLY; Errors and Warnings by document
	Errors *[]ErrorRecord `json:"errors,omitempty"`
	// Statistics - READ-ONLY; (Optional) if showStats=true was specified in the request this field will contain information about the request payload.
	Statistics *RequestStatistics `json:"statistics,omitempty"`
}

SentimentBatchResult ...

func (SentimentBatchResult) MarshalJSON 

func (sbr SentimentBatchResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SentimentBatchResult.

type SentimentBatchResultItem 

type SentimentBatchResultItem struct {
	// ID - Unique, non-empty document identifier.
	ID *string `json:"id,omitempty"`
	// Score - A decimal number between 0 and 1 denoting the sentiment of the document. A score above 0.7 usually refers to a positive document while a score below 0.3 normally has a negative connotation. Mid values refer to neutral text.
	Score *float64 `json:"score,omitempty"`
	// Statistics - (Optional) if showStats=true was specified in the request this field will contain information about the document payload.
	Statistics *DocumentStatistics `json:"statistics,omitempty"`
}

SentimentBatchResultItem ...

Source Files

View all Source files

Directories

Path Synopsis

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.