CxEntityType

class CxEntityType : KotlinCustomResource

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. To get more information about EntityType, see:

Example Usage

Dialogflowcx Entity Type Full

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.diagflow.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
import com.pulumi.gcp.diagflow.CxEntityType;
import com.pulumi.gcp.diagflow.CxEntityTypeArgs;
import com.pulumi.gcp.diagflow.inputs.CxEntityTypeEntityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var agent = new CxAgent("agent", CxAgentArgs.builder()
.displayName("dialogflowcx-agent")
.location("global")
.defaultLanguageCode("en")
.supportedLanguageCodes(
"fr",
"de",
"es")
.timeZone("America/New_York")
.description("Example description.")
.avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
.enableStackdriverLogging(true)
.enableSpellCorrection(true)
.speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
.enableSpeechAdaptation(true)
.build())
.build());
var basicEntityType = new CxEntityType("basicEntityType", CxEntityTypeArgs.builder()
.parent(agent.id())
.displayName("MyEntity")
.kind("KIND_MAP")
.entities(
CxEntityTypeEntityArgs.builder()
.value("value1")
.synonyms(
"synonym1",
"synonym2")
.build(),
CxEntityTypeEntityArgs.builder()
.value("value2")
.synonyms(
"synonym3",
"synonym4")
.build())
.enableFuzzyExtraction(false)
.build());
}
}

Import

EntityType can be imported using any of these accepted formats

$ pulumi import gcp:diagflow/cxEntityType:CxEntityType default {{parent}}/entityTypes/{{name}}
$ pulumi import gcp:diagflow/cxEntityType:CxEntityType default {{parent}}/{{name}}

Properties

Link copied to clipboard

Represents kinds of entities.

Link copied to clipboard
val displayName: Output<String>

The human-readable name of the entity type, unique within the agent.

Link copied to clipboard

Enables fuzzy entity extraction during classification.

Link copied to clipboard

The collection of entity entries associated with the entity type. Structure is documented below.

Link copied to clipboard

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kind: Output<String>

Indicates whether the entity type can be automatically expanded.

Link copied to clipboard
val languageCode: Output<String>?

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Link copied to clipboard
val name: Output<String>

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

Link copied to clipboard
val parent: Output<String>?

The agent to create a entity type for. Format: projects//locations//agents/.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val redact: Output<Boolean>?

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

Link copied to clipboard
val urn: Output<String>