BatchDetectLanguageEntitiesDetails

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

Bases: object

The documents details for entities detect call.

Methods:

__init__(**kwargs)

Initializes a new BatchDetectLanguageEntitiesDetails object with values from keyword arguments.

Attributes:

alias

Gets the alias of this BatchDetectLanguageEntitiesDetails.

compartment_id

Gets the compartment_id of this BatchDetectLanguageEntitiesDetails.

documents

[Required] Gets the documents of this BatchDetectLanguageEntitiesDetails.

endpoint_id

Gets the endpoint_id of this BatchDetectLanguageEntitiesDetails.

__init__(**kwargs)

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

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

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

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

property alias

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

Returns

The alias of this BatchDetectLanguageEntitiesDetails.

Return type

str

property compartment_id

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

Returns

The compartment_id of this BatchDetectLanguageEntitiesDetails.

Return type

str

property documents

[Required] Gets the documents of this BatchDetectLanguageEntitiesDetails. List of Documents for detect entities.

Returns

The documents of this BatchDetectLanguageEntitiesDetails.

Return type

list[oci.ai_language.models.TextDocument]

property endpoint_id

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

Return type

str