Skip to content

KeywordLibProps

Properties for defining a KeywordLib.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-aligreen-keywordlib

Initializer

import { KeywordLibProps } from '@alicloud/ros-cdk-aligreen'
const keywordLibProps: KeywordLibProps = { ... }

Properties

Name Type Description
keywordLibName string | @alicloud/ros-cdk-core.IResolvable Property keywordLibName: The name of the keyword library defined by the customer.
resourceType string | @alicloud/ros-cdk-core.IResolvable Property resourceType: The moderation scenario to which the text library applies.
bizTypes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property bizTypes: The business scenario.
category string | @alicloud/ros-cdk-core.IResolvable Property category: The category of the text library.
enable boolean | @alicloud/ros-cdk-core.IResolvable Property enable: Specifies whether to enable text library.true: Enable the text library. This is the default value.false: Disable the text library.
language string | @alicloud/ros-cdk-core.IResolvable Property language: Language used by the text Library.
libType string | @alicloud/ros-cdk-core.IResolvable Property libType: The category of the text library in each moderation scenario.
matchMode string | @alicloud/ros-cdk-core.IResolvable Property matchMode: The matching method.

keywordLibNameRequired

public readonly keywordLibName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property keywordLibName: The name of the keyword library defined by the customer.

It can contain no more than 20 characters in Chinese, English, and underscore (_).


resourceTypeRequired

public readonly resourceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceType: The moderation scenario to which the text library applies.

Valid values:TEXT: text anti-spam、IMAGE: ad violation detection、VOICE: audio anti-spam.


bizTypesOptional

public readonly bizTypes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property bizTypes: The business scenario.

Example:["bizTypeA","bizTypeB"].


categoryOptional

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The category of the text library.

Valid values: BLACK: a blacklist. WHITE: a whitelist. REVIEW: a review list.


enableOptional

public readonly enable: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enable: Specifies whether to enable text library.true: Enable the text library. This is the default value.false: Disable the text library.


languageOptional

public readonly language: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property language: Language used by the text Library.

Example: zh:Chinese、en:English


libTypeOptional

public readonly libType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property libType: The category of the text library in each moderation scenario.

Valid values: textKeyword: a text library against which terms in text are matched. similarText: a text library against which text patterns are matched. voiceText: a text library against which terms converted from audio are matched.


matchModeOptional

public readonly matchMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property matchMode: The matching method.

Valid values:fuzzy: fuzzy match precise: exact match.