nlapi

package
v0.0.0-...-5d5b006 Latest Latest
Warning

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

Go to latest
Published: Nov 3, 2022 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package nlapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.11.0 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewGetContextsRequest

func NewGetContextsRequest(server string) (*http.Request, error)

NewGetContextsRequest generates requests for GetContexts

func NewGetDetectorsRequest

func NewGetDetectorsRequest(server string) (*http.Request, error)

NewGetDetectorsRequest generates requests for GetDetectors

func NewGetTaxonomiesRequest

func NewGetTaxonomiesRequest(server string) (*http.Request, error)

NewGetTaxonomiesRequest generates requests for GetTaxonomies

func NewGetTaxonomiesTaxonomyLanguageRequest

func NewGetTaxonomiesTaxonomyLanguageRequest(server string, taxonomy string, language GetTaxonomiesTaxonomyLanguageParamsLanguage) (*http.Request, error)

NewGetTaxonomiesTaxonomyLanguageRequest generates requests for GetTaxonomiesTaxonomyLanguage

func NewPostAnalyzeContextLanguageAnalysisRequest

NewPostAnalyzeContextLanguageAnalysisRequest calls the generic PostAnalyzeContextLanguageAnalysis builder with application/json body

func NewPostAnalyzeContextLanguageAnalysisRequestWithBody

func NewPostAnalyzeContextLanguageAnalysisRequestWithBody(server string, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, contentType string, body io.Reader) (*http.Request, error)

NewPostAnalyzeContextLanguageAnalysisRequestWithBody generates requests for PostAnalyzeContextLanguageAnalysis with any type of body

func NewPostAnalyzeContextLanguageRequest

func NewPostAnalyzeContextLanguageRequest(server string, context string, language PostAnalyzeContextLanguageParamsLanguage, body PostAnalyzeContextLanguageJSONRequestBody) (*http.Request, error)

NewPostAnalyzeContextLanguageRequest calls the generic PostAnalyzeContextLanguage builder with application/json body

func NewPostAnalyzeContextLanguageRequestWithBody

func NewPostAnalyzeContextLanguageRequestWithBody(server string, context string, language PostAnalyzeContextLanguageParamsLanguage, contentType string, body io.Reader) (*http.Request, error)

NewPostAnalyzeContextLanguageRequestWithBody generates requests for PostAnalyzeContextLanguage with any type of body

func NewPostCategorizeTaxonomyLanguageRequest

func NewPostCategorizeTaxonomyLanguageRequest(server string, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, body PostCategorizeTaxonomyLanguageJSONRequestBody) (*http.Request, error)

NewPostCategorizeTaxonomyLanguageRequest calls the generic PostCategorizeTaxonomyLanguage builder with application/json body

func NewPostCategorizeTaxonomyLanguageRequestWithBody

func NewPostCategorizeTaxonomyLanguageRequestWithBody(server string, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, contentType string, body io.Reader) (*http.Request, error)

NewPostCategorizeTaxonomyLanguageRequestWithBody generates requests for PostCategorizeTaxonomyLanguage with any type of body

func NewPostDetectDetectorLanguageRequest

func NewPostDetectDetectorLanguageRequest(server string, detector string, language PostDetectDetectorLanguageParamsLanguage, body PostDetectDetectorLanguageJSONRequestBody) (*http.Request, error)

NewPostDetectDetectorLanguageRequest calls the generic PostDetectDetectorLanguage builder with application/json body

func NewPostDetectDetectorLanguageRequestWithBody

func NewPostDetectDetectorLanguageRequestWithBody(server string, detector string, language PostDetectDetectorLanguageParamsLanguage, contentType string, body io.Reader) (*http.Request, error)

NewPostDetectDetectorLanguageRequestWithBody generates requests for PostDetectDetectorLanguage with any type of body

Types

type AnalysisRequest

type AnalysisRequest struct {
	// Document
	Document *Document `json:"document,omitempty"`
}

Request

type AnalyzeDocument

type AnalyzeDocument struct {
	// Analyzed text
	Content *string `json:"content,omitempty"`

	// Entities
	Entities *[]Entity `json:"entities,omitempty"`

	// Knowledge Graph syncons data
	Knowledge *[]KnowledgeEntry `json:"knowledge,omitempty"`

	// Text language
	Language *string `json:"language,omitempty"`

	// Main lemmas
	MainLemmas *[]MainLemma `json:"mainLemmas,omitempty"`

	// Main phrases
	MainPhrases *[]MainPhrase `json:"mainPhrases,omitempty"`

	// Main sentences
	MainSentences *[]MainSentence `json:"mainSentences,omitempty"`

	// Main syncons
	MainSyncons *[]MainSyncon `json:"mainSyncons,omitempty"`

	// Paragraphs
	Paragraphs *[]Paragraph `json:"paragraphs,omitempty"`

	// Phrases
	Phrases *[]Phrase `json:"phrases,omitempty"`

	// Verb-mediated relations
	Relations *[]Relation `json:"relations,omitempty"`

	// Sentences
	Sentences *[]Sentence `json:"sentences,omitempty"`

	// Sentiment
	Sentiment *struct {
		// Items expressing sentiment
		Items *[]SentimentItem `json:"items,omitempty"`

		// Text negativity
		Negativity *float32 `json:"negativity,omitempty"`

		// Overall text sentiment score
		Overall *float32 `json:"overall,omitempty"`

		// Text positivity
		Positivity *float32 `json:"positivity,omitempty"`
	} `json:"sentiment,omitempty"`

	// Tokens
	Tokens *[]Token `json:"tokens,omitempty"`

	// Knowledge Graph topics
	Topics *[]DocumentTopic `json:"topics,omitempty"`

	// Service version
	Version *string `json:"version,omitempty"`
}

Analysis data

type AnalyzeResponse

type AnalyzeResponse struct {
	// Analysis data
	Data *AnalyzeDocument `json:"data,omitempty"`

	// Service errors
	Errors *[]ServiceError `json:"errors,omitempty"`

	// Operation completed successfully (true/false)
	Success *bool `json:"success,omitempty"`
}

Analysis resource response

type Atom

type Atom struct {
	// Zero-based position of the first character after the atom
	End *int64 `json:"end,omitempty"`

	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// Zero-based position of the first character of the atom
	Start *int64 `json:"start,omitempty"`

	// Expert.ai type
	Type *string `json:"type,omitempty"`
}

Atom info

type CategorizeDocument

type CategorizeDocument struct {
	// Categories
	Categories *[]Category `json:"categories,omitempty"`

	// Text language
	Language *string `json:"language,omitempty"`

	// Service version
	Version *string `json:"version,omitempty"`
}

Categorization data

type CategorizeResponse

type CategorizeResponse struct {
	// Categorization data
	Data *CategorizeDocument `json:"data,omitempty"`

	// Service errors
	Errors *[]ServiceError `json:"errors,omitempty"`

	// Operation completed successfully (true/false)
	Success *bool `json:"success,omitempty"`
}

Classification resource response

type Category

type Category struct {
	// Score expressed as a percentage of the sum of the scores of all the candidate categories, winners and not (see the **score** property)
	Frequency *float32 `json:"frequency,omitempty"`

	// Hierarchical path
	Hierarchy *[]string `json:"hierarchy,omitempty"`

	// Category ID
	Id *string `json:"id,omitempty"`

	// Category label
	Label *string `json:"label,omitempty"`

	// Name of the software package containing the reference taxonomy
	Namespace *string `json:"namespace,omitempty"`

	// Positions of the portions of text that contributed to the selection of the category
	Positions *[]DocumentPosition `json:"positions,omitempty"`

	// Score assigned to the category to represent its relevance
	Score *int32 `json:"score,omitempty"`

	// True if the category is deemed particularly relevant
	Winner *bool `json:"winner,omitempty"`
}

Category

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetContexts

func (c *Client) GetContexts(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDetectors

func (c *Client) GetDetectors(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaxonomies

func (c *Client) GetTaxonomies(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaxonomiesTaxonomyLanguage

func (c *Client) GetTaxonomiesTaxonomyLanguage(ctx context.Context, taxonomy string, language GetTaxonomiesTaxonomyLanguageParamsLanguage, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostAnalyzeContextLanguage

func (c *Client) PostAnalyzeContextLanguage(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, body PostAnalyzeContextLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostAnalyzeContextLanguageAnalysisWithBody

func (c *Client) PostAnalyzeContextLanguageAnalysisWithBody(ctx context.Context, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostAnalyzeContextLanguageWithBody

func (c *Client) PostAnalyzeContextLanguageWithBody(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostCategorizeTaxonomyLanguageWithBody

func (c *Client) PostCategorizeTaxonomyLanguageWithBody(ctx context.Context, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostDetectDetectorLanguage

func (c *Client) PostDetectDetectorLanguage(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, body PostDetectDetectorLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostDetectDetectorLanguageWithBody

func (c *Client) PostDetectDetectorLanguageWithBody(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// PostAnalyzeContextLanguage request with any body
	PostAnalyzeContextLanguageWithBody(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostAnalyzeContextLanguage(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, body PostAnalyzeContextLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostAnalyzeContextLanguageAnalysis request with any body
	PostAnalyzeContextLanguageAnalysisWithBody(ctx context.Context, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostAnalyzeContextLanguageAnalysis(ctx context.Context, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, body PostAnalyzeContextLanguageAnalysisJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostCategorizeTaxonomyLanguage request with any body
	PostCategorizeTaxonomyLanguageWithBody(ctx context.Context, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostCategorizeTaxonomyLanguage(ctx context.Context, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, body PostCategorizeTaxonomyLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContexts request
	GetContexts(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostDetectDetectorLanguage request with any body
	PostDetectDetectorLanguageWithBody(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostDetectDetectorLanguage(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, body PostDetectDetectorLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDetectors request
	GetDetectors(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaxonomies request
	GetTaxonomies(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaxonomiesTaxonomyLanguage request
	GetTaxonomiesTaxonomyLanguage(ctx context.Context, taxonomy string, language GetTaxonomiesTaxonomyLanguageParamsLanguage, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetContextsWithResponse

func (c *ClientWithResponses) GetContextsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetContextsResponse, error)

GetContextsWithResponse request returning *GetContextsResponse

func (*ClientWithResponses) GetDetectorsWithResponse

func (c *ClientWithResponses) GetDetectorsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDetectorsResponse, error)

GetDetectorsWithResponse request returning *GetDetectorsResponse

func (*ClientWithResponses) GetTaxonomiesTaxonomyLanguageWithResponse

func (c *ClientWithResponses) GetTaxonomiesTaxonomyLanguageWithResponse(ctx context.Context, taxonomy string, language GetTaxonomiesTaxonomyLanguageParamsLanguage, reqEditors ...RequestEditorFn) (*GetTaxonomiesTaxonomyLanguageResponse, error)

GetTaxonomiesTaxonomyLanguageWithResponse request returning *GetTaxonomiesTaxonomyLanguageResponse

func (*ClientWithResponses) GetTaxonomiesWithResponse

func (c *ClientWithResponses) GetTaxonomiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTaxonomiesResponse, error)

GetTaxonomiesWithResponse request returning *GetTaxonomiesResponse

func (*ClientWithResponses) PostAnalyzeContextLanguageAnalysisWithBodyWithResponse

func (c *ClientWithResponses) PostAnalyzeContextLanguageAnalysisWithBodyWithResponse(ctx context.Context, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAnalyzeContextLanguageAnalysisResponse, error)

PostAnalyzeContextLanguageAnalysisWithBodyWithResponse request with arbitrary body returning *PostAnalyzeContextLanguageAnalysisResponse

func (*ClientWithResponses) PostAnalyzeContextLanguageWithBodyWithResponse

func (c *ClientWithResponses) PostAnalyzeContextLanguageWithBodyWithResponse(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAnalyzeContextLanguageResponse, error)

PostAnalyzeContextLanguageWithBodyWithResponse request with arbitrary body returning *PostAnalyzeContextLanguageResponse

func (*ClientWithResponses) PostCategorizeTaxonomyLanguageWithBodyWithResponse

func (c *ClientWithResponses) PostCategorizeTaxonomyLanguageWithBodyWithResponse(ctx context.Context, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCategorizeTaxonomyLanguageResponse, error)

PostCategorizeTaxonomyLanguageWithBodyWithResponse request with arbitrary body returning *PostCategorizeTaxonomyLanguageResponse

func (*ClientWithResponses) PostDetectDetectorLanguageWithBodyWithResponse

func (c *ClientWithResponses) PostDetectDetectorLanguageWithBodyWithResponse(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostDetectDetectorLanguageResponse, error)

PostDetectDetectorLanguageWithBodyWithResponse request with arbitrary body returning *PostDetectDetectorLanguageResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// PostAnalyzeContextLanguage request with any body
	PostAnalyzeContextLanguageWithBodyWithResponse(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAnalyzeContextLanguageResponse, error)

	PostAnalyzeContextLanguageWithResponse(ctx context.Context, context string, language PostAnalyzeContextLanguageParamsLanguage, body PostAnalyzeContextLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAnalyzeContextLanguageResponse, error)

	// PostAnalyzeContextLanguageAnalysis request with any body
	PostAnalyzeContextLanguageAnalysisWithBodyWithResponse(ctx context.Context, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAnalyzeContextLanguageAnalysisResponse, error)

	PostAnalyzeContextLanguageAnalysisWithResponse(ctx context.Context, context string, language PostAnalyzeContextLanguageAnalysisParamsLanguage, analysis PostAnalyzeContextLanguageAnalysisParamsAnalysis, body PostAnalyzeContextLanguageAnalysisJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAnalyzeContextLanguageAnalysisResponse, error)

	// PostCategorizeTaxonomyLanguage request with any body
	PostCategorizeTaxonomyLanguageWithBodyWithResponse(ctx context.Context, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCategorizeTaxonomyLanguageResponse, error)

	PostCategorizeTaxonomyLanguageWithResponse(ctx context.Context, taxonomy string, language PostCategorizeTaxonomyLanguageParamsLanguage, body PostCategorizeTaxonomyLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCategorizeTaxonomyLanguageResponse, error)

	// GetContexts request
	GetContextsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetContextsResponse, error)

	// PostDetectDetectorLanguage request with any body
	PostDetectDetectorLanguageWithBodyWithResponse(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostDetectDetectorLanguageResponse, error)

	PostDetectDetectorLanguageWithResponse(ctx context.Context, detector string, language PostDetectDetectorLanguageParamsLanguage, body PostDetectDetectorLanguageJSONRequestBody, reqEditors ...RequestEditorFn) (*PostDetectDetectorLanguageResponse, error)

	// GetDetectors request
	GetDetectorsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDetectorsResponse, error)

	// GetTaxonomies request
	GetTaxonomiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTaxonomiesResponse, error)

	// GetTaxonomiesTaxonomyLanguage request
	GetTaxonomiesTaxonomyLanguageWithResponse(ctx context.Context, taxonomy string, language GetTaxonomiesTaxonomyLanguageParamsLanguage, reqEditors ...RequestEditorFn) (*GetTaxonomiesTaxonomyLanguageResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type ContextInfo

type ContextInfo struct {
	// Context description
	Description *string `json:"description,omitempty"`

	// Information about supported languages and available analyses
	Languages *[]ContextLanguageInfo `json:"languages,omitempty"`

	// Context name
	Name *string `json:"name,omitempty"`
}

Information about a context

type ContextLanguageInfo

type ContextLanguageInfo struct {
	// Available analyses
	Analyses *[]string `json:"analyses,omitempty"`

	// Language code
	Code *string `json:"code,omitempty"`

	// Language name
	Name *string `json:"name,omitempty"`
}

Information about a supported language and available analyses

type ContextsResponse

type ContextsResponse struct {
	// List of contexts' information
	Contexts *[]ContextInfo `json:"contexts,omitempty"`
}

Available contexts

type Dependency

type Dependency struct {
	// Number of the head token
	Head *int64 `json:"head,omitempty"`

	// Zero-based cardinal number of the token
	Id *int64 `json:"id,omitempty"`

	// (<a href='https://universaldependencies.org/u/dep/#universal-dependency-relations' target='_blank'>Dependency relation</a> between the token and the head token
	Label *string `json:"label,omitempty"`
}

Dependency info

type DetectorInfo

type DetectorInfo struct {
	// OpenAPI document describing the use of the detector and its output
	Contract *string `json:"contract,omitempty"`

	// Detector description
	Description *string `json:"description,omitempty"`

	// Supported languages
	Languages *[]LanguageInfo `json:"languages,omitempty"`

	// Detector name
	Name *string `json:"name,omitempty"`
}

Summary information about a detector

type DetectorsResponse

type DetectorsResponse struct {
	// List of detectors' information
	Detectors *[]DetectorInfo `json:"detectors,omitempty"`
}

Available detectors

type Document

type Document struct {
	// The document's text
	Text *string `json:"text,omitempty"`
}

Document

type DocumentPosition

type DocumentPosition struct {
	// Zero-based position of the character after the last
	End *int64 `json:"end,omitempty"`

	// Zero-based position of the first character
	Start *int64 `json:"start,omitempty"`
}

Position

type DocumentTopic

type DocumentTopic struct {
	// Language-independent topic ID
	Id *int64 `json:"id,omitempty"`

	// Topic name
	Label *string `json:"label,omitempty"`

	// Score assigned to the topic to represent its relevance
	Score *float32 `json:"score,omitempty"`

	// True if the topic is deemed particularly relevant
	Winner *bool `json:"winner,omitempty"`
}

Knowledge Graph topic info

type Entity

type Entity struct {
	// Entity attributes inferred from the context or from the Knowledge Graph
	Attributes *[]InferredAttribute `json:"attributes,omitempty"`

	// Base form (lemma) of the entity name
	Lemma *string `json:"lemma,omitempty"`

	// Positions of the entity's mentions
	Positions *[]DocumentPosition `json:"positions,omitempty"`

	// Entity relevance
	Relevance *int64 `json:"relevance,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`

	// Entity type
	Type *string `json:"type,omitempty"`
}

Entity info

type GetContextsResponse

type GetContextsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ContextsResponse
}

func ParseGetContextsResponse

func ParseGetContextsResponse(rsp *http.Response) (*GetContextsResponse, error)

ParseGetContextsResponse parses an HTTP response from a GetContextsWithResponse call

func (GetContextsResponse) Status

func (r GetContextsResponse) Status() string

Status returns HTTPResponse.Status

func (GetContextsResponse) StatusCode

func (r GetContextsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDetectorsResponse

type GetDetectorsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DetectorsResponse
}

func ParseGetDetectorsResponse

func ParseGetDetectorsResponse(rsp *http.Response) (*GetDetectorsResponse, error)

ParseGetDetectorsResponse parses an HTTP response from a GetDetectorsWithResponse call

func (GetDetectorsResponse) Status

func (r GetDetectorsResponse) Status() string

Status returns HTTPResponse.Status

func (GetDetectorsResponse) StatusCode

func (r GetDetectorsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaxonomiesResponse

type GetTaxonomiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaxonomiesResponse
}

func ParseGetTaxonomiesResponse

func ParseGetTaxonomiesResponse(rsp *http.Response) (*GetTaxonomiesResponse, error)

ParseGetTaxonomiesResponse parses an HTTP response from a GetTaxonomiesWithResponse call

func (GetTaxonomiesResponse) Status

func (r GetTaxonomiesResponse) Status() string

Status returns HTTPResponse.Status

func (GetTaxonomiesResponse) StatusCode

func (r GetTaxonomiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaxonomiesTaxonomyLanguageParamsLanguage

type GetTaxonomiesTaxonomyLanguageParamsLanguage string

GetTaxonomiesTaxonomyLanguageParamsLanguage defines parameters for GetTaxonomiesTaxonomyLanguage.

type GetTaxonomiesTaxonomyLanguageResponse

type GetTaxonomiesTaxonomyLanguageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaxonomyResponse
}

func ParseGetTaxonomiesTaxonomyLanguageResponse

func ParseGetTaxonomiesTaxonomyLanguageResponse(rsp *http.Response) (*GetTaxonomiesTaxonomyLanguageResponse, error)

ParseGetTaxonomiesTaxonomyLanguageResponse parses an HTTP response from a GetTaxonomiesTaxonomyLanguageWithResponse call

func (GetTaxonomiesTaxonomyLanguageResponse) Status

Status returns HTTPResponse.Status

func (GetTaxonomiesTaxonomyLanguageResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InferredAttribute

type InferredAttribute struct {
	// Attribute name
	Attribute *string `json:"attribute,omitempty"`

	// Attribute's attributes
	Attributes *[]InferredAttribute `json:"attributes,omitempty"`

	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`

	// Attribute type
	Type *string `json:"type,omitempty"`
}

Inferred attribute

type KnowledgeEntry

type KnowledgeEntry struct {
	// Textual rendering of the general conceptual category for the token in the Knowledge Graph
	Label *string `json:"label,omitempty"`

	// Syncon extended properties
	Properties *[]Property `json:"properties,omitempty"`

	// Syncon ID
	Syncon *int64 `json:"syncon,omitempty"`
}

Knowledge Graph data for a syncon

type LanguageInfo

type LanguageInfo struct {
	// Language code
	Code *string `json:"code,omitempty"`

	// Language name
	Name *string `json:"name,omitempty"`
}

Information about a supported language

type MainLemma

type MainLemma struct {
	// Positions of lemma occurrences
	Positions *[]DocumentPosition `json:"positions,omitempty"`

	// Score assigned to the lemma to represent its relevance
	Score *float32 `json:"score,omitempty"`

	// Lemma
	Value *string `json:"value,omitempty"`
}

Main lemma info

type MainPhrase

type MainPhrase struct {
	// Positions of phrase occurrences
	Positions *[]DocumentPosition `json:"positions,omitempty"`

	// Score assigned to the phrase to represent its relevance
	Score *float32 `json:"score,omitempty"`

	// Phrase text
	Value *string `json:"value,omitempty"`
}

Main phrase info

type MainSentence

type MainSentence struct {
	// Zero-based position of the first character after the sentence
	End *int64 `json:"end,omitempty"`

	// Score assigned to the sentence to represent its relevance
	Score *float32 `json:"score,omitempty"`

	// Zero-based position of the first character of the sentence
	Start *int64 `json:"start,omitempty"`

	// Sentence text
	Value *string `json:"value,omitempty"`
}

Main sentence

type MainSyncon

type MainSyncon struct {
	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// Positions of the expressions of the syncon
	Positions *[]DocumentPosition `json:"positions,omitempty"`

	// Score assigned to the syncon to represent its relevance
	Score *float32 `json:"score,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`
}

Main syncon info

type N200Contexts

type N200Contexts = ContextsResponse

Available contexts

type N200Detectors

type N200Detectors = DetectorsResponse

Available detectors

type N200Taxonomies

type N200Taxonomies = TaxonomiesResponse

Available taxonomies

type N200Taxonomy

type N200Taxonomy = TaxonomyResponse

Taxonomy categories

type Paragraph

type Paragraph struct {
	// Zero-based position of the first character after the paragraph
	End *int64 `json:"end,omitempty"`

	// Indexes (in the `sentences` array) of the sentences that make up the paragraph
	Sentences *[]int32 `json:"sentences,omitempty"`

	// Zero-based position of the first character of the paragraph
	Start *int64 `json:"start,omitempty"`
}

Paragraph info

type Phrase

type Phrase struct {
	// Zero-based position of the first character after the phrase
	End *int64 `json:"end,omitempty"`

	// Zero-based position of the first character of the phrase
	Start *int64 `json:"start,omitempty"`

	// Indexes (in the `tokens` array) of the tokens that make up the phrase
	Tokens *[]int32 `json:"tokens,omitempty"`

	// Phrase type
	Type *string `json:"type,omitempty"`
}

Phrase info

type PostAnalyzeContextLanguageAnalysisJSONBody

type PostAnalyzeContextLanguageAnalysisJSONBody = AnalysisRequest

PostAnalyzeContextLanguageAnalysisJSONBody defines parameters for PostAnalyzeContextLanguageAnalysis.

type PostAnalyzeContextLanguageAnalysisJSONRequestBody

type PostAnalyzeContextLanguageAnalysisJSONRequestBody = PostAnalyzeContextLanguageAnalysisJSONBody

PostAnalyzeContextLanguageAnalysisJSONRequestBody defines body for PostAnalyzeContextLanguageAnalysis for application/json ContentType.

type PostAnalyzeContextLanguageAnalysisParamsAnalysis

type PostAnalyzeContextLanguageAnalysisParamsAnalysis string

PostAnalyzeContextLanguageAnalysisParamsAnalysis defines parameters for PostAnalyzeContextLanguageAnalysis.

type PostAnalyzeContextLanguageAnalysisParamsLanguage

type PostAnalyzeContextLanguageAnalysisParamsLanguage string

PostAnalyzeContextLanguageAnalysisParamsLanguage defines parameters for PostAnalyzeContextLanguageAnalysis.

type PostAnalyzeContextLanguageAnalysisResponse

type PostAnalyzeContextLanguageAnalysisResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AnalyzeResponse
}

func ParsePostAnalyzeContextLanguageAnalysisResponse

func ParsePostAnalyzeContextLanguageAnalysisResponse(rsp *http.Response) (*PostAnalyzeContextLanguageAnalysisResponse, error)

ParsePostAnalyzeContextLanguageAnalysisResponse parses an HTTP response from a PostAnalyzeContextLanguageAnalysisWithResponse call

func (PostAnalyzeContextLanguageAnalysisResponse) Status

Status returns HTTPResponse.Status

func (PostAnalyzeContextLanguageAnalysisResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostAnalyzeContextLanguageJSONBody

type PostAnalyzeContextLanguageJSONBody = AnalysisRequest

PostAnalyzeContextLanguageJSONBody defines parameters for PostAnalyzeContextLanguage.

type PostAnalyzeContextLanguageJSONRequestBody

type PostAnalyzeContextLanguageJSONRequestBody = PostAnalyzeContextLanguageJSONBody

PostAnalyzeContextLanguageJSONRequestBody defines body for PostAnalyzeContextLanguage for application/json ContentType.

type PostAnalyzeContextLanguageParamsLanguage

type PostAnalyzeContextLanguageParamsLanguage string

PostAnalyzeContextLanguageParamsLanguage defines parameters for PostAnalyzeContextLanguage.

type PostAnalyzeContextLanguageResponse

type PostAnalyzeContextLanguageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AnalyzeResponse
}

func ParsePostAnalyzeContextLanguageResponse

func ParsePostAnalyzeContextLanguageResponse(rsp *http.Response) (*PostAnalyzeContextLanguageResponse, error)

ParsePostAnalyzeContextLanguageResponse parses an HTTP response from a PostAnalyzeContextLanguageWithResponse call

func (PostAnalyzeContextLanguageResponse) Status

Status returns HTTPResponse.Status

func (PostAnalyzeContextLanguageResponse) StatusCode

func (r PostAnalyzeContextLanguageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostCategorizeTaxonomyLanguageJSONBody

type PostCategorizeTaxonomyLanguageJSONBody = AnalysisRequest

PostCategorizeTaxonomyLanguageJSONBody defines parameters for PostCategorizeTaxonomyLanguage.

type PostCategorizeTaxonomyLanguageJSONRequestBody

type PostCategorizeTaxonomyLanguageJSONRequestBody = PostCategorizeTaxonomyLanguageJSONBody

PostCategorizeTaxonomyLanguageJSONRequestBody defines body for PostCategorizeTaxonomyLanguage for application/json ContentType.

type PostCategorizeTaxonomyLanguageParamsLanguage

type PostCategorizeTaxonomyLanguageParamsLanguage string

PostCategorizeTaxonomyLanguageParamsLanguage defines parameters for PostCategorizeTaxonomyLanguage.

type PostCategorizeTaxonomyLanguageResponse

type PostCategorizeTaxonomyLanguageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CategorizeResponse
}

func ParsePostCategorizeTaxonomyLanguageResponse

func ParsePostCategorizeTaxonomyLanguageResponse(rsp *http.Response) (*PostCategorizeTaxonomyLanguageResponse, error)

ParsePostCategorizeTaxonomyLanguageResponse parses an HTTP response from a PostCategorizeTaxonomyLanguageWithResponse call

func (PostCategorizeTaxonomyLanguageResponse) Status

Status returns HTTPResponse.Status

func (PostCategorizeTaxonomyLanguageResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostDetectDetectorLanguageJSONBody

type PostDetectDetectorLanguageJSONBody = AnalysisRequest

PostDetectDetectorLanguageJSONBody defines parameters for PostDetectDetectorLanguage.

type PostDetectDetectorLanguageJSONRequestBody

type PostDetectDetectorLanguageJSONRequestBody = PostDetectDetectorLanguageJSONBody

PostDetectDetectorLanguageJSONRequestBody defines body for PostDetectDetectorLanguage for application/json ContentType.

type PostDetectDetectorLanguageParamsLanguage

type PostDetectDetectorLanguageParamsLanguage string

PostDetectDetectorLanguageParamsLanguage defines parameters for PostDetectDetectorLanguage.

type PostDetectDetectorLanguageResponse

type PostDetectDetectorLanguageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParsePostDetectDetectorLanguageResponse

func ParsePostDetectDetectorLanguageResponse(rsp *http.Response) (*PostDetectDetectorLanguageResponse, error)

ParsePostDetectDetectorLanguageResponse parses an HTTP response from a PostDetectDetectorLanguageWithResponse call

func (PostDetectDetectorLanguageResponse) Status

Status returns HTTPResponse.Status

func (PostDetectDetectorLanguageResponse) StatusCode

func (r PostDetectDetectorLanguageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Property

type Property struct {
	// Property type
	Type *string `json:"type,omitempty"`

	// Property value
	Value *string `json:"value,omitempty"`
}

Syncon property

type RelatedItem

type RelatedItem struct {
	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// Phrase index in the `phrases` array
	Phrase *int64 `json:"phrase,omitempty"`

	// Related terms
	Related *[]RelatedItem `json:"related,omitempty"`

	// Verb-item relation
	Relation *string `json:"relation,omitempty"`

	// Relevance
	Relevance *int64 `json:"relevance,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`

	// Item text
	Text *string `json:"text,omitempty"`

	// Type
	Type *string `json:"type,omitempty"`

	// A concept that does not exist in the Knowledge Graph but heuristics recognized as a type of a known parent concept.
	Vsyn *VirtualSyncon `json:"vsyn,omitempty"`
}

In a relation, a term that's directly or indirectly related to the verb

type Relation

type Relation struct {
	// Related items
	Related *[]RelatedItem `json:"related,omitempty"`

	// Verb of a relation
	Verb *RelationVerb `json:"verb,omitempty"`
}

Verb-mediated relation

type RelationVerb

type RelationVerb struct {
	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// Phrase index in the `phrases` array
	Phrase *int64 `json:"phrase,omitempty"`

	// Relevance
	Relevance *int64 `json:"relevance,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`

	// Verb text
	Text *string `json:"text,omitempty"`

	// Type
	Type *string `json:"type,omitempty"`
}

Verb of a relation

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Sentence

type Sentence struct {
	// Zero-based position of the first character after the sentence
	End *int64 `json:"end,omitempty"`

	// Indexes (in the `phrases` array) of the phrases that make up the sentence
	Phrases *[]int32 `json:"phrases,omitempty"`

	// Zero-based position of the first character of the sentence
	Start *int64 `json:"start,omitempty"`
}

Sentence info

type SentimentItem

type SentimentItem struct {
	// Items expressing sentiment
	Items *[]SentimentItem `json:"items,omitempty"`

	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// Item/chain sentiment score
	Sentiment *float32 `json:"sentiment,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`
}

Item or chain of items expressing sentiment

type ServiceError

type ServiceError struct {
	// Error code
	Code *string `json:"code,omitempty"`

	// Error message
	Message *string `json:"message,omitempty"`
}

Error information

type TaxonomiesResponse

type TaxonomiesResponse struct {
	// List of taxonomies' information
	Texonomies *[]TaxonomyInfo `json:"texonomies,omitempty"`
}

Available taxonomies

type Taxonomy

type Taxonomy struct {
	// Name of the software package containing the reference taxonomy
	Namespace *string `json:"namespace,omitempty"`

	// Categories tree
	Taxonomy *[]TaxonomyCategory `json:"taxonomy,omitempty"`
}

A taxonomy's categories tree

type TaxonomyCategory

type TaxonomyCategory struct {
	// Sub-categories
	Categories *[]TaxonomyCategory `json:"categories,omitempty"`

	// Category ID
	Id *string `json:"id,omitempty"`

	// Category label
	Label *string `json:"label,omitempty"`
}

Taxonomy category

type TaxonomyInfo

type TaxonomyInfo struct {
	// OpenAPI document describing extra ways to use the taxonomy and their outputs
	Contract *string `json:"contract,omitempty"`

	// Taxonomy description
	Description *string `json:"description,omitempty"`

	// Supported languages
	Languages *[]LanguageInfo `json:"languages,omitempty"`

	// Taxonomy name
	Name *string `json:"name,omitempty"`
}

Summary information about a taxonomy

type TaxonomyResponse

type TaxonomyResponse struct {
	Data *[]Taxonomy `json:"data,omitempty"`

	// Service errors
	Errors *[]ServiceError `json:"errors,omitempty"`

	// Operation completed successfully (true/false)
	Success *bool `json:"success,omitempty"`
}

Taxonomy categories

type Token

type Token struct {
	// Atoms that make up the token
	Atoms *[]Atom `json:"atoms,omitempty"`

	// Dependency info
	Dependency *Dependency `json:"dependency,omitempty"`

	// Zero-based position of the first character after the token
	End *int64 `json:"end,omitempty"`

	// Lemma
	Lemma *string `json:"lemma,omitempty"`

	// A semicolon separated list of <a href='https://universaldependencies.org/format.html#morphological-annotation'>CoNLL-U format</a> morphological features
	Morphology *string `json:"morphology,omitempty"`

	// Paragraph index in the `paragraphs` array
	Paragraph *int64 `json:"paragraph,omitempty"`

	// Phrase index in the `phrases` array
	Phrase *int64 `json:"phrase,omitempty"`

	// <a href='https://universaldependencies.org/u/pos/'>Universal Dependencies part-of-speech tag</a>
	Pos *string `json:"pos,omitempty"`

	// Sentence index in the `sentences` array
	Sentence *int64 `json:"sentence,omitempty"`

	// Zero-based position of the first character of the token
	Start *int64 `json:"start,omitempty"`

	// ID used to look up Knowledge Graph data in the `knowledge` array
	Syncon *int64 `json:"syncon,omitempty"`

	// Expert.ai type
	Type *string `json:"type,omitempty"`

	// A concept that does not exist in the Knowledge Graph but heuristics recognized as a type of a known parent concept.
	Vsyn *VirtualSyncon `json:"vsyn,omitempty"`
}

Token info

type VirtualSyncon

type VirtualSyncon struct {
	// ID used to mark all the occurrences of the virtual concept in the text
	Id *int64 `json:"id,omitempty"`

	// Parent concept; ID is used to look up Knowledge Graph data in the `knowledge` array
	Parent *int64 `json:"parent,omitempty"`
}

A concept that does not exist in the Knowledge Graph but heuristics recognized as a type of a known parent concept.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL