BatchDetectHealthEntityDetails

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

Bases: object

The documents details for health entities detect call.

Methods

__init__(**kwargs) Initializes a new BatchDetectHealthEntityDetails object with values from keyword arguments.

Attributes

alias Gets the alias of this BatchDetectHealthEntityDetails.
documents [Required] Gets the documents of this BatchDetectHealthEntityDetails.
endpoint_id [Required] Gets the endpoint_id of this BatchDetectHealthEntityDetails.
is_detect_assertions Gets the is_detect_assertions of this BatchDetectHealthEntityDetails.
is_detect_relationships Gets the is_detect_relationships of this BatchDetectHealthEntityDetails.
link_ontologies Gets the link_ontologies of this BatchDetectHealthEntityDetails.
profile Gets the profile of this BatchDetectHealthEntityDetails.
__init__(**kwargs)

Initializes a new BatchDetectHealthEntityDetails 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 BatchDetectHealthEntityDetails.
  • endpoint_id (str) – The value to assign to the endpoint_id property of this BatchDetectHealthEntityDetails.
  • documents (list[oci.ai_language.models.TextDocument]) – The value to assign to the documents property of this BatchDetectHealthEntityDetails.
  • link_ontologies (list[str]) – The value to assign to the link_ontologies property of this BatchDetectHealthEntityDetails.
  • is_detect_assertions (bool) – The value to assign to the is_detect_assertions property of this BatchDetectHealthEntityDetails.
  • is_detect_relationships (bool) – The value to assign to the is_detect_relationships property of this BatchDetectHealthEntityDetails.
  • profile (oci.ai_language.models.Profile) – The value to assign to the profile property of this BatchDetectHealthEntityDetails.
alias

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

Returns:The alias of this BatchDetectHealthEntityDetails.
Return type:str
documents

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

Returns:The documents of this BatchDetectHealthEntityDetails.
Return type:list[oci.ai_language.models.TextDocument]
endpoint_id

[Required] Gets the endpoint_id of this BatchDetectHealthEntityDetails. The endpoint which have to be used for inferencing.

Returns:The endpoint_id of this BatchDetectHealthEntityDetails.
Return type:str
is_detect_assertions

Gets the is_detect_assertions of this BatchDetectHealthEntityDetails. is assertion on input text required. default value true.

Returns:The is_detect_assertions of this BatchDetectHealthEntityDetails.
Return type:bool
is_detect_relationships

Gets the is_detect_relationships of this BatchDetectHealthEntityDetails. is relationship on input text required. default value true.

Returns:The is_detect_relationships of this BatchDetectHealthEntityDetails.
Return type:bool

Gets the link_ontologies of this BatchDetectHealthEntityDetails. List of NLP health ontologies to be linked

Returns:The link_ontologies of this BatchDetectHealthEntityDetails.
Return type:list[str]
profile

Gets the profile of this BatchDetectHealthEntityDetails.

Returns:The profile of this BatchDetectHealthEntityDetails.
Return type:oci.ai_language.models.Profile