func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Textanalytics.
type BaseClient struct {
autorest.Client
Endpoint string
}
func New(endpoint string) BaseClient
New creates an instance of the BaseClient client.
func NewWithoutDefaults(endpoint string) BaseClient
NewWithoutDefaults creates an instance of the BaseClient client.
func (client BaseClient) DetectLanguage(ctx context.Context, input BatchInput) (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: input - collection of documents to analyze.
func (client BaseClient) DetectLanguagePreparer(ctx context.Context, input BatchInput) (*http.Request, error)
DetectLanguagePreparer prepares the DetectLanguage request.
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 (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 (client BaseClient) Entities(ctx context.Context, input 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: input - collection of documents to analyze.
func (client BaseClient) EntitiesPreparer(ctx context.Context, input MultiLanguageBatchInput) (*http.Request, error)
EntitiesPreparer prepares the Entities request.
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 (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 (client BaseClient) KeyPhrases(ctx context.Context, input 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: input - collection of documents to analyze. Documents can now contain a language field to indicate the text language
func (client BaseClient) KeyPhrasesPreparer(ctx context.Context, input MultiLanguageBatchInput) (*http.Request, error)
KeyPhrasesPreparer prepares the KeyPhrases request.
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 (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 (client BaseClient) Sentiment(ctx context.Context, input 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: input - collection of documents to analyze.
func (client BaseClient) SentimentPreparer(ctx context.Context, input MultiLanguageBatchInput) (*http.Request, error)
SentimentPreparer prepares the Sentiment request.
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 (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.
BatchInput ...
type BatchInput struct {
Documents *[]Input `json:"documents,omitempty"`
}
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"`
}
EntitiesBatchResult ...
type EntitiesBatchResult struct {
autorest.Response `json:"-"`
// Documents - READ-ONLY
Documents *[]EntitiesBatchResultItem `json:"documents,omitempty"`
// Errors - READ-ONLY
Errors *[]ErrorRecord `json:"errors,omitempty"`
}
func (ebr EntitiesBatchResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntitiesBatchResult.
EntitiesBatchResultItem ...
type EntitiesBatchResultItem struct {
// ID - READ-ONLY; Unique document identifier.
ID *string `json:"id,omitempty"`
// Entities - READ-ONLY; Recognized entities in the document.
Entities *[]EntityRecord `json:"entities,omitempty"`
}
func (ebri EntitiesBatchResultItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntitiesBatchResultItem.
EntityRecord ...
type EntityRecord struct {
// Name - Entity formal name.
Name *string `json:"name,omitempty"`
// Matches - READ-ONLY; 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 English 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"`
}
func (er EntityRecord) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntityRecord.
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"`
}
ErrorResponse ...
type ErrorResponse struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Target *string `json:"target,omitempty"`
InnerError *InternalError `json:"innerError,omitempty"`
}
Input ...
type Input struct {
// ID - Unique, non-empty document identifier.
ID *string `json:"id,omitempty"`
Text *string `json:"text,omitempty"`
}
InternalError ...
type InternalError struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
InnerError *InternalError `json:"innerError,omitempty"`
}
KeyPhraseBatchResult ...
type KeyPhraseBatchResult struct {
autorest.Response `json:"-"`
// Documents - READ-ONLY
Documents *[]KeyPhraseBatchResultItem `json:"documents,omitempty"`
// Errors - READ-ONLY
Errors *[]ErrorRecord `json:"errors,omitempty"`
}
func (kpbr KeyPhraseBatchResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for KeyPhraseBatchResult.
KeyPhraseBatchResultItem ...
type KeyPhraseBatchResultItem struct {
// 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"`
// ID - READ-ONLY; Unique document identifier.
ID *string `json:"id,omitempty"`
}
func (kpbri KeyPhraseBatchResultItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for KeyPhraseBatchResultItem.
LanguageBatchResult ...
type LanguageBatchResult struct {
autorest.Response `json:"-"`
// Documents - READ-ONLY
Documents *[]LanguageBatchResultItem `json:"documents,omitempty"`
// Errors - READ-ONLY
Errors *[]ErrorRecord `json:"errors,omitempty"`
}
func (lbr LanguageBatchResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LanguageBatchResult.
LanguageBatchResultItem ...
type LanguageBatchResultItem struct {
// ID - READ-ONLY; Unique document identifier.
ID *string `json:"id,omitempty"`
// DetectedLanguages - READ-ONLY; A list of extracted languages.
DetectedLanguages *[]DetectedLanguage `json:"detectedLanguages,omitempty"`
}
func (lbri LanguageBatchResultItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LanguageBatchResultItem.
MatchRecord ...
type MatchRecord struct {
// 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"`
}
MultiLanguageBatchInput ...
type MultiLanguageBatchInput struct {
Documents *[]MultiLanguageInput `json:"documents,omitempty"`
}
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"`
}
SentimentBatchResult ...
type SentimentBatchResult struct {
autorest.Response `json:"-"`
// Documents - READ-ONLY
Documents *[]SentimentBatchResultItem `json:"documents,omitempty"`
// Errors - READ-ONLY
Errors *[]ErrorRecord `json:"errors,omitempty"`
}
func (sbr SentimentBatchResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SentimentBatchResult.
SentimentBatchResultItem ...
type SentimentBatchResultItem struct {
// Score - READ-ONLY; 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"`
// ID - READ-ONLY; Unique document identifier.
ID *string `json:"id,omitempty"`
}
func (sbri SentimentBatchResultItem) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SentimentBatchResultItem.
| Name | Synopsis |
|---|---|
| .. | |
| textanalyticsapi | |