Skip to content

Creates an extraction definition in the specified Connect Customer instance

Description

Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found.

Usage

connect_create_extraction_definition(ClientToken, InstanceId, Name,
  ExtractionConfiguration, Display, Tags)

Arguments

  • ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field.

  • InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name

[required] A unique name of the extraction definition.

  • ExtractionConfiguration

[required] The configuration that defines how data is extracted, including the prompt hint and not-found behavior.

  • Display

The display settings for the extraction definition, including the label shown in the agent workspace.

  • Tags

The tags used to organize, track, or control access for this resource.

Value

A list with the following syntax:

list(
  ExtractionDefinitionArn = "string",
  ExtractionDefinitionId = "string"
)

Request syntax

svc$create_extraction_definition(
  ClientToken = "string",
  InstanceId = "string",
  Name = "string",
  ExtractionConfiguration = list(
    PromptHint = "string",
    NotFoundBehavior = list(
      Behavior = "USE_DEFAULT_VALUE"|"OMIT",
      DefaultValue = "string"
    )
  ),
  Display = list(
    Label = "string"
  ),
  Tags = list(
    "string"
  )
)