KeyPhraseDocumentResult

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

Bases: object

The document response for keyPhrases detect call.

Methods:

__init__(**kwargs)

Initializes a new KeyPhraseDocumentResult object with values from keyword arguments.

Attributes:

key

[Required] Gets the key of this KeyPhraseDocumentResult.

key_phrases

[Required] Gets the key_phrases of this KeyPhraseDocumentResult.

language_code

[Required] Gets the language_code of this KeyPhraseDocumentResult.

__init__(**kwargs)

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

Parameters
  • key (str) – The value to assign to the key property of this KeyPhraseDocumentResult.

  • key_phrases (list[oci.ai_language.models.KeyPhrase]) – The value to assign to the key_phrases property of this KeyPhraseDocumentResult.

  • language_code (str) – The value to assign to the language_code property of this KeyPhraseDocumentResult.

property key

[Required] Gets the key of this KeyPhraseDocumentResult. Document unique identifier defined by the user.

Returns

The key of this KeyPhraseDocumentResult.

Return type

str

property key_phrases

[Required] Gets the key_phrases of this KeyPhraseDocumentResult. List of detected keyPhrases.

Returns

The key_phrases of this KeyPhraseDocumentResult.

Return type

list[oci.ai_language.models.KeyPhrase]

property language_code

[Required] Gets the language_code of this KeyPhraseDocumentResult. Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew

Returns

The language_code of this KeyPhraseDocumentResult.

Return type

str