BatchDetectDominantLanguageDetails

class oci.ai_language.models.BatchDetectDominantLanguageDetails(**kwargs)

Bases: object

The documents details for language detect call.

Methods:

__init__(**kwargs)

Initializes a new BatchDetectDominantLanguageDetails object with values from keyword arguments.

Attributes:

alias

Gets the alias of this BatchDetectDominantLanguageDetails.

chars_to_consider

Gets the chars_to_consider of this BatchDetectDominantLanguageDetails.

compartment_id

Gets the compartment_id of this BatchDetectDominantLanguageDetails.

documents

[Required] Gets the documents of this BatchDetectDominantLanguageDetails.

endpoint_id

Gets the endpoint_id of this BatchDetectDominantLanguageDetails.

should_ignore_transliteration

Gets the should_ignore_transliteration of this BatchDetectDominantLanguageDetails.

__init__(**kwargs)

Initializes a new BatchDetectDominantLanguageDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • alias (str) – The value to assign to the alias property of this BatchDetectDominantLanguageDetails.

  • should_ignore_transliteration (bool) – The value to assign to the should_ignore_transliteration property of this BatchDetectDominantLanguageDetails.

  • chars_to_consider (int) – The value to assign to the chars_to_consider property of this BatchDetectDominantLanguageDetails.

  • endpoint_id (str) – The value to assign to the endpoint_id property of this BatchDetectDominantLanguageDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this BatchDetectDominantLanguageDetails.

  • documents (list[oci.ai_language.models.DominantLanguageDocument]) – The value to assign to the documents property of this BatchDetectDominantLanguageDetails.

property alias

Gets the alias of this BatchDetectDominantLanguageDetails. Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns

The alias of this BatchDetectDominantLanguageDetails.

Return type

str

property chars_to_consider

Gets the chars_to_consider of this BatchDetectDominantLanguageDetails. default value is None. Specifies maximum number of characters to consider for determining the dominant language. If unspecified, then optimum number characters will be considered. If 0 is specified then all the characters are used to determine the language. If the value is greater than 0, then specified number of characters will be considered from the beginning of the text.

Returns

The chars_to_consider of this BatchDetectDominantLanguageDetails.

Return type

int

property compartment_id

Gets the compartment_id of this BatchDetectDominantLanguageDetails. The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns

The compartment_id of this BatchDetectDominantLanguageDetails.

Return type

str

property documents

[Required] Gets the documents of this BatchDetectDominantLanguageDetails. List of Documents for detect language.

Returns

The documents of this BatchDetectDominantLanguageDetails.

Return type

list[oci.ai_language.models.DominantLanguageDocument]

property endpoint_id

Gets the endpoint_id of this BatchDetectDominantLanguageDetails. The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.

Returns

The endpoint_id of this BatchDetectDominantLanguageDetails.

Return type

str

property should_ignore_transliteration

Gets the should_ignore_transliteration of this BatchDetectDominantLanguageDetails. Specifies whether to consider or ignore transliteration. For example “hi, aap kaise ho? sab kuch teek hai? I will call you tomorrow.” would be detected as English when ignore transliteration=true, Hindi when ignoreTransliteration=false.

Returns

The should_ignore_transliteration of this BatchDetectDominantLanguageDetails.

Return type

bool