models

package
v0.0.0-...-7278ba6 Latest Latest
Warning

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

Go to latest
Published: Jul 19, 2019 License: CC0-1.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// InternalErrorCodeInvalidParameterValue captures enum value "invalidParameterValue"
	InternalErrorCodeInvalidParameterValue string = "invalidParameterValue"
	// InternalErrorCodeInvalidRequestBodyFormat captures enum value "invalidRequestBodyFormat"
	InternalErrorCodeInvalidRequestBodyFormat string = "invalidRequestBodyFormat"
	// InternalErrorCodeMissingRequiredHeader captures enum value "missingRequiredHeader"
	InternalErrorCodeMissingRequiredHeader string = "missingRequiredHeader"
	// InternalErrorCodeInvalidRequestContent captures enum value "invalidRequestContent"
	InternalErrorCodeInvalidRequestContent string = "invalidRequestContent"
	// InternalErrorCodeMissingRequiredParameter captures enum value "missingRequiredParameter"
	InternalErrorCodeMissingRequiredParameter string = "missingRequiredParameter"
)
View Source
const (
	// OperationResultStatusNotStarted captures enum value "notStarted"
	OperationResultStatusNotStarted string = "notStarted"
	// OperationResultStatusRunning captures enum value "running"
	OperationResultStatusRunning string = "running"
	// OperationResultStatusFailed captures enum value "failed"
	OperationResultStatusFailed string = "failed"
	// OperationResultStatusCancelled captures enum value "cancelled"
	OperationResultStatusCancelled string = "cancelled"
	// OperationResultStatusSucceeded captures enum value "succeeded"
	OperationResultStatusSucceeded string = "succeeded"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchInputV2

type BatchInputV2 struct {

	// documents
	Documents []*InputV2 `json:"documents"`
}

BatchInputV2 batch input v2 swagger:model BatchInputV2

func (*BatchInputV2) Validate

func (m *BatchInputV2) Validate(formats strfmt.Registry) error

Validate validates this batch input v2

type DetectedLanguageV2

type DetectedLanguageV2 struct {

	// A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).
	Iso6391Name string `json:"iso6391Name,omitempty"`

	// Long name of a detected language (e.g. English, French).
	Name string `json:"name,omitempty"`

	// 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"`
}

DetectedLanguageV2 detected language v2 swagger:model DetectedLanguageV2

func (*DetectedLanguageV2) Validate

func (m *DetectedLanguageV2) Validate(formats strfmt.Registry) error

Validate validates this detected language v2

type ErrorRecordV2

type ErrorRecordV2 struct {

	// Input document unique identifier the error refers to.
	ID string `json:"id,omitempty"`

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

ErrorRecordV2 error record v2 swagger:model ErrorRecordV2

func (*ErrorRecordV2) Validate

func (m *ErrorRecordV2) Validate(formats strfmt.Registry) error

Validate validates this error record v2

type ErrorResponse

type ErrorResponse struct {

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

	// inner error
	InnerError *InternalError `json:"innerError,omitempty"`

	// message
	Message string `json:"message,omitempty"`

	// target
	Target string `json:"target,omitempty"`
}

ErrorResponse error response swagger:model ErrorResponse

func (*ErrorResponse) Validate

func (m *ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this error response

type InputV2

type InputV2 struct {

	// Unique, non-empty document identifier.
	ID string `json:"id,omitempty"`

	// text
	Text string `json:"text,omitempty"`
}

InputV2 input v2 swagger:model InputV2

func (*InputV2) Validate

func (m *InputV2) Validate(formats strfmt.Registry) error

Validate validates this input v2

type InternalError

type InternalError struct {

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

	// inner error
	InnerError *InternalError `json:"innerError,omitempty"`

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

InternalError internal error swagger:model InternalError

func (*InternalError) Validate

func (m *InternalError) Validate(formats strfmt.Registry) error

Validate validates this internal error

type KeyPhraseBatchResultItemV2

type KeyPhraseBatchResultItemV2 struct {

	// Unique document identifier.
	ID string `json:"id,omitempty"`

	// 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"`
}

KeyPhraseBatchResultItemV2 key phrase batch result item v2 swagger:model KeyPhraseBatchResultItemV2

func (*KeyPhraseBatchResultItemV2) Validate

func (m *KeyPhraseBatchResultItemV2) Validate(formats strfmt.Registry) error

Validate validates this key phrase batch result item v2

type KeyPhraseBatchResultV2

type KeyPhraseBatchResultV2 struct {

	// documents
	Documents []*KeyPhraseBatchResultItemV2 `json:"documents"`

	// errors
	Errors []*ErrorRecordV2 `json:"errors"`
}

KeyPhraseBatchResultV2 key phrase batch result v2 swagger:model KeyPhraseBatchResultV2

func (*KeyPhraseBatchResultV2) Validate

func (m *KeyPhraseBatchResultV2) Validate(formats strfmt.Registry) error

Validate validates this key phrase batch result v2

type LanguageBatchResultItemV2

type LanguageBatchResultItemV2 struct {

	// A list of extracted languages.
	DetectedLanguages []*DetectedLanguageV2 `json:"detectedLanguages"`

	// Unique document identifier.
	ID string `json:"id,omitempty"`
}

LanguageBatchResultItemV2 language batch result item v2 swagger:model LanguageBatchResultItemV2

func (*LanguageBatchResultItemV2) Validate

func (m *LanguageBatchResultItemV2) Validate(formats strfmt.Registry) error

Validate validates this language batch result item v2

type LanguageBatchResultV2

type LanguageBatchResultV2 struct {

	// documents
	Documents []*LanguageBatchResultItemV2 `json:"documents"`

	// errors
	Errors []*ErrorRecordV2 `json:"errors"`
}

LanguageBatchResultV2 language batch result v2 swagger:model LanguageBatchResultV2

func (*LanguageBatchResultV2) Validate

func (m *LanguageBatchResultV2) Validate(formats strfmt.Registry) error

Validate validates this language batch result v2

type MultiLanguageBatchInputV2

type MultiLanguageBatchInputV2 struct {

	// documents
	Documents []*MultiLanguageInputV2 `json:"documents"`
}

MultiLanguageBatchInputV2 multi language batch input v2 swagger:model MultiLanguageBatchInputV2

func (*MultiLanguageBatchInputV2) Validate

func (m *MultiLanguageBatchInputV2) Validate(formats strfmt.Registry) error

Validate validates this multi language batch input v2

type MultiLanguageInputV2

type MultiLanguageInputV2 struct {

	// Unique, non-empty document identifier.
	ID string `json:"id,omitempty"`

	// 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"`

	// text
	Text string `json:"text,omitempty"`
}

MultiLanguageInputV2 multi language input v2 swagger:model MultiLanguageInputV2

func (*MultiLanguageInputV2) Validate

func (m *MultiLanguageInputV2) Validate(formats strfmt.Registry) error

Validate validates this multi language input v2

type Object

type Object interface{}

Object object swagger:model Object

type OperationProcessingResult

type OperationProcessingResult interface {
	runtime.Validatable

	// discriminator
	// Required: true
	Discriminator() string
	SetDiscriminator(string)

	// errors
	Errors() []*ErrorRecordV2
	SetErrors([]*ErrorRecordV2)
}

OperationProcessingResult operation processing result swagger:discriminator OperationProcessingResult discriminator

func UnmarshalOperationProcessingResult

func UnmarshalOperationProcessingResult(reader io.Reader, consumer runtime.Consumer) (OperationProcessingResult, error)

UnmarshalOperationProcessingResult unmarshals polymorphic OperationProcessingResult

func UnmarshalOperationProcessingResultSlice

func UnmarshalOperationProcessingResultSlice(reader io.Reader, consumer runtime.Consumer) ([]OperationProcessingResult, error)

UnmarshalOperationProcessingResultSlice unmarshals polymorphic slices of OperationProcessingResult

type OperationResult

type OperationResult struct {

	// Operation creation date time (ISO 8601 literal).
	CreatedDateTime strfmt.DateTime `json:"createdDateTime,omitempty"`

	// Operation last status change date time (ISO 8601 literal).
	LastActionDateTime strfmt.DateTime `json:"lastActionDateTime,omitempty"`

	// Error message. Exists only in case the operation has reached a 'Failed' state.
	Message string `json:"message,omitempty"`

	OperationProcessingResult OperationProcessingResult `json:"-"`

	// Name of API endpoint that created the operation.
	OperationType string `json:"operationType,omitempty"`

	// Operation status.
	Status string `json:"status,omitempty"`
}

OperationResult operation result swagger:model OperationResult

func (OperationResult) MarshalJSON

func (m OperationResult) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object with a polymorphic type to a JSON structure

func (*OperationResult) UnmarshalJSON

func (m *OperationResult) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure

func (*OperationResult) Validate

func (m *OperationResult) Validate(formats strfmt.Registry) error

Validate validates this operation result

type SentimentBatchResultItemV2

type SentimentBatchResultItemV2 struct {

	// Unique document identifier.
	ID string `json:"id,omitempty"`

	// 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"`
}

SentimentBatchResultItemV2 sentiment batch result item v2 swagger:model SentimentBatchResultItemV2

func (*SentimentBatchResultItemV2) Validate

func (m *SentimentBatchResultItemV2) Validate(formats strfmt.Registry) error

Validate validates this sentiment batch result item v2

type SentimentBatchResultV2

type SentimentBatchResultV2 struct {

	// documents
	Documents []*SentimentBatchResultItemV2 `json:"documents"`

	// errors
	Errors []*ErrorRecordV2 `json:"errors"`
}

SentimentBatchResultV2 sentiment batch result v2 swagger:model SentimentBatchResultV2

func (*SentimentBatchResultV2) Validate

func (m *SentimentBatchResultV2) Validate(formats strfmt.Registry) error

Validate validates this sentiment batch result v2

type TopicAssignmentRecordV2

type TopicAssignmentRecordV2 struct {

	// Document-to-topic affiliation score between 0 and 1. The lower a distance score the stronger the topic affiliation is.
	Distance float64 `json:"distance,omitempty"`

	// Identifier for the document. Equates to the ID included in the input.
	DocumentID string `json:"documentId,omitempty"`

	// The topic ID which the document has been assigned to.
	TopicID string `json:"topicId,omitempty"`
}

TopicAssignmentRecordV2 topic assignment record v2 swagger:model TopicAssignmentRecordV2

func (*TopicAssignmentRecordV2) Validate

func (m *TopicAssignmentRecordV2) Validate(formats strfmt.Registry) error

Validate validates this topic assignment record v2

type TopicDetectionInputV2

type TopicDetectionInputV2 struct {

	// documents
	Documents []*InputV2 `json:"documents"`

	// List of words to ignore from all documents during pre-processing.
	StopWords []string `json:"stopWords"`

	// List of topics to omit from the response.
	TopicsToExclude []string `json:"topicsToExclude"`
}

TopicDetectionInputV2 topic detection input v2 swagger:model TopicDetectionInputV2

func (*TopicDetectionInputV2) Validate

func (m *TopicDetectionInputV2) Validate(formats strfmt.Registry) error

Validate validates this topic detection input v2

type TopicDetectionResultV2

type TopicDetectionResultV2 struct {

	// topic assignments
	TopicAssignments []*TopicAssignmentRecordV2 `json:"topicAssignments"`

	// topics
	Topics []*TopicInfoRecordV2 `json:"topics"`
	// contains filtered or unexported fields
}

TopicDetectionResultV2 This is object returned for the clustering call swagger:model TopicDetectionResultV2

func (*TopicDetectionResultV2) Discriminator

func (m *TopicDetectionResultV2) Discriminator() string

func (*TopicDetectionResultV2) Errors

func (m *TopicDetectionResultV2) Errors() []*ErrorRecordV2

func (TopicDetectionResultV2) MarshalJSON

func (m TopicDetectionResultV2) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*TopicDetectionResultV2) SetDiscriminator

func (m *TopicDetectionResultV2) SetDiscriminator(val string)

func (*TopicDetectionResultV2) SetErrors

func (m *TopicDetectionResultV2) SetErrors(val []*ErrorRecordV2)

func (*TopicDetectionResultV2) UnmarshalJSON

func (m *TopicDetectionResultV2) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*TopicDetectionResultV2) Validate

func (m *TopicDetectionResultV2) Validate(formats strfmt.Registry) error

Validate validates this topic detection result v2

type TopicInfoRecordV2

type TopicInfoRecordV2 struct {

	// A unique identifier for each topic.
	ID string `json:"id,omitempty"`

	// A summarizing word or phrase for the topic.
	KeyPhrase string `json:"keyPhrase,omitempty"`

	// Count of documents assigned to topic.
	Score float64 `json:"score,omitempty"`
}

TopicInfoRecordV2 topic info record v2 swagger:model TopicInfoRecordV2

func (*TopicInfoRecordV2) Validate

func (m *TopicInfoRecordV2) Validate(formats strfmt.Registry) error

Validate validates this topic info record v2

Jump to

Keyboard shortcuts

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