ailanguage

type AIServiceLanguageClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

type BatchDetectDominantLanguageDetails struct {

	// List of Documents for detect language.
	Documents []DominantLanguageDocument `mandatory:"true" json:"documents"`
}

type BatchDetectDominantLanguageRequest struct {

	// The details to make a language detection detect call.
	BatchDetectDominantLanguageDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type BatchDetectDominantLanguageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchDetectDominantLanguageResult instance
	BatchDetectDominantLanguageResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type BatchDetectDominantLanguageResult struct {

	// List of succeeded document response.
	Documents []DominantLanguageDocumentResult `mandatory:"true" json:"documents"`

	// List of failed document response.
	Errors []DocumentError `mandatory:"false" json:"errors"`
}

type BatchDetectLanguageEntitiesDetails struct {

	// List of Documents for detect entities.
	Documents []EntityDocument `mandatory:"true" json:"documents"`
}

type BatchDetectLanguageEntitiesRequest struct {

	// The details to make a Entity detect call.
	BatchDetectLanguageEntitiesDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type BatchDetectLanguageEntitiesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchDetectLanguageEntitiesResult instance
	BatchDetectLanguageEntitiesResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type BatchDetectLanguageEntitiesResult struct {

	// List of succeeded document response.
	Documents []EntityDocumentResult `mandatory:"true" json:"documents"`

	// List of failed document response.
	Errors []DocumentError `mandatory:"false" json:"errors"`
}

type BatchDetectLanguageKeyPhrasesDetails struct {

	// List of Documents for detect keyPhrases.
	Documents []KeyPhraseDocument `mandatory:"true" json:"documents"`
}

type BatchDetectLanguageKeyPhrasesRequest struct {

	// The details to make keyPhrase detect call.
	BatchDetectLanguageKeyPhrasesDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type BatchDetectLanguageKeyPhrasesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchDetectLanguageKeyPhrasesResult instance
	BatchDetectLanguageKeyPhrasesResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type BatchDetectLanguageKeyPhrasesResult struct {

	// List of succeeded document response.
	Documents []KeyPhraseDocumentResult `mandatory:"true" json:"documents"`

	// List of failed document response.
	Errors []DocumentError `mandatory:"false" json:"errors"`
}

type BatchDetectLanguageSentimentsDetails struct {

	// List of Documents for detect sentiments.
	Documents []SentimentsDocument `mandatory:"true" json:"documents"`
}

type BatchDetectLanguageSentimentsLevelEnum string

type BatchDetectLanguageSentimentsRequest struct {

	// The details to make sentiment detect call.
	BatchDetectLanguageSentimentsDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Set this parameter for sentence and aspect level sentiment analysis.
	// Allowed values are:
	//    - ASPECT
	//    - SENTENCE
	Level []BatchDetectLanguageSentimentsLevelEnum `contributesTo:"query" name:"level" omitEmpty:"true" collectionFormat:"multi"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type BatchDetectLanguageSentimentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchDetectLanguageSentimentsResult instance
	BatchDetectLanguageSentimentsResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type BatchDetectLanguageSentimentsResult struct {

	// List of succeeded document response.
	Documents []SentimentDocumentResult `mandatory:"true" json:"documents"`

	// List of failed document response.
	Errors []DocumentError `mandatory:"false" json:"errors"`
}

type BatchDetectLanguageTextClassificationDetails struct {

	// List of Documents for detect text classification.
	Documents []TextClassificationDocument `mandatory:"true" json:"documents"`
}

type BatchDetectLanguageTextClassificationRequest struct {

	// The details to make text classification detect call.
	BatchDetectLanguageTextClassificationDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type BatchDetectLanguageTextClassificationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchDetectLanguageTextClassificationResult instance
	BatchDetectLanguageTextClassificationResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type BatchDetectLanguageTextClassificationResult struct {

	// List of succeeded document response.
	Documents []TextClassificationDocumentResult `mandatory:"true" json:"documents"`

	// List of failed document response.
	Errors []DocumentError `mandatory:"false" json:"errors"`
}

type DetectDominantLanguageDetails struct {

	// Document text for detect language.
	Text *string `mandatory:"true" json:"text"`
}

type DetectDominantLanguageRequest struct {

	// The details to make a language detection detect call.
	DetectDominantLanguageDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type DetectDominantLanguageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DetectDominantLanguageResult instance
	DetectDominantLanguageResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type DetectDominantLanguageResult struct {

	// List of detected languages with results sorted in descending order of the scores. Most likely language is on top.
	Languages []DetectedLanguage `mandatory:"true" json:"languages"`
}

type DetectLanguageEntitiesDetails struct {

	// Document text for detect entities.
	Text *string `mandatory:"true" json:"text"`
}

type DetectLanguageEntitiesModelVersionEnum string

type DetectLanguageEntitiesRequest struct {

	// The details to make a Entity detect call.
	DetectLanguageEntitiesDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Named Entity Recognition model versions. By default user will get output from V2.1 implementation.
	ModelVersion DetectLanguageEntitiesModelVersionEnum `mandatory:"false" contributesTo:"query" name:"modelVersion" omitEmpty:"true"`

	// If this parameter is set to true, you only get PII (Personally identifiable information) entities
	// like PhoneNumber, Email, Person, and so on. Default value is false.
	IsPii *bool `mandatory:"false" contributesTo:"query" name:"isPii"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type DetectLanguageEntitiesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DetectLanguageEntitiesResult instance
	DetectLanguageEntitiesResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type DetectLanguageEntitiesResult struct {

	// List of detected entities.
	Entities []Entity `mandatory:"true" json:"entities"`
}

type DetectLanguageKeyPhrasesDetails struct {

	// Document text for detect keyPhrases.
	Text *string `mandatory:"true" json:"text"`
}

type DetectLanguageKeyPhrasesRequest struct {

	// The details to make keyPhrase detect call.
	DetectLanguageKeyPhrasesDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type DetectLanguageKeyPhrasesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DetectLanguageKeyPhrasesResult instance
	DetectLanguageKeyPhrasesResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type DetectLanguageKeyPhrasesResult struct {

	// List of detected keyPhrases.
	KeyPhrases []KeyPhrase `mandatory:"true" json:"keyPhrases"`
}

type DetectLanguageSentimentsDetails struct {

	// Document text for detect sentiments.
	Text *string `mandatory:"true" json:"text"`
}

type DetectLanguageSentimentsRequest struct {

	// The details to make sentiment detect call.
	DetectLanguageSentimentsDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type DetectLanguageSentimentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DetectLanguageSentimentsResult instance
	DetectLanguageSentimentsResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type DetectLanguageSentimentsResult struct {

	// List of detected aspects.
	Aspects []SentimentAspect `mandatory:"true" json:"aspects"`
}

type DetectLanguageTextClassificationDetails struct {

	// Document text for detect text classes.
	Text *string `mandatory:"true" json:"text"`
}

type DetectLanguageTextClassificationRequest struct {

	// The details to make text classification detect call.
	DetectLanguageTextClassificationDetails `contributesTo:"body"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

type DetectLanguageTextClassificationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DetectLanguageTextClassificationResult instance
	DetectLanguageTextClassificationResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

type DetectLanguageTextClassificationResult struct {

	// List of detected text classes.
	TextClassification []TextClassification `mandatory:"true" json:"textClassification"`
}

type DetectedLanguage struct {

	// Full language name.
	// Example: `English, Hindi, and so on`
	Name *string `mandatory:"true" json:"name"`

	// Detected language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	// Example: `en, fr, hi etc`.
	Code *string `mandatory:"true" json:"code"`

	// Score or confidence of detected language code.
	// Example: `0.9999856066867399`
	Score *float64 `mandatory:"true" json:"score"`
}

type DocumentError struct {

	// Unique Document Identifier.
	Key *string `mandatory:"true" json:"key"`

	Error *ErrorDetails `mandatory:"true" json:"error"`
}

type DominantLanguageDocument struct {

	// Document unique identifier defined by the user.
	Key *string `mandatory:"true" json:"key"`

	// Document text for detect language.
	Text *string `mandatory:"true" json:"text"`
}

type DominantLanguageDocumentResult struct {

	// Document unique identifier defined by the user.
	Key *string `mandatory:"true" json:"key"`

	// List of detected languages with results sorted in descending order of the scores. Most likely language is on top.
	Languages []DetectedLanguage `mandatory:"true" json:"languages"`
}

type Entity struct {

	// The number of Unicode code points preceding this entity in the submitted text.
	Offset *int `mandatory:"false" json:"offset"`

	// Length of entity text
	Length *int `mandatory:"false" json:"length"`

	// Entity text like name of person, location, and so on.
	Text *string `mandatory:"false" json:"text"`

	// Type of entity text like PER, LOC, GPE and NOPE.
	Type *string `mandatory:"false" json:"type"`

	// This flag is to indicate if it is PII entity or not.
	IsPii *bool `mandatory:"false" json:"isPii"`

	// Score or confidence of extracted entity type.
	// Example: `0.9999856066867399`
	Score *float64 `mandatory:"false" json:"score"`
}

type EntityDocument struct {

	// Document unique identifier defined by the user.
	Key *string `mandatory:"true" json:"key"`

	// Document text for detect entities.
	Text *string `mandatory:"true" json:"text"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

type EntityDocumentResult struct {

	// Document unique identifier defined by the user.
	Key *string `mandatory:"true" json:"key"`

	// List of detected entities.
	Entities []HierarchicalEntity `mandatory:"true" json:"entities"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"true" json:"languageCode"`
}

type ErrorDetails struct {

	// A short error code that defines the error, meant for programmatic parsing.
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`
}

type HierarchicalEntity struct {

	// The number of Unicode code points preceding this entity in the submitted text.
	Offset *int `mandatory:"false" json:"offset"`

	// Length of entity text
	Length *int `mandatory:"false" json:"length"`

	// Entity text like name of person, location, and so on.
	Text *string `mandatory:"false" json:"text"`

	// Type of entity text like PER, LOC.
	Type *string `mandatory:"false" json:"type"`

	// Sub-type of entity text like GPE for LOCATION type
	SubType *string `mandatory:"false" json:"subType"`

	// Score or confidence for detected entity.
	Score *float64 `mandatory:"false" json:"score"`
}

type KeyPhrase struct {

	// Key phrase exreacted from given text.
	Text *string `mandatory:"true" json:"text"`

	// Score or confidence of the key phrase.
	// Example: `0.9999856066867399`
	Score *float64 `mandatory:"true" json:"score"`
}

type KeyPhraseDocument struct {

	// Document Unique Identifier.
	Key *string `mandatory:"true" json:"key"`

	// Document text for detect keyPhrases.
	Text *string `mandatory:"true" json:"text"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard..
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

type KeyPhraseDocumentResult struct {

	// Document Unique Identifier.
	Key *string `mandatory:"true" json:"key"`

	// List of detected keyPhrases.
	KeyPhrases []KeyPhrase `mandatory:"true" json:"keyPhrases"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"true" json:"languageCode"`
}

type NerModelVersionEnum string

type SentimentAspect struct {

	// The number of Unicode code points preceding this entity in the submitted text.
	Offset *int `mandatory:"false" json:"offset"`

	// Length of aspect text.
	Length *int `mandatory:"false" json:"length"`

	// Aspect text.
	Text *string `mandatory:"false" json:"text"`

	// The highest-score sentiment for the aspect text.
	Sentiment *string `mandatory:"false" json:"sentiment"`

	// Scores or confidences for each sentiment.
	// Example: `{"positive": 1.0, "negative": 0.0}`
	Scores map[string]float64 `mandatory:"false" json:"scores"`
}

type SentimentDocumentResult struct {

	// Document Unique Identifier.
	Key *string `mandatory:"true" json:"key"`

	// List of detected aspects sentiment.
	Aspects []SentimentAspect `mandatory:"true" json:"aspects"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"true" json:"languageCode"`

	// Document level sentiment.
	DocumentSentiment *string `mandatory:"false" json:"documentSentiment"`

	// Scores for each sentiment.
	// Example: {"positive": 1.0, "negative": 0.0}
	DocumentScores map[string]float64 `mandatory:"false" json:"documentScores"`

	// List of detected sentences sentiment.
	Sentences []SentimentSentence `mandatory:"false" json:"sentences"`
}

type SentimentSentence struct {

	// The number of Unicode code points preceding this entity in the submitted text.
	Offset *int `mandatory:"false" json:"offset"`

	// Length of sentence text.
	Length *int `mandatory:"false" json:"length"`

	// Sentence text.
	Text *string `mandatory:"false" json:"text"`

	// The highest-score sentiment for the sentence text.
	Sentiment *string `mandatory:"false" json:"sentiment"`

	// Scores or confidences for each sentiment.
	// Example: `{"positive": 1.0, "negative": 0.0}`
	Scores map[string]float64 `mandatory:"false" json:"scores"`
}

type SentimentsDocument struct {

	// Document Unique Identifier.
	Key *string `mandatory:"true" json:"key"`

	// Document text for detect sentiments.
	Text *string `mandatory:"true" json:"text"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

type TextClassification struct {

	// Label of the the given text.
	Label *string `mandatory:"true" json:"label"`

	// Score or confidence of extracted text label.
	// Example: `0.9999856066867399`
	Score *float64 `mandatory:"true" json:"score"`
}

type TextClassificationDocument struct {

	// Document Unique Identifier.
	Key *string `mandatory:"true" json:"key"`

	// Document text for detect text classification.
	Text *string `mandatory:"true" json:"text"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

type TextClassificationDocumentResult struct {

	// Document Unique Identifier.
	Key *string `mandatory:"true" json:"key"`

	// List of detected text classes.
	TextClassification []TextClassification `mandatory:"true" json:"textClassification"`

	// Language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
	LanguageCode *string `mandatory:"true" json:"languageCode"`
}