BatchDetectLanguageKeyPhrasesDetails

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

Bases: object

The documents details for keyPhrases call.

Methods:

__init__(**kwargs)

Initializes a new BatchDetectLanguageKeyPhrasesDetails object with values from keyword arguments.

Attributes:

alias

Gets the alias of this BatchDetectLanguageKeyPhrasesDetails.

compartment_id

Gets the compartment_id of this BatchDetectLanguageKeyPhrasesDetails.

documents

[Required] Gets the documents of this BatchDetectLanguageKeyPhrasesDetails.

endpoint_id

Gets the endpoint_id of this BatchDetectLanguageKeyPhrasesDetails.

__init__(**kwargs)

Initializes a new BatchDetectLanguageKeyPhrasesDetails 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 BatchDetectLanguageKeyPhrasesDetails.

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

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

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

property alias

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

Returns

The alias of this BatchDetectLanguageKeyPhrasesDetails.

Return type

str

property compartment_id

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

Returns

The compartment_id of this BatchDetectLanguageKeyPhrasesDetails.

Return type

str

property documents

[Required] Gets the documents of this BatchDetectLanguageKeyPhrasesDetails. List of Documents for detect keyPhrases.

Returns

The documents of this BatchDetectLanguageKeyPhrasesDetails.

Return type

list[oci.ai_language.models.TextDocument]

property endpoint_id

Gets the endpoint_id of this BatchDetectLanguageKeyPhrasesDetails. 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 BatchDetectLanguageKeyPhrasesDetails.

Return type

str