types

package
v1.16.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 3, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AIAgentAssociationConfigurationType added in v1.12.0 

type AIAgentAssociationConfigurationType string
const (
	AIAgentAssociationConfigurationTypeKnowledgeBase AIAgentAssociationConfigurationType = "KNOWLEDGE_BASE"
)

Enum values for AIAgentAssociationConfigurationType

func (AIAgentAssociationConfigurationType) Values added in v1.12.0 

func (AIAgentAssociationConfigurationType) Values() []AIAgentAssociationConfigurationType

Values returns all known values for AIAgentAssociationConfigurationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AIAgentConfiguration added in v1.12.0 

type AIAgentConfiguration interface {
	// contains filtered or unexported methods
}

A typed union that specifies the configuration based on the type of AI Agent.

The following types satisfy this interface: 

AIAgentConfigurationMemberAnswerRecommendationAIAgentConfiguration
AIAgentConfigurationMemberManualSearchAIAgentConfiguration
AIAgentConfigurationMemberSelfServiceAIAgentConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.AIAgentConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AIAgentConfigurationMemberAnswerRecommendationAIAgentConfiguration:
		_ = v.Value // Value is types.AnswerRecommendationAIAgentConfiguration

	case *types.AIAgentConfigurationMemberManualSearchAIAgentConfiguration:
		_ = v.Value // Value is types.ManualSearchAIAgentConfiguration

	case *types.AIAgentConfigurationMemberSelfServiceAIAgentConfiguration:
		_ = v.Value // Value is types.SelfServiceAIAgentConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AIAgentConfigurationData added in v1.12.0 

type AIAgentConfigurationData struct {

	// The ID of the AI Agent to be configured.
	//
	// This member is required.
	AiAgentId *string
	// contains filtered or unexported fields
}

A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

type AIAgentConfigurationMemberAnswerRecommendationAIAgentConfiguration added in v1.12.0 

type AIAgentConfigurationMemberAnswerRecommendationAIAgentConfiguration struct {
	Value AnswerRecommendationAIAgentConfiguration
	// contains filtered or unexported fields
}

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

type AIAgentConfigurationMemberManualSearchAIAgentConfiguration added in v1.12.0 

type AIAgentConfigurationMemberManualSearchAIAgentConfiguration struct {
	Value ManualSearchAIAgentConfiguration
	// contains filtered or unexported fields
}

The configuration for AI Agents of type MANUAL_SEARCH .

type AIAgentConfigurationMemberSelfServiceAIAgentConfiguration added in v1.14.0 

type AIAgentConfigurationMemberSelfServiceAIAgentConfiguration struct {
	Value SelfServiceAIAgentConfiguration
	// contains filtered or unexported fields
}

The configuration for AI Agents of type SELF_SERVICE.

type AIAgentData added in v1.12.0 

type AIAgentData struct {

	// The Amazon Resource Name (ARN) of the AI agent.
	//
	// This member is required.
	AiAgentArn *string

	// The identifier of the AI Agent.
	//
	// This member is required.
	AiAgentId *string

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// Configuration for the AI Agent.
	//
	// This member is required.
	Configuration AIAgentConfiguration

	// The name of the AI Agent.
	//
	// This member is required.
	Name *string

	// The type of the AI Agent.
	//
	// This member is required.
	Type AIAgentType

	// The visibility status of the AI Agent.
	//
	// This member is required.
	VisibilityStatus VisibilityStatus

	// The description of the AI Agent.
	Description *string

	// The time the AI Agent was last modified.
	ModifiedTime *time.Time

	// Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by
	// Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation
	// APIs.
	Origin Origin

	// The status of the AI Agent.
	Status Status

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The data for the AI Agent.

type AIAgentSummary added in v1.12.0 

type AIAgentSummary struct {

	// The Amazon Resource Name (ARN) of the AI agent.
	//
	// This member is required.
	AiAgentArn *string

	// The identifier of the AI Agent.
	//
	// This member is required.
	AiAgentId *string

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The name of the AI Agent.
	//
	// This member is required.
	Name *string

	// The type of the AI Agent.
	//
	// This member is required.
	Type AIAgentType

	// The visibility status of the AI Agent.
	//
	// This member is required.
	VisibilityStatus VisibilityStatus

	// The configuration for the AI Agent.
	Configuration AIAgentConfiguration

	// The description of the AI Agent.
	Description *string

	// The time the AI Agent was last modified.
	ModifiedTime *time.Time

	// The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in
	// Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
	Origin Origin

	// The status of the AI Agent.
	Status Status

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The summary of the AI Agent.

type AIAgentType added in v1.12.0 

type AIAgentType string
const (
	AIAgentTypeManualSearch         AIAgentType = "MANUAL_SEARCH"
	AIAgentTypeAnswerRecommendation AIAgentType = "ANSWER_RECOMMENDATION"
	AIAgentTypeSelfService          AIAgentType = "SELF_SERVICE"
)

Enum values for AIAgentType

func (AIAgentType) Values added in v1.12.0 

func (AIAgentType) Values() []AIAgentType

Values returns all known values for AIAgentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AIAgentVersionSummary added in v1.12.0 

type AIAgentVersionSummary struct {

	// The data for the summary of the AI Agent version.
	AiAgentSummary *AIAgentSummary

	// The version number for this AI Agent version.
	VersionNumber *int64
	// contains filtered or unexported fields
}

The summary of the AI Agent version.

type AIGuardrailContentPolicyConfig added in v1.14.0 

type AIGuardrailContentPolicyConfig struct {

	// Contains the type of the content filter and how strongly it should apply to
	// prompts and model responses.
	//
	// This member is required.
	FiltersConfig []GuardrailContentFilterConfig
	// contains filtered or unexported fields
}

Contains details about how to handle harmful content.

type AIGuardrailContextualGroundingPolicyConfig added in v1.14.0 

type AIGuardrailContextualGroundingPolicyConfig struct {

	// The filter configuration details for the AI Guardrails contextual grounding
	// policy.
	//
	// This member is required.
	FiltersConfig []GuardrailContextualGroundingFilterConfig
	// contains filtered or unexported fields
}

The policy configuration details for the AI Guardrail's contextual grounding policy.

type AIGuardrailData added in v1.14.0 

type AIGuardrailData struct {

	// The Amazon Resource Name (ARN) of the AI Guardrail.
	//
	// This member is required.
	AiGuardrailArn *string

	// The identifier of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	AiGuardrailId *string

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The message to return when the AI Guardrail blocks a prompt.
	//
	// This member is required.
	BlockedInputMessaging *string

	// The message to return when the AI Guardrail blocks a model response.
	//
	// This member is required.
	BlockedOutputsMessaging *string

	// The name of the AI Guardrail.
	//
	// This member is required.
	Name *string

	// The visibility status of the AI Guardrail.
	//
	// This member is required.
	VisibilityStatus VisibilityStatus

	// Contains details about how to handle harmful content.
	ContentPolicyConfig *AIGuardrailContentPolicyConfig

	// The policy configuration details for the AI Guardrail's contextual grounding
	// policy.
	ContextualGroundingPolicyConfig *AIGuardrailContextualGroundingPolicyConfig

	// A description of the AI Guardrail.
	Description *string

	// The time the AI Guardrail was last modified.
	ModifiedTime *time.Time

	// Contains details about PII entities and regular expressions to configure for
	// the AI Guardrail.
	SensitiveInformationPolicyConfig *AIGuardrailSensitiveInformationPolicyConfig

	// The status of the AI Guardrail.
	Status Status

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// Contains details about topics that the AI Guardrail should identify and deny.
	TopicPolicyConfig *AIGuardrailTopicPolicyConfig

	// Contains details about the word policy to configured for the AI Guardrail.
	WordPolicyConfig *AIGuardrailWordPolicyConfig
	// contains filtered or unexported fields
}

The data for the AI Guardrail

type AIGuardrailSensitiveInformationPolicyConfig added in v1.14.0 

type AIGuardrailSensitiveInformationPolicyConfig struct {

	// A list of PII entities to configure to the AI Guardrail.
	PiiEntitiesConfig []GuardrailPiiEntityConfig

	// A list of regular expressions to configure to the AI Guardrail.
	RegexesConfig []GuardrailRegexConfig
	// contains filtered or unexported fields
}

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

type AIGuardrailSummary added in v1.14.0 

type AIGuardrailSummary struct {

	// The Amazon Resource Name (ARN) of the AI Guardrail.
	//
	// This member is required.
	AiGuardrailArn *string

	// The identifier of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	AiGuardrailId *string

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The name of the AI Guardrail.
	//
	// This member is required.
	Name *string

	// The visibility status of the AI Guardrail.
	//
	// This member is required.
	VisibilityStatus VisibilityStatus

	// A description of the AI Guardrail.
	Description *string

	// The time the AI Guardrail was last modified.
	ModifiedTime *time.Time

	// The status of the AI Guardrail.
	Status Status

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The summary of the AI Guardrail.

type AIGuardrailTopicPolicyConfig added in v1.14.0 

type AIGuardrailTopicPolicyConfig struct {

	// A list of policies related to topics that the AI Guardrail should deny.
	//
	// This member is required.
	TopicsConfig []GuardrailTopicConfig
	// contains filtered or unexported fields
}

Contains details about topics that the AI Guardrail should identify and deny.

type AIGuardrailVersionSummary added in v1.14.0 

type AIGuardrailVersionSummary struct {

	// The data for the summary of the AI Guardrail version.
	AiGuardrailSummary *AIGuardrailSummary

	// The version number for this AI Guardrail version.
	VersionNumber *int64
	// contains filtered or unexported fields
}

The summary of the AI Guardrail version.

type AIGuardrailWordPolicyConfig added in v1.14.0 

type AIGuardrailWordPolicyConfig struct {

	// A list of managed words to configure for the AI Guardrail.
	ManagedWordListsConfig []GuardrailManagedWordsConfig

	// A list of words to configure for the AI Guardrail.
	WordsConfig []GuardrailWordConfig
	// contains filtered or unexported fields
}

Contains details about the word policy to configured for the AI Guardrail.

type AIPromptAPIFormat added in v1.12.0 

type AIPromptAPIFormat string
const (
	AIPromptAPIFormatAnthropicClaudeMessages        AIPromptAPIFormat = "ANTHROPIC_CLAUDE_MESSAGES"
	AIPromptAPIFormatAnthropicClaudeTextCompletions AIPromptAPIFormat = "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS"
)

Enum values for AIPromptAPIFormat

func (AIPromptAPIFormat) Values added in v1.12.0 

func (AIPromptAPIFormat) Values() []AIPromptAPIFormat

Values returns all known values for AIPromptAPIFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AIPromptData added in v1.12.0 

type AIPromptData struct {

	// The Amazon Resource Name (ARN) of the AI Prompt.
	//
	// This member is required.
	AiPromptArn *string

	// The identifier of the Amazon Q in Connect AI prompt.
	//
	// This member is required.
	AiPromptId *string

	// The API format used for this AI Prompt.
	//
	// This member is required.
	ApiFormat AIPromptAPIFormat

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the model used for this AI Prompt. Model Ids supported are:
	// anthropic.claude-3-haiku-20240307-v1:0 .
	//
	// This member is required.
	ModelId *string

	// The name of the AI Prompt
	//
	// This member is required.
	Name *string

	// The configuration of the prompt template for this AI Prompt.
	//
	// This member is required.
	TemplateConfiguration AIPromptTemplateConfiguration

	// The type of the prompt template for this AI Prompt.
	//
	// This member is required.
	TemplateType AIPromptTemplateType

	// The type of this AI Prompt.
	//
	// This member is required.
	Type AIPromptType

	// The visibility status of the AI Prompt.
	//
	// This member is required.
	VisibilityStatus VisibilityStatus

	// The description of the AI Prompt.
	Description *string

	// The time the AI Prompt was last modified.
	ModifiedTime *time.Time

	// The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in
	// Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation
	// APIs.
	Origin Origin

	// The status of the AI Prompt.
	Status Status

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The data for the AI Prompt

type AIPromptSummary added in v1.12.0 

type AIPromptSummary struct {

	// The Amazon Resource Name (ARN) of the AI Prompt.
	//
	// This member is required.
	AiPromptArn *string

	// The identifier of the Amazon Q in Connect AI prompt.
	//
	// This member is required.
	AiPromptId *string

	// The API format used for this AI Prompt.
	//
	// This member is required.
	ApiFormat AIPromptAPIFormat

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the model used for this AI Prompt. Model Ids supported are:
	// anthropic.claude-3-haiku-20240307-v1:0 .
	//
	// This member is required.
	ModelId *string

	// The name of the AI Prompt.
	//
	// This member is required.
	Name *string

	// The type of the prompt template for this AI Prompt.
	//
	// This member is required.
	TemplateType AIPromptTemplateType

	// The type of this AI Prompt.
	//
	// This member is required.
	Type AIPromptType

	// The visibility status of the AI Prompt.
	//
	// This member is required.
	VisibilityStatus VisibilityStatus

	// The description of the AI Prompt.
	Description *string

	// The time the AI Prompt was last modified.
	ModifiedTime *time.Time

	// The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in
	// Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation
	// APIs.
	Origin Origin

	// The status of the AI Prompt.
	Status Status

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The summary of the AI Prompt.

type AIPromptTemplateConfiguration added in v1.12.0 

type AIPromptTemplateConfiguration interface {
	// contains filtered or unexported methods
}

A typed union that specifies the configuration for a prompt template based on its type.

The following types satisfy this interface: 

AIPromptTemplateConfigurationMemberTextFullAIPromptEditTemplateConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.AIPromptTemplateConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AIPromptTemplateConfigurationMemberTextFullAIPromptEditTemplateConfiguration:
		_ = v.Value // Value is types.TextFullAIPromptEditTemplateConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AIPromptTemplateConfigurationMemberTextFullAIPromptEditTemplateConfiguration added in v1.12.0 

type AIPromptTemplateConfigurationMemberTextFullAIPromptEditTemplateConfiguration struct {
	Value TextFullAIPromptEditTemplateConfiguration
	// contains filtered or unexported fields
}

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

type AIPromptTemplateType added in v1.12.0 

type AIPromptTemplateType string
const (
	AIPromptTemplateTypeText AIPromptTemplateType = "TEXT"
)

Enum values for AIPromptTemplateType

func (AIPromptTemplateType) Values added in v1.12.0 

func (AIPromptTemplateType) Values() []AIPromptTemplateType

Values returns all known values for AIPromptTemplateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AIPromptType added in v1.12.0 

type AIPromptType string
const (
	AIPromptTypeAnswerGeneration            AIPromptType = "ANSWER_GENERATION"
	AIPromptTypeIntentLabelingGeneration    AIPromptType = "INTENT_LABELING_GENERATION"
	AIPromptTypeQueryReformulation          AIPromptType = "QUERY_REFORMULATION"
	AIPromptTypeSelfServicePreProcessing    AIPromptType = "SELF_SERVICE_PRE_PROCESSING"
	AIPromptTypeSelfServiceAnswerGeneration AIPromptType = "SELF_SERVICE_ANSWER_GENERATION"
)

Enum values for AIPromptType

func (AIPromptType) Values added in v1.12.0 

func (AIPromptType) Values() []AIPromptType

Values returns all known values for AIPromptType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AIPromptVersionSummary added in v1.12.0 

type AIPromptVersionSummary struct {

	// The date for the summary of the AI Prompt version.
	AiPromptSummary *AIPromptSummary

	// The version number for this AI Prompt version.
	VersionNumber *int64
	// contains filtered or unexported fields
}

The summary of the AI Prompt version.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AgentAttributes added in v1.13.0 

type AgentAttributes struct {

	// The agent’s first name as entered in their Amazon Connect user account.
	FirstName *string

	// The agent’s last name as entered in their Amazon Connect user account.
	LastName *string
	// contains filtered or unexported fields
}

Information about an agent.

type AmazonConnectGuideAssociationData added in v1.9.0 

type AmazonConnectGuideAssociationData struct {

	//  The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides
	// are a type of flow.
	FlowId *string
	// contains filtered or unexported fields
}

Content association data for a step-by-step guide.

type AnswerRecommendationAIAgentConfiguration added in v1.12.0 

type AnswerRecommendationAIAgentConfiguration struct {

	// The AI Guardrail identifier for the Answer Generation Guardrail used by the
	// ANSWER_RECOMMENDATION AI Agent.
	AnswerGenerationAIGuardrailId *string

	// The AI Prompt identifier for the Answer Generation prompt used by the
	// ANSWER_RECOMMENDATION AI Agent.
	AnswerGenerationAIPromptId *string

	// The association configurations for overriding behavior on this AI Agent.
	AssociationConfigurations []AssociationConfiguration

	// The AI Prompt identifier for the Intent Labeling prompt used by the
	// ANSWER_RECOMMENDATION AI Agent.
	IntentLabelingGenerationAIPromptId *string

	// The locale to which specifies the language and region settings that determine
	// the response language for [QueryAssistant].
	//
	// Changing this locale to anything other than en_US , en_GB , or en_AU will turn
	// off recommendations triggered by contact transcripts for agent assistance, as
	// this feature is not supported in multiple languages.
	//
	// [QueryAssistant]: https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html
	Locale *string

	// The AI Prompt identifier for the Query Reformulation prompt used by the
	// ANSWER_RECOMMENDATION AI Agent.
	QueryReformulationAIPromptId *string
	// contains filtered or unexported fields
}

The configuration for the ANSWER_RECOMMENDATION AI Agent type.

type AppIntegrationsConfiguration 

type AppIntegrationsConfiguration struct {

	// The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use
	// for ingesting content.
	//
	//   - For [Salesforce], your AppIntegrations DataIntegration must have an ObjectConfiguration
	//   if objectFields is not provided, including at least Id , ArticleNumber ,
	//   VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
	//
	//   - For [ServiceNow], your AppIntegrations DataIntegration must have an ObjectConfiguration
	//   if objectFields is not provided, including at least number , short_description
	//   , sys_mod_count , workflow_state , and active as source fields.
	//
	//   - For [Zendesk], your AppIntegrations DataIntegration must have an ObjectConfiguration
	//   if objectFields is not provided, including at least id , title , updated_at ,
	//   and draft as source fields.
	//
	//   - For [SharePoint], your AppIntegrations DataIntegration must have a FileConfiguration,
	//   including only file extensions that are among docx , pdf , html , htm , and
	//   txt .
	//
	//   - For [Amazon S3], the ObjectConfiguration and FileConfiguration of your AppIntegrations
	//   DataIntegration must be null. The SourceURI of your DataIntegration must use
	//   the following format: s3://your_s3_bucket_name .
	//
	// The bucket policy of the corresponding S3 bucket must allow the Amazon Web
	//   Services principal app-integrations.amazonaws.com to perform s3:ListBucket ,
	//   s3:GetObject , and s3:GetBucketLocation against the bucket.
	//
	// [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
	// [Amazon S3]: http://aws.amazon.com/s3/
	// [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
	// [SharePoint]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index
	// [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
	//
	// This member is required.
	AppIntegrationArn *string

	// The fields from the source that are made available to your agents in Amazon Q
	// in Connect. Optional if ObjectConfiguration is included in the provided
	// DataIntegration.
	//
	//   - For [Salesforce], you must include at least Id , ArticleNumber , VersionNumber , Title ,
	//   PublishStatus , and IsDeleted .
	//
	//   - For [ServiceNow], you must include at least number , short_description , sys_mod_count ,
	//   workflow_state , and active .
	//
	//   - For [Zendesk], you must include at least id , title , updated_at , and draft .
	//
	// Make sure to include additional fields. These fields are indexed and used to
	// source recommendations.
	//
	// [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
	// [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
	// [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
	ObjectFields []string
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

type AssistantAssociationData 

type AssistantAssociationData struct {

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// This member is required.
	AssistantAssociationArn *string

	// The identifier of the assistant association.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// A union type that currently has a single argument, the knowledge base ID.
	//
	// This member is required.
	AssociationData AssistantAssociationOutputData

	// The type of association.
	//
	// This member is required.
	AssociationType AssociationType

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the assistant association.

type AssistantAssociationInputData 

type AssistantAssociationInputData interface {
	// contains filtered or unexported methods
}

The data that is input into Amazon Q in Connect as a result of the assistant association.

The following types satisfy this interface: 

AssistantAssociationInputDataMemberKnowledgeBaseId
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.AssistantAssociationInputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssistantAssociationInputDataMemberKnowledgeBaseId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssistantAssociationInputDataMemberKnowledgeBaseId 

type AssistantAssociationInputDataMemberKnowledgeBaseId struct {
	Value string
	// contains filtered or unexported fields
}

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

type AssistantAssociationOutputData 

type AssistantAssociationOutputData interface {
	// contains filtered or unexported methods
}

The data that is output as a result of the assistant association.

The following types satisfy this interface: 

AssistantAssociationOutputDataMemberKnowledgeBaseAssociation
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.AssistantAssociationOutputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssistantAssociationOutputDataMemberKnowledgeBaseAssociation:
		_ = v.Value // Value is types.KnowledgeBaseAssociationData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssistantAssociationOutputDataMemberKnowledgeBaseAssociation 

type AssistantAssociationOutputDataMemberKnowledgeBaseAssociation struct {
	Value KnowledgeBaseAssociationData
	// contains filtered or unexported fields
}

The knowledge base where output data is sent.

type AssistantAssociationSummary 

type AssistantAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// This member is required.
	AssistantAssociationArn *string

	// The identifier of the assistant association.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The association data.
	//
	// This member is required.
	AssociationData AssistantAssociationOutputData

	// The type of association.
	//
	// This member is required.
	AssociationType AssociationType

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the assistant association.

type AssistantCapabilityConfiguration 

type AssistantCapabilityConfiguration struct {

	// The type of Amazon Q in Connect assistant capability.
	Type AssistantCapabilityType
	// contains filtered or unexported fields
}

The capability configuration for an Amazon Q in Connect assistant.

type AssistantCapabilityType 

type AssistantCapabilityType string
const (
	AssistantCapabilityTypeV1 AssistantCapabilityType = "V1"
	AssistantCapabilityTypeV2 AssistantCapabilityType = "V2"
)

Enum values for AssistantCapabilityType

func (AssistantCapabilityType) Values 

func (AssistantCapabilityType) Values() []AssistantCapabilityType

Values returns all known values for AssistantCapabilityType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssistantData 

type AssistantData struct {

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The name.
	//
	// This member is required.
	Name *string

	// The status of the assistant.
	//
	// This member is required.
	Status AssistantStatus

	// The type of assistant.
	//
	// This member is required.
	Type AssistantType

	// The configuration of the AI Agents (mapped by AI Agent Type to AI Agent
	// version) that is set on the Amazon Q in Connect Assistant.
	AiAgentConfiguration map[string]AIAgentConfigurationData

	// The configuration information for the Amazon Q in Connect assistant capability.
	CapabilityConfiguration *AssistantCapabilityConfiguration

	// The description.
	Description *string

	// The configuration information for the Amazon Q in Connect assistant integration.
	IntegrationConfiguration *AssistantIntegrationConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using
	// the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the
	// key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and
	// kms:DescribeKey permissions to the connect.amazonaws.com service principal.
	//
	// For more information about setting up a customer managed key for Amazon Q in
	// Connect, see [Enable Amazon Q in Connect for your instance].
	//
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The assistant data.

type AssistantIntegrationConfiguration 

type AssistantIntegrationConfiguration struct {

	// The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for
	// streaming chat messages.
	TopicIntegrationArn *string
	// contains filtered or unexported fields
}

The configuration information for the Amazon Q in Connect assistant integration.

type AssistantStatus 

type AssistantStatus string
const (
	AssistantStatusCreateInProgress AssistantStatus = "CREATE_IN_PROGRESS"
	AssistantStatusCreateFailed     AssistantStatus = "CREATE_FAILED"
	AssistantStatusActive           AssistantStatus = "ACTIVE"
	AssistantStatusDeleteInProgress AssistantStatus = "DELETE_IN_PROGRESS"
	AssistantStatusDeleteFailed     AssistantStatus = "DELETE_FAILED"
	AssistantStatusDeleted          AssistantStatus = "DELETED"
)

Enum values for AssistantStatus

func (AssistantStatus) Values 

func (AssistantStatus) Values() []AssistantStatus

Values returns all known values for AssistantStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssistantSummary 

type AssistantSummary struct {

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The name of the assistant.
	//
	// This member is required.
	Name *string

	// The status of the assistant.
	//
	// This member is required.
	Status AssistantStatus

	// The type of the assistant.
	//
	// This member is required.
	Type AssistantType

	// The configuration of the AI Agents (mapped by AI Agent Type to AI Agent
	// version) that is set on the Amazon Q in Connect Assistant.
	AiAgentConfiguration map[string]AIAgentConfigurationData

	// The configuration information for the Amazon Q in Connect assistant capability.
	CapabilityConfiguration *AssistantCapabilityConfiguration

	// The description of the assistant.
	Description *string

	// The configuration information for the Amazon Q in Connect assistant integration.
	IntegrationConfiguration *AssistantIntegrationConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using
	// the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the
	// key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and
	// kms:DescribeKey permissions to the connect.amazonaws.com service principal.
	//
	// For more information about setting up a customer managed key for Amazon Q in
	// Connect, see [Enable Amazon Q in Connect for your instance].
	//
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the assistant.

type AssistantType 

type AssistantType string
const (
	AssistantTypeAgent AssistantType = "AGENT"
)

Enum values for AssistantType

func (AssistantType) Values 

func (AssistantType) Values() []AssistantType

Values returns all known values for AssistantType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationConfiguration added in v1.12.0 

type AssociationConfiguration struct {

	// The data of the configuration for an Amazon Q in Connect Assistant Association.
	AssociationConfigurationData AssociationConfigurationData

	// The identifier of the association for this Association Configuration.
	AssociationId *string

	// The type of the association for this Association Configuration.
	AssociationType AIAgentAssociationConfigurationType
	// contains filtered or unexported fields
}

The configuration for an Amazon Q in Connect Assistant Association.

type AssociationConfigurationData added in v1.12.0 

type AssociationConfigurationData interface {
	// contains filtered or unexported methods
}

A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.

The following types satisfy this interface: 

AssociationConfigurationDataMemberKnowledgeBaseAssociationConfigurationData
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.AssociationConfigurationData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssociationConfigurationDataMemberKnowledgeBaseAssociationConfigurationData:
		_ = v.Value // Value is types.KnowledgeBaseAssociationConfigurationData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssociationConfigurationDataMemberKnowledgeBaseAssociationConfigurationData added in v1.12.0 

type AssociationConfigurationDataMemberKnowledgeBaseAssociationConfigurationData struct {
	Value KnowledgeBaseAssociationConfigurationData
	// contains filtered or unexported fields
}

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

type AssociationType 

type AssociationType string
const (
	AssociationTypeKnowledgeBase AssociationType = "KNOWLEDGE_BASE"
)

Enum values for AssociationType

func (AssociationType) Values 

func (AssociationType) Values() []AssociationType

Values returns all known values for AssociationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BedrockFoundationModelConfigurationForParsing added in v1.12.0 

type BedrockFoundationModelConfigurationForParsing struct {

	// The ARN of the foundation model.
	//
	// This member is required.
	ModelArn *string

	// Instructions for interpreting the contents of a document.
	ParsingPrompt *ParsingPrompt
	// contains filtered or unexported fields
}

Settings for a foundation model used to parse documents for a data source.

type ChannelSubtype added in v1.13.0 

type ChannelSubtype string
const (
	ChannelSubtypeEmail ChannelSubtype = "EMAIL"
	ChannelSubtypeSms   ChannelSubtype = "SMS"
)

Enum values for ChannelSubtype

func (ChannelSubtype) Values added in v1.13.0 

func (ChannelSubtype) Values() []ChannelSubtype

Values returns all known values for ChannelSubtype. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChunkingConfiguration added in v1.12.0 

type ChunkingConfiguration struct {

	// Knowledge base can split your source data into chunks. A chunk refers to an
	// excerpt from a data source that is returned when the knowledge base that it
	// belongs to is queried. You have the following options for chunking your data. If
	// you opt for NONE , then you may want to pre-process your files by splitting them
	// up such that each file corresponds to a chunk.
	//
	// This member is required.
	ChunkingStrategy ChunkingStrategy

	// Configurations for when you choose fixed-size chunking. If you set the
	// chunkingStrategy as NONE , exclude this field.
	FixedSizeChunkingConfiguration *FixedSizeChunkingConfiguration

	// Settings for hierarchical document chunking for a data source. Hierarchical
	// chunking splits documents into layers of chunks where the first layer contains
	// large chunks, and the second layer contains smaller chunks derived from the
	// first layer.
	HierarchicalChunkingConfiguration *HierarchicalChunkingConfiguration

	// Settings for semantic document chunking for a data source. Semantic chunking
	// splits a document into smaller documents based on groups of similar content
	// derived from the text with natural language processing.
	SemanticChunkingConfiguration *SemanticChunkingConfiguration
	// contains filtered or unexported fields
}

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

type ChunkingStrategy added in v1.12.0 

type ChunkingStrategy string
const (
	ChunkingStrategyFixedSize    ChunkingStrategy = "FIXED_SIZE"
	ChunkingStrategyNone         ChunkingStrategy = "NONE"
	ChunkingStrategyHierarchical ChunkingStrategy = "HIERARCHICAL"
	ChunkingStrategySemantic     ChunkingStrategy = "SEMANTIC"
)

Enum values for ChunkingStrategy

func (ChunkingStrategy) Values added in v1.12.0 

func (ChunkingStrategy) Values() []ChunkingStrategy

Values returns all known values for ChunkingStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CitationSpan added in v1.12.0 

type CitationSpan struct {

	// Where the text with a citation starts in the generated output.
	BeginOffsetInclusive int32

	// Where the text with a citation ends in the generated output.
	EndOffsetExclusive int32
	// contains filtered or unexported fields
}

Contains information about where the text with a citation begins and ends in the generated output.

type Configuration 

type Configuration interface {
	// contains filtered or unexported methods
}

The configuration information of the external data source.

The following types satisfy this interface: 

ConfigurationMemberConnectConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.Configuration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfigurationMemberConnectConfiguration:
		_ = v.Value // Value is types.ConnectConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ConfigurationMemberConnectConfiguration 

type ConfigurationMemberConnectConfiguration struct {
	Value ConnectConfiguration
	// contains filtered or unexported fields
}

The configuration information of the Amazon Connect data source.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant ) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConnectConfiguration 

type ConnectConfiguration struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	InstanceId *string
	// contains filtered or unexported fields
}

The configuration information of the Amazon Connect data source.

type ContentAssociationContents added in v1.9.0 

type ContentAssociationContents interface {
	// contains filtered or unexported methods
}

The contents of a content association.

The following types satisfy this interface: 

ContentAssociationContentsMemberAmazonConnectGuideAssociation
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.ContentAssociationContents
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ContentAssociationContentsMemberAmazonConnectGuideAssociation:
		_ = v.Value // Value is types.AmazonConnectGuideAssociationData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ContentAssociationContentsMemberAmazonConnectGuideAssociation added in v1.9.0 

type ContentAssociationContentsMemberAmazonConnectGuideAssociation struct {
	Value AmazonConnectGuideAssociationData
	// contains filtered or unexported fields
}

The data of the step-by-step guide association.

type ContentAssociationData added in v1.9.0 

type ContentAssociationData struct {

	// The content association.
	//
	// This member is required.
	AssociationData ContentAssociationContents

	// The type of association.
	//
	// This member is required.
	AssociationType ContentAssociationType

	// The Amazon Resource Name (ARN) of the content.
	//
	// This member is required.
	ContentArn *string

	// The Amazon Resource Name (ARN) of the content association.
	//
	// This member is required.
	ContentAssociationArn *string

	// The identifier of the content association. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	ContentAssociationId *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the content association.

type ContentAssociationSummary added in v1.9.0 

type ContentAssociationSummary struct {

	// The content association.
	//
	// This member is required.
	AssociationData ContentAssociationContents

	// The type of association.
	//
	// This member is required.
	AssociationType ContentAssociationType

	// The Amazon Resource Name (ARN) of the content.
	//
	// This member is required.
	ContentArn *string

	// The Amazon Resource Name (ARN) of the content association.
	//
	// This member is required.
	ContentAssociationArn *string

	// The identifier of the content association. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	ContentAssociationId *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a content association.

type ContentAssociationType added in v1.9.0 

type ContentAssociationType string
const (
	ContentAssociationTypeAmazonConnectGuide ContentAssociationType = "AMAZON_CONNECT_GUIDE"
)

Enum values for ContentAssociationType

func (ContentAssociationType) Values added in v1.9.0 

func (ContentAssociationType) Values() []ContentAssociationType

Values returns all known values for ContentAssociationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentData 

type ContentData struct {

	// The Amazon Resource Name (ARN) of the content.
	//
	// This member is required.
	ContentArn *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The media type of the content.
	//
	// This member is required.
	ContentType *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// A key/value map to store attributes without affecting tagging or
	// recommendations. For example, when synchronizing data between an external system
	// and Amazon Q in Connect, you can store an external version identifier as
	// metadata to utilize for determining drift.
	//
	// This member is required.
	Metadata map[string]string

	// The name of the content.
	//
	// This member is required.
	Name *string

	// The identifier of the content revision.
	//
	// This member is required.
	RevisionId *string

	// The status of the content.
	//
	// This member is required.
	Status ContentStatus

	// The title of the content.
	//
	// This member is required.
	Title *string

	// The URL of the content.
	//
	// This member is required.
	Url *string

	// The expiration time of the URL as an epoch timestamp.
	//
	// This member is required.
	UrlExpiry *time.Time

	// The URI of the content.
	LinkOutUri *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the content.

type ContentDataDetails 

type ContentDataDetails struct {

	// Details about the content ranking data.
	//
	// This member is required.
	RankingData *RankingData

	// Details about the content text data.
	//
	// This member is required.
	TextData *TextData
	// contains filtered or unexported fields
}

Details about the content data.

type ContentDisposition added in v1.13.0 

type ContentDisposition string
const (
	ContentDispositionAttachment ContentDisposition = "ATTACHMENT"
)

Enum values for ContentDisposition

func (ContentDisposition) Values added in v1.13.0 

func (ContentDisposition) Values() []ContentDisposition

Values returns all known values for ContentDisposition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentFeedbackData added in v1.2.0 

type ContentFeedbackData interface {
	// contains filtered or unexported methods
}

Information about the feedback.

The following types satisfy this interface: 

ContentFeedbackDataMemberGenerativeContentFeedbackData
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.ContentFeedbackData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ContentFeedbackDataMemberGenerativeContentFeedbackData:
		_ = v.Value // Value is types.GenerativeContentFeedbackData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ContentFeedbackDataMemberGenerativeContentFeedbackData added in v1.2.0 

type ContentFeedbackDataMemberGenerativeContentFeedbackData struct {
	Value GenerativeContentFeedbackData
	// contains filtered or unexported fields
}

Information about the feedback for a generative target type.

type ContentReference 

type ContentReference struct {

	// The Amazon Resource Name (ARN) of the content.
	ContentArn *string

	// The identifier of the content.
	ContentId *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base.
	KnowledgeBaseId *string

	// The type of reference content.
	ReferenceType ReferenceType

	// The web URL of the source content.
	SourceURL *string
	// contains filtered or unexported fields
}

Reference information about the content.

type ContentStatus 

type ContentStatus string
const (
	ContentStatusCreateInProgress ContentStatus = "CREATE_IN_PROGRESS"
	ContentStatusCreateFailed     ContentStatus = "CREATE_FAILED"
	ContentStatusActive           ContentStatus = "ACTIVE"
	ContentStatusDeleteInProgress ContentStatus = "DELETE_IN_PROGRESS"
	ContentStatusDeleteFailed     ContentStatus = "DELETE_FAILED"
	ContentStatusDeleted          ContentStatus = "DELETED"
	ContentStatusUpdateFailed     ContentStatus = "UPDATE_FAILED"
)

Enum values for ContentStatus

func (ContentStatus) Values 

func (ContentStatus) Values() []ContentStatus

Values returns all known values for ContentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentSummary 

type ContentSummary struct {

	// The Amazon Resource Name (ARN) of the content.
	//
	// This member is required.
	ContentArn *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The media type of the content.
	//
	// This member is required.
	ContentType *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// A key/value map to store attributes without affecting tagging or
	// recommendations. For example, when synchronizing data between an external system
	// and Amazon Q in Connect, you can store an external version identifier as
	// metadata to utilize for determining drift.
	//
	// This member is required.
	Metadata map[string]string

	// The name of the content.
	//
	// This member is required.
	Name *string

	// The identifier of the revision of the content.
	//
	// This member is required.
	RevisionId *string

	// The status of the content.
	//
	// This member is required.
	Status ContentStatus

	// The title of the content.
	//
	// This member is required.
	Title *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the content.

type ConversationContext added in v1.14.0 

type ConversationContext struct {

	// The self service conversation history before the Amazon Q in Connect session.
	//
	// This member is required.
	SelfServiceConversationHistory []SelfServiceConversationHistory
	// contains filtered or unexported fields
}

The conversation context to include in SendMessage.

type ConversationState added in v1.14.0 

type ConversationState struct {

	// The status of the conversation state.
	//
	// This member is required.
	Status ConversationStatus

	// The reason of the conversation state.
	Reason ConversationStatusReason
	// contains filtered or unexported fields
}

The conversation state associated to a message.

type ConversationStatus added in v1.14.0 

type ConversationStatus string
const (
	ConversationStatusClosed     ConversationStatus = "CLOSED"
	ConversationStatusReady      ConversationStatus = "READY"
	ConversationStatusProcessing ConversationStatus = "PROCESSING"
)

Enum values for ConversationStatus

func (ConversationStatus) Values added in v1.14.0 

func (ConversationStatus) Values() []ConversationStatus

Values returns all known values for ConversationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConversationStatusReason added in v1.14.0 

type ConversationStatusReason string
const (
	ConversationStatusReasonSuccess  ConversationStatusReason = "SUCCESS"
	ConversationStatusReasonFailed   ConversationStatusReason = "FAILED"
	ConversationStatusReasonRejected ConversationStatusReason = "REJECTED"
)

Enum values for ConversationStatusReason

func (ConversationStatusReason) Values added in v1.14.0 

func (ConversationStatusReason) Values() []ConversationStatusReason

Values returns all known values for ConversationStatusReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomerProfileAttributes added in v1.13.0 

type CustomerProfileAttributes struct {

	// A unique account number that you have given to the customer.
	AccountNumber *string

	// Any additional information relevant to the customer's profile.
	AdditionalInformation *string

	// The first line of a customer address.
	Address1 *string

	// The second line of a customer address.
	Address2 *string

	// The third line of a customer address.
	Address3 *string

	// The fourth line of a customer address.
	Address4 *string

	// The first line of a customer’s billing address.
	BillingAddress1 *string

	// The second line of a customer’s billing address.
	BillingAddress2 *string

	// The third line of a customer’s billing address.
	BillingAddress3 *string

	// The fourth line of a customer’s billing address.
	BillingAddress4 *string

	// The city of a customer’s billing address.
	BillingCity *string

	// The country of a customer’s billing address.
	BillingCountry *string

	// The county of a customer’s billing address.
	BillingCounty *string

	// The postal code of a customer’s billing address.
	BillingPostalCode *string

	// The province of a customer’s billing address.
	BillingProvince *string

	// The state of a customer’s billing address.
	BillingState *string

	// The customer's birth date.
	BirthDate *string

	// The customer's business email address.
	BusinessEmailAddress *string

	// The name of the customer's business.
	BusinessName *string

	// The customer's business phone number.
	BusinessPhoneNumber *string

	// The city in which a customer lives.
	City *string

	// The country in which a customer lives.
	Country *string

	// The county in which a customer lives.
	County *string

	// The custom attributes in customer profile attributes.
	Custom map[string]string

	// The customer's email address, which has not been specified as a personal or
	// business address.
	EmailAddress *string

	// The customer's first name.
	FirstName *string

	// The customer's gender.
	Gender *string

	// The customer's mobile phone number.
	HomePhoneNumber *string

	// The customer's last name.
	LastName *string

	// The first line of a customer’s mailing address.
	MailingAddress1 *string

	// The second line of a customer’s mailing address.
	MailingAddress2 *string

	// The third line of a customer’s mailing address.
	MailingAddress3 *string

	// The fourth line of a customer’s mailing address.
	MailingAddress4 *string

	// The city of a customer’s mailing address.
	MailingCity *string

	// The country of a customer’s mailing address.
	MailingCountry *string

	// The county of a customer’s mailing address.
	MailingCounty *string

	// The postal code of a customer’s mailing address.
	MailingPostalCode *string

	// The province of a customer’s mailing address.
	MailingProvince *string

	// The state of a customer’s mailing address.
	MailingState *string

	// The customer's middle name.
	MiddleName *string

	// The customer's mobile phone number.
	MobilePhoneNumber *string

	// The customer's party type.
	PartyType *string

	// The customer's phone number, which has not been specified as a mobile, home, or
	// business number.
	PhoneNumber *string

	// The postal code of a customer address.
	PostalCode *string

	// The ARN of a customer profile.
	ProfileARN *string

	// The unique identifier of a customer profile.
	ProfileId *string

	// The province in which a customer lives.
	Province *string

	// The first line of a customer’s shipping address.
	ShippingAddress1 *string

	// The second line of a customer’s shipping address.
	ShippingAddress2 *string

	// The third line of a customer’s shipping address.
	ShippingAddress3 *string

	// The fourth line of a customer’s shipping address.
	ShippingAddress4 *string

	// The city of a customer’s shipping address.
	ShippingCity *string

	// The country of a customer’s shipping address.
	ShippingCountry *string

	// The county of a customer’s shipping address.
	ShippingCounty *string

	// The postal code of a customer’s shipping address.
	ShippingPostalCode *string

	// The province of a customer’s shipping address.
	ShippingProvince *string

	// The state of a customer’s shipping address.
	ShippingState *string

	// The state in which a customer lives.
	State *string
	// contains filtered or unexported fields
}

The customer profile attributes that are used with the message template.

type DataDetails 

type DataDetails interface {
	// contains filtered or unexported methods
}

Details about the data.

The following types satisfy this interface: 

DataDetailsMemberContentData
DataDetailsMemberGenerativeData
DataDetailsMemberIntentDetectedData
DataDetailsMemberSourceContentData
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.DataDetails
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DataDetailsMemberContentData:
		_ = v.Value // Value is types.ContentDataDetails

	case *types.DataDetailsMemberGenerativeData:
		_ = v.Value // Value is types.GenerativeDataDetails

	case *types.DataDetailsMemberIntentDetectedData:
		_ = v.Value // Value is types.IntentDetectedDataDetails

	case *types.DataDetailsMemberSourceContentData:
		_ = v.Value // Value is types.SourceContentDataDetails

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DataDetailsMemberContentData 

type DataDetailsMemberContentData struct {
	Value ContentDataDetails
	// contains filtered or unexported fields
}

Details about the content data.

type DataDetailsMemberGenerativeData 

type DataDetailsMemberGenerativeData struct {
	Value GenerativeDataDetails
	// contains filtered or unexported fields
}

Details about the generative data.

type DataDetailsMemberIntentDetectedData added in v1.12.0 

type DataDetailsMemberIntentDetectedData struct {
	Value IntentDetectedDataDetails
	// contains filtered or unexported fields
}

Details about the intent data.

type DataDetailsMemberSourceContentData 

type DataDetailsMemberSourceContentData struct {
	Value SourceContentDataDetails
	// contains filtered or unexported fields
}

Details about the content data.

type DataReference 

type DataReference interface {
	// contains filtered or unexported methods
}

Reference data.

The following types satisfy this interface: 

DataReferenceMemberContentReference
DataReferenceMemberGenerativeReference
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.DataReference
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DataReferenceMemberContentReference:
		_ = v.Value // Value is types.ContentReference

	case *types.DataReferenceMemberGenerativeReference:
		_ = v.Value // Value is types.GenerativeReference

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DataReferenceMemberContentReference 

type DataReferenceMemberContentReference struct {
	Value ContentReference
	// contains filtered or unexported fields
}

Reference information about the content.

type DataReferenceMemberGenerativeReference 

type DataReferenceMemberGenerativeReference struct {
	Value GenerativeReference
	// contains filtered or unexported fields
}

Reference information about the generative content.

type DataSummary 

type DataSummary struct {

	// Details about the data.
	//
	// This member is required.
	Details DataDetails

	// Reference information about the content.
	//
	// This member is required.
	Reference DataReference
	// contains filtered or unexported fields
}

Summary of the data.

type Document 

type Document struct {

	// A reference to the content resource.
	//
	// This member is required.
	ContentReference *ContentReference

	// The excerpt from the document.
	Excerpt *DocumentText

	// The title of the document.
	Title *DocumentText
	// contains filtered or unexported fields
}

The document.

type DocumentText 

type DocumentText struct {

	// Highlights in the document text.
	Highlights []Highlight

	// Text in the document.
	Text *string
	// contains filtered or unexported fields
}

The text of the document.

type EmailHeader added in v1.13.0 

type EmailHeader struct {

	// The name of the email header.
	Name *string

	// The value of the email header.
	Value *string
	// contains filtered or unexported fields
}

The email header to include in email messages.

type EmailMessageTemplateContent added in v1.13.0 

type EmailMessageTemplateContent struct {

	// The body to use in email messages.
	Body *EmailMessageTemplateContentBody

	// The email headers to include in email messages.
	Headers []EmailHeader

	// The subject line, or title, to use in email messages.
	Subject *string
	// contains filtered or unexported fields
}

The content of the message template that applies to the email channel subtype.

type EmailMessageTemplateContentBody added in v1.13.0 

type EmailMessageTemplateContentBody struct {

	// The message body, in HTML format, to use in email messages that are based on
	// the message template. We recommend using HTML format for email clients that
	// render HTML content. You can include links, formatted text, and more in an HTML
	// message.
	Html MessageTemplateBodyContentProvider

	// The message body, in plain text format, to use in email messages that are based
	// on the message template. We recommend using plain text format for email clients
	// that don't render HTML content and clients that are connected to high-latency
	// networks, such as mobile devices.
	PlainText MessageTemplateBodyContentProvider
	// contains filtered or unexported fields
}

The body to use in email messages.

type ExtendedMessageTemplateData added in v1.13.0 

type ExtendedMessageTemplateData struct {

	// The channel subtype this message template applies to.
	//
	// This member is required.
	ChannelSubtype ChannelSubtype

	// The content of the message template.
	//
	// This member is required.
	Content MessageTemplateContentProvider

	// The timestamp when the message template was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The Amazon Resource Name (ARN) of the user who last updated the message
	// template data.
	//
	// This member is required.
	LastModifiedBy *string

	// The timestamp when the message template data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The checksum value of the message template content that is referenced by the
	// $LATEST qualifier. It can be returned in MessageTemplateData or
	// ExtendedMessageTemplateData . It’s calculated by content, language,
	// defaultAttributes and Attachments of the message template.
	//
	// This member is required.
	MessageTemplateContentSha256 *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// The message template attachments.
	Attachments []MessageTemplateAttachment

	// The types of attributes contain the message template.
	AttributeTypes []MessageTemplateAttributeType

	// An object that specifies the default values to use for variables in the message
	// template. This object contains different categories of key-value pairs. Each key
	// defines a variable or placeholder in the message template. The corresponding
	// value defines the default value for that variable.
	DefaultAttributes *MessageTemplateAttributes

	// The description of the message template.
	Description *string

	// The configuration information of the grouping of Amazon Q in Connect users.
	GroupingConfiguration *GroupingConfiguration

	// Whether the version of the message template is activated.
	IsActive *bool

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// The version number of the message template version.
	VersionNumber *int64
	// contains filtered or unexported fields
}

The extended data of a message template.

type ExternalSource 

type ExternalSource string
const (
	ExternalSourceAmazonConnect ExternalSource = "AMAZON_CONNECT"
)

Enum values for ExternalSource

func (ExternalSource) Values 

func (ExternalSource) Values() []ExternalSource

Values returns all known values for ExternalSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExternalSourceConfiguration 

type ExternalSourceConfiguration struct {

	// The configuration information of the external data source.
	//
	// This member is required.
	Configuration Configuration

	// The type of the external data source.
	//
	// This member is required.
	Source ExternalSource
	// contains filtered or unexported fields
}

The configuration information of the external data source.

type Filter 

type Filter struct {

	// The field on which to filter.
	//
	// This member is required.
	Field FilterField

	// The operator to use for comparing the field’s value with the provided value.
	//
	// This member is required.
	Operator FilterOperator

	// The desired field value on which to filter.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A search filter.

type FilterField 

type FilterField string
const (
	FilterFieldName FilterField = "NAME"
)

Enum values for FilterField

func (FilterField) Values 

func (FilterField) Values() []FilterField

Values returns all known values for FilterField. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FilterOperator 

type FilterOperator string
const (
	FilterOperatorEquals FilterOperator = "EQUALS"
)

Enum values for FilterOperator

func (FilterOperator) Values 

func (FilterOperator) Values() []FilterOperator

Values returns all known values for FilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FixedSizeChunkingConfiguration added in v1.12.0 

type FixedSizeChunkingConfiguration struct {

	// The maximum number of tokens to include in a chunk.
	//
	// This member is required.
	MaxTokens *int32

	// The percentage of overlap between adjacent chunks of a data source.
	//
	// This member is required.
	OverlapPercentage *int32
	// contains filtered or unexported fields
}

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.

type GenerativeContentFeedbackData added in v1.2.0 

type GenerativeContentFeedbackData struct {

	// The relevance of the feedback.
	//
	// This member is required.
	Relevance Relevance
	// contains filtered or unexported fields
}

The feedback information for a generative target type.

type GenerativeDataDetails 

type GenerativeDataDetails struct {

	// The LLM response.
	//
	// This member is required.
	Completion *string

	// Details about the generative content ranking data.
	//
	// This member is required.
	RankingData *RankingData

	// The references used to generative the LLM response.
	//
	// This member is required.
	References []DataSummary
	// contains filtered or unexported fields
}

Details about generative data.

type GenerativeReference 

type GenerativeReference struct {

	//  The identifier of the LLM model.
	GenerationId *string

	// The identifier of the LLM model.
	ModelId *string
	// contains filtered or unexported fields
}

Reference information about generative content.

type GroupingConfiguration 

type GroupingConfiguration struct {

	// The criteria used for grouping Amazon Q in Connect users.
	//
	// The following is the list of supported criteria values.
	//
	//   - RoutingProfileArn : Grouping the users by their [Amazon Connect routing profile ARN]. User should have [SearchRoutingProfile]and [DescribeRoutingProfile]
	//   permissions when setting criteria to this value.
	//
	// [Amazon Connect routing profile ARN]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
	// [SearchRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html
	// [DescribeRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html
	Criteria *string

	// The list of values that define different groups of Amazon Q in Connect users.
	//
	//   - When setting criteria to RoutingProfileArn , you need to provide a list of
	//   ARNs of [Amazon Connect routing profiles]as values of this parameter.
	//
	// [Amazon Connect routing profiles]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
	Values []string
	// contains filtered or unexported fields
}

The configuration information of the grouping of Amazon Q in Connect users.

type GuardrailContentFilterConfig added in v1.14.0 

type GuardrailContentFilterConfig struct {

	// The strength of the content filter to apply to prompts. As you increase the
	// filter strength, the likelihood of filtering harmful content increases and the
	// probability of seeing harmful content in your application reduces.
	//
	// This member is required.
	InputStrength GuardrailFilterStrength

	// The strength of the content filter to apply to model responses. As you increase
	// the filter strength, the likelihood of filtering harmful content increases and
	// the probability of seeing harmful content in your application reduces.
	//
	// This member is required.
	OutputStrength GuardrailFilterStrength

	// The harmful category that the content filter is applied to.
	//
	// This member is required.
	Type GuardrailContentFilterType
	// contains filtered or unexported fields
}

Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

  • Hate: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).

  • Insults: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.

  • Sexual: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.

  • Violence: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing.

Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

type GuardrailContentFilterType added in v1.14.0 

type GuardrailContentFilterType string
const (
	GuardrailContentFilterTypeSexual       GuardrailContentFilterType = "SEXUAL"
	GuardrailContentFilterTypeViolence     GuardrailContentFilterType = "VIOLENCE"
	GuardrailContentFilterTypeHate         GuardrailContentFilterType = "HATE"
	GuardrailContentFilterTypeInsults      GuardrailContentFilterType = "INSULTS"
	GuardrailContentFilterTypeMisconduct   GuardrailContentFilterType = "MISCONDUCT"
	GuardrailContentFilterTypePromptAttack GuardrailContentFilterType = "PROMPT_ATTACK"
)

Enum values for GuardrailContentFilterType

func (GuardrailContentFilterType) Values added in v1.14.0 

func (GuardrailContentFilterType) Values() []GuardrailContentFilterType

Values returns all known values for GuardrailContentFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailContextualGroundingFilterConfig added in v1.14.0 

type GuardrailContextualGroundingFilterConfig struct {

	// The threshold details for the AI Guardrail's contextual grounding filter.
	//
	// This member is required.
	Threshold float64

	// The filter type for the AI Guardrail's contextual grounding filter.
	//
	// This member is required.
	Type GuardrailContextualGroundingFilterType
	// contains filtered or unexported fields
}

The filter configuration details for the AI Guardrail's contextual grounding filter.

type GuardrailContextualGroundingFilterType added in v1.14.0 

type GuardrailContextualGroundingFilterType string
const (
	GuardrailContextualGroundingFilterTypeGrounding GuardrailContextualGroundingFilterType = "GROUNDING"
	GuardrailContextualGroundingFilterTypeRelevance GuardrailContextualGroundingFilterType = "RELEVANCE"
)

Enum values for GuardrailContextualGroundingFilterType

func (GuardrailContextualGroundingFilterType) Values added in v1.14.0 

func (GuardrailContextualGroundingFilterType) Values() []GuardrailContextualGroundingFilterType

Values returns all known values for GuardrailContextualGroundingFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailFilterStrength added in v1.14.0 

type GuardrailFilterStrength string
const (
	GuardrailFilterStrengthNone   GuardrailFilterStrength = "NONE"
	GuardrailFilterStrengthLow    GuardrailFilterStrength = "LOW"
	GuardrailFilterStrengthMedium GuardrailFilterStrength = "MEDIUM"
	GuardrailFilterStrengthHigh   GuardrailFilterStrength = "HIGH"
)

Enum values for GuardrailFilterStrength

func (GuardrailFilterStrength) Values added in v1.14.0 

func (GuardrailFilterStrength) Values() []GuardrailFilterStrength

Values returns all known values for GuardrailFilterStrength. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailManagedWordsConfig added in v1.14.0 

type GuardrailManagedWordsConfig struct {

	// The managed word type to configure for the AI Guardrail.
	//
	// This member is required.
	Type GuardrailManagedWordsType
	// contains filtered or unexported fields
}

The managed word list to configure for the AI Guardrail.

type GuardrailManagedWordsType added in v1.14.0 

type GuardrailManagedWordsType string
const (
	GuardrailManagedWordsTypeProfanity GuardrailManagedWordsType = "PROFANITY"
)

Enum values for GuardrailManagedWordsType

func (GuardrailManagedWordsType) Values added in v1.14.0 

func (GuardrailManagedWordsType) Values() []GuardrailManagedWordsType

Values returns all known values for GuardrailManagedWordsType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailPiiEntityConfig added in v1.14.0 

type GuardrailPiiEntityConfig struct {

	// Configure AI Guardrail's action when the PII entity is detected.
	//
	// This member is required.
	Action GuardrailSensitiveInformationAction

	// Configure AI Guardrail type when the PII entity is detected.
	//
	// The following PIIs are used to block or mask sensitive information:
	//
	//   - General
	//
	//   - ADDRESS
	//
	// A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12,
	//   Building 123". An address can include information such as the street, building,
	//   location, city, state, country, county, zip code, precinct, and neighborhood.
	//
	//   - AGE
	//
	// An individual's age, including the quantity and unit of time. For example, in
	//   the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.
	//
	//   - NAME
	//
	// An individual's name. This entity type does not include titles, such as Dr.,
	//   Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that
	//   are part of organizations or addresses. For example, AI Guardrail recognizes the
	//   "John Doe Organization" as an organization, and it recognizes "Jane Doe Street"
	//   as an address.
	//
	//   - EMAIL
	//
	// An email address, such as marymajor@email.com.
	//
	//   - PHONE
	//
	// A phone number. This entity type also includes fax and pager numbers.
	//
	//   - USERNAME
	//
	// A user name that identifies an account, such as a login name, screen name, nick
	//   name, or handle.
	//
	//   - PASSWORD
	//
	// An alphanumeric string that is used as a password, such as "*
	//   very20special#pass*".
	//
	//   - DRIVER_ID
	//
	// The number assigned to a driver's license, which is an official document
	//   permitting an individual to operate one or more motorized vehicles on a public
	//   road. A driver's license number consists of alphanumeric characters.
	//
	//   - LICENSE_PLATE
	//
	// A license plate for a vehicle is issued by the state or country where the
	//   vehicle is registered. The format for passenger vehicles is typically five to
	//   eight digits, consisting of upper-case letters and numbers. The format varies
	//   depending on the location of the issuing state or country.
	//
	//   - VEHICLE_IDENTIFICATION_NUMBER
	//
	// A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN
	//   content and format are defined in the ISO 3779 specification. Each country has
	//   specific codes and formats for VINs.
	//
	//   - Finance
	//
	//   - CREDIT_DEBIT_CARD_CVV
	//
	// A three-digit card verification code (CVV) that is present on VISA, MasterCard,
	//   and Discover credit and debit cards. For American Express credit or debit cards,
	//   the CVV is a four-digit numeric code.
	//
	//   - CREDIT_DEBIT_CARD_EXPIRY
	//
	// The expiration date for a credit or debit card. This number is usually four
	//   digits long and is often formatted as month/year or MM/YY. AI Guardrail
	//   recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.
	//
	//   - CREDIT_DEBIT_CARD_NUMBER
	//
	// The number for a credit or debit card. These numbers can vary from 13 to 16
	//   digits in length. However, Amazon Comprehend also recognizes credit or debit
	//   card numbers when only the last four digits are present.
	//
	//   - PIN
	//
	// A four-digit personal identification number (PIN) with which you can access
	//   your bank account.
	//
	//   - INTERNATIONAL_BANK_ACCOUNT_NUMBER
	//
	// An International Bank Account Number has specific formats in each country. For
	//   more information, see [www.iban.com/structure].
	//
	//   - SWIFT_CODE
	//
	// A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify
	//   a particular bank or branch. Banks use these codes for money transfers such as
	//   international wire transfers.
	//
	// SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to
	//   specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX')
	//   refer to the head or primary office.
	//
	//   - IT
	//
	//   - IP_ADDRESS
	//
	// An IPv4 address, such as 198.51.100.0.
	//
	//   - MAC_ADDRESS
	//
	// A media access control (MAC) address is a unique identifier assigned to a
	//   network interface controller (NIC).
	//
	//   - URL
	//
	// A web address, such as www.example.com.
	//
	//   - AWS_ACCESS_KEY
	//
	// A unique identifier that's associated with a secret access key; you use the
	//   access key ID and secret access key to sign programmatic Amazon Web Services
	//   requests cryptographically.
	//
	//   - AWS_SECRET_KEY
	//
	// A unique identifier that's associated with an access key. You use the access
	//   key ID and secret access key to sign programmatic Amazon Web Services requests
	//   cryptographically.
	//
	//   - USA specific
	//
	//   - US_BANK_ACCOUNT_NUMBER
	//
	// A US bank account number, which is typically 10 to 12 digits long.
	//
	//   - US_BANK_ROUTING_NUMBER
	//
	// A US bank account routing number. These are typically nine digits long,
	//
	//   - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
	//
	// A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number
	//   that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can
	//   be formatted with a space or a dash after the third and forth digits.
	//
	//   - US_PASSPORT_NUMBER
	//
	// A US passport number. Passport numbers range from six to nine alphanumeric
	//   characters.
	//
	//   - US_SOCIAL_SECURITY_NUMBER
	//
	// A US Social Security Number (SSN) is a nine-digit number that is issued to US
	//   citizens, permanent residents, and temporary working residents.
	//
	//   - Canada specific
	//
	//   - CA_HEALTH_NUMBER
	//
	// A Canadian Health Service Number is a 10-digit unique identifier, required for
	//   individuals to access healthcare benefits.
	//
	//   - CA_SOCIAL_INSURANCE_NUMBER
	//
	// A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier,
	//   required for individuals to access government programs and benefits.
	//
	// The SIN is formatted as three groups of three digits, such as 123-456-789. A
	//   SIN can be validated through a simple check-digit process called the [Luhn algorithm].
	//
	//   - UK Specific
	//
	//   - UK_NATIONAL_HEALTH_SERVICE_NUMBER
	//
	// A UK National Health Service Number is a 10-17 digit number, such as 485 555
	//   3456. The current system formats the 10-digit number with spaces after the third
	//   and sixth digits. The final digit is an error-detecting checksum.
	//
	//   - UK_NATIONAL_INSURANCE_NUMBER
	//
	// A UK National Insurance Number (NINO) provides individuals with access to
	//   National Insurance (social security) benefits. It is also used for some purposes
	//   in the UK tax system.
	//
	// The number is nine digits long and starts with two letters, followed by six
	//   numbers and one letter. A NINO can be formatted with a space or a dash after the
	//   two letters and after the second, forth, and sixth digits.
	//
	//   - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
	//
	// A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a
	//   taxpayer or a business.
	//
	//   - Custom
	//
	//   - Regex filter - You can use a regular expressions to define patterns for an
	//   AI Guardrail to recognize and act upon such as serial number, booking ID etc..
	//
	// [Luhn algorithm]: https://www.wikipedia.org/wiki/Luhn_algorithm
	// [www.iban.com/structure]: https://www.iban.com/structure
	//
	// This member is required.
	Type GuardrailPiiEntityType
	// contains filtered or unexported fields
}

The PII entity to configure for the AI Guardrail.

type GuardrailPiiEntityType added in v1.14.0 

type GuardrailPiiEntityType string
const (
	GuardrailPiiEntityTypeAddress                             GuardrailPiiEntityType = "ADDRESS"
	GuardrailPiiEntityTypeAge                                 GuardrailPiiEntityType = "AGE"
	GuardrailPiiEntityTypeAwsAccessKey                        GuardrailPiiEntityType = "AWS_ACCESS_KEY"
	GuardrailPiiEntityTypeAwsSecretKey                        GuardrailPiiEntityType = "AWS_SECRET_KEY"
	GuardrailPiiEntityTypeCaHealthNumber                      GuardrailPiiEntityType = "CA_HEALTH_NUMBER"
	GuardrailPiiEntityTypeCaSocialInsuranceNumber             GuardrailPiiEntityType = "CA_SOCIAL_INSURANCE_NUMBER"
	GuardrailPiiEntityTypeCreditDebitCardCvv                  GuardrailPiiEntityType = "CREDIT_DEBIT_CARD_CVV"
	GuardrailPiiEntityTypeCreditDebitCardExpiry               GuardrailPiiEntityType = "CREDIT_DEBIT_CARD_EXPIRY"
	GuardrailPiiEntityTypeCreditDebitCardNumber               GuardrailPiiEntityType = "CREDIT_DEBIT_CARD_NUMBER"
	GuardrailPiiEntityTypeDriverId                            GuardrailPiiEntityType = "DRIVER_ID"
	GuardrailPiiEntityTypeEmail                               GuardrailPiiEntityType = "EMAIL"
	GuardrailPiiEntityTypeInternationalBankAccountNumber      GuardrailPiiEntityType = "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
	GuardrailPiiEntityTypeIpAddress                           GuardrailPiiEntityType = "IP_ADDRESS"
	GuardrailPiiEntityTypeLicensePlate                        GuardrailPiiEntityType = "LICENSE_PLATE"
	GuardrailPiiEntityTypeMacAddress                          GuardrailPiiEntityType = "MAC_ADDRESS"
	GuardrailPiiEntityTypeName                                GuardrailPiiEntityType = "NAME"
	GuardrailPiiEntityTypePassword                            GuardrailPiiEntityType = "PASSWORD"
	GuardrailPiiEntityTypePhone                               GuardrailPiiEntityType = "PHONE"
	GuardrailPiiEntityTypePin                                 GuardrailPiiEntityType = "PIN"
	GuardrailPiiEntityTypeSwiftCode                           GuardrailPiiEntityType = "SWIFT_CODE"
	GuardrailPiiEntityTypeUkNationalHealthServiceNumber       GuardrailPiiEntityType = "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
	GuardrailPiiEntityTypeUkNationalInsuranceNumber           GuardrailPiiEntityType = "UK_NATIONAL_INSURANCE_NUMBER"
	GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber     GuardrailPiiEntityType = "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
	GuardrailPiiEntityTypeUrl                                 GuardrailPiiEntityType = "URL"
	GuardrailPiiEntityTypeUsername                            GuardrailPiiEntityType = "USERNAME"
	GuardrailPiiEntityTypeUsBankAccountNumber                 GuardrailPiiEntityType = "US_BANK_ACCOUNT_NUMBER"
	GuardrailPiiEntityTypeUsBankRoutingNumber                 GuardrailPiiEntityType = "US_BANK_ROUTING_NUMBER"
	GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber GuardrailPiiEntityType = "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
	GuardrailPiiEntityTypeUsPassportNumber                    GuardrailPiiEntityType = "US_PASSPORT_NUMBER"
	GuardrailPiiEntityTypeUsSocialSecurityNumber              GuardrailPiiEntityType = "US_SOCIAL_SECURITY_NUMBER"
	GuardrailPiiEntityTypeVehicleIdentificationNumber         GuardrailPiiEntityType = "VEHICLE_IDENTIFICATION_NUMBER"
)

Enum values for GuardrailPiiEntityType

func (GuardrailPiiEntityType) Values added in v1.14.0 

func (GuardrailPiiEntityType) Values() []GuardrailPiiEntityType

Values returns all known values for GuardrailPiiEntityType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailRegexConfig added in v1.14.0 

type GuardrailRegexConfig struct {

	// The AI Guardrail action to configure when matching regular expression is
	// detected.
	//
	// This member is required.
	Action GuardrailSensitiveInformationAction

	// The name of the regular expression to configure for the AI Guardrail.
	//
	// This member is required.
	Name *string

	// The regular expression pattern to configure for the AI Guardrail.
	//
	// This member is required.
	Pattern *string

	// The description of the regular expression to configure for the AI Guardrail.
	Description *string
	// contains filtered or unexported fields
}

The regular expression to configure for the AI Guardrail.

type GuardrailSensitiveInformationAction added in v1.14.0 

type GuardrailSensitiveInformationAction string
const (
	GuardrailSensitiveInformationActionBlock     GuardrailSensitiveInformationAction = "BLOCK"
	GuardrailSensitiveInformationActionAnonymize GuardrailSensitiveInformationAction = "ANONYMIZE"
)

Enum values for GuardrailSensitiveInformationAction

func (GuardrailSensitiveInformationAction) Values added in v1.14.0 

func (GuardrailSensitiveInformationAction) Values() []GuardrailSensitiveInformationAction

Values returns all known values for GuardrailSensitiveInformationAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailTopicConfig added in v1.14.0 

type GuardrailTopicConfig struct {

	// A definition of the topic to deny.
	//
	// This member is required.
	Definition *string

	// The name of the topic to deny.
	//
	// This member is required.
	Name *string

	// Specifies to deny the topic.
	//
	// This member is required.
	Type GuardrailTopicType

	// A list of prompts, each of which is an example of a prompt that can be
	// categorized as belonging to the topic.
	Examples []string
	// contains filtered or unexported fields
}

Details about topics for the AI Guardrail to identify and deny.

type GuardrailTopicType added in v1.14.0 

type GuardrailTopicType string
const (
	GuardrailTopicTypeDeny GuardrailTopicType = "DENY"
)

Enum values for GuardrailTopicType

func (GuardrailTopicType) Values added in v1.14.0 

func (GuardrailTopicType) Values() []GuardrailTopicType

Values returns all known values for GuardrailTopicType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GuardrailWordConfig added in v1.14.0 

type GuardrailWordConfig struct {

	// Text of the word configured for the AI Guardrail to block.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

A word to configure for the AI Guardrail.

type HierarchicalChunkingConfiguration added in v1.12.0 

type HierarchicalChunkingConfiguration struct {

	// Token settings for each layer.
	//
	// This member is required.
	LevelConfigurations []HierarchicalChunkingLevelConfiguration

	// The number of tokens to repeat across chunks in the same layer.
	//
	// This member is required.
	OverlapTokens *int32
	// contains filtered or unexported fields
}

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

type HierarchicalChunkingLevelConfiguration added in v1.12.0 

type HierarchicalChunkingLevelConfiguration struct {

	// The maximum number of tokens that a chunk can contain in this layer.
	//
	// This member is required.
	MaxTokens *int32
	// contains filtered or unexported fields
}

Token settings for each layer.

type Highlight 

type Highlight struct {

	// The offset for the start of the highlight.
	BeginOffsetInclusive int32

	// The offset for the end of the highlight.
	EndOffsetExclusive int32
	// contains filtered or unexported fields
}

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

type ImportJobData 

type ImportJobData struct {

	// The timestamp when the import job was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The identifier of the import job.
	//
	// This member is required.
	ImportJobId *string

	// The type of the import job.
	//
	// This member is required.
	ImportJobType ImportJobType

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the import job data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The status of the import job.
	//
	// This member is required.
	Status ImportJobStatus

	// A pointer to the uploaded asset. This value is returned by [StartContentUpload].
	//
	// [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
	//
	// This member is required.
	UploadId *string

	// The download link to the resource file that is uploaded to the import job.
	//
	// This member is required.
	Url *string

	// The expiration time of the URL as an epoch timestamp.
	//
	// This member is required.
	UrlExpiry *time.Time

	// The configuration information of the external data source.
	ExternalSourceConfiguration *ExternalSourceConfiguration

	// The link to download the information of resource data that failed to be
	// imported.
	FailedRecordReport *string

	// The metadata fields of the imported Amazon Q in Connect resources.
	Metadata map[string]string
	// contains filtered or unexported fields
}

Summary information about the import job.

type ImportJobStatus 

type ImportJobStatus string
const (
	ImportJobStatusStartInProgress  ImportJobStatus = "START_IN_PROGRESS"
	ImportJobStatusFailed           ImportJobStatus = "FAILED"
	ImportJobStatusComplete         ImportJobStatus = "COMPLETE"
	ImportJobStatusDeleteInProgress ImportJobStatus = "DELETE_IN_PROGRESS"
	ImportJobStatusDeleteFailed     ImportJobStatus = "DELETE_FAILED"
	ImportJobStatusDeleted          ImportJobStatus = "DELETED"
)

Enum values for ImportJobStatus

func (ImportJobStatus) Values 

func (ImportJobStatus) Values() []ImportJobStatus

Values returns all known values for ImportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImportJobSummary 

type ImportJobSummary struct {

	// The timestamp when the import job was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The identifier of the import job.
	//
	// This member is required.
	ImportJobId *string

	// The type of import job.
	//
	// This member is required.
	ImportJobType ImportJobType

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the import job was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The status of the import job.
	//
	// This member is required.
	Status ImportJobStatus

	// A pointer to the uploaded asset. This value is returned by [StartContentUpload].
	//
	// [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
	//
	// This member is required.
	UploadId *string

	// The configuration information of the external source that the resource data are
	// imported from.
	ExternalSourceConfiguration *ExternalSourceConfiguration

	// The metadata fields of the imported Amazon Q in Connect resources.
	Metadata map[string]string
	// contains filtered or unexported fields
}

Summary information about the import job.

type ImportJobType 

type ImportJobType string
const (
	ImportJobTypeQuickResponses ImportJobType = "QUICK_RESPONSES"
)

Enum values for ImportJobType

func (ImportJobType) Values 

func (ImportJobType) Values() []ImportJobType

Values returns all known values for ImportJobType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IntentDetectedDataDetails added in v1.12.0 

type IntentDetectedDataDetails struct {

	// The detected intent.
	//
	// This member is required.
	Intent *string

	// The identifier of the detected intent.
	//
	// This member is required.
	IntentId *string
	// contains filtered or unexported fields
}

Details about the detected intent.

type IntentInputData added in v1.12.0 

type IntentInputData struct {

	// The identifier of the Amazon Q intent.
	//
	// This member is required.
	IntentId *string
	// contains filtered or unexported fields
}

Information about the Amazon Q intent.

type KnowledgeBaseAssociationConfigurationData added in v1.12.0 

type KnowledgeBaseAssociationConfigurationData struct {

	// An object that can be used to specify Tag conditions.
	ContentTagFilter TagFilter

	// The maximum number of results to return per page.
	MaxResults *int32

	// The search type to be used against the Knowledge Base for this request. The
	// values can be SEMANTIC which uses vector embeddings or HYBRID which use vector
	// embeddings and raw text
	OverrideKnowledgeBaseSearchType KnowledgeBaseSearchType
	// contains filtered or unexported fields
}

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

type KnowledgeBaseAssociationData 

type KnowledgeBaseAssociationData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

Association information about the knowledge base.

type KnowledgeBaseData 

type KnowledgeBaseData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The type of knowledge base.
	//
	// This member is required.
	KnowledgeBaseType KnowledgeBaseType

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// The status of the knowledge base.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The description.
	Description *string

	// List of failure reasons on ingestion per file.
	IngestionFailureReasons []string

	// Status of ingestion on data source.
	IngestionStatus SyncStatus

	// An epoch timestamp indicating the most recent content modification inside the
	// knowledge base. If no content exists in a knowledge base, this value is unset.
	LastContentModificationTime *time.Time

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using
	// the key to invoke Amazon Q in Connect.
	//
	// For more information about setting up a customer managed key for Amazon Q in
	// Connect, see [Enable Amazon Q in Connect for your instance].
	//
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Source configuration information about the knowledge base.
	SourceConfiguration SourceConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// Contains details about how to ingest the documents in a data source.
	VectorIngestionConfiguration *VectorIngestionConfiguration
	// contains filtered or unexported fields
}

Information about the knowledge base.

type KnowledgeBaseSearchType added in v1.12.0 

type KnowledgeBaseSearchType string
const (
	KnowledgeBaseSearchTypeHybrid   KnowledgeBaseSearchType = "HYBRID"
	KnowledgeBaseSearchTypeSemantic KnowledgeBaseSearchType = "SEMANTIC"
)

Enum values for KnowledgeBaseSearchType

func (KnowledgeBaseSearchType) Values added in v1.12.0 

func (KnowledgeBaseSearchType) Values() []KnowledgeBaseSearchType

Values returns all known values for KnowledgeBaseSearchType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseStatus 

type KnowledgeBaseStatus string
const (
	KnowledgeBaseStatusCreateInProgress KnowledgeBaseStatus = "CREATE_IN_PROGRESS"
	KnowledgeBaseStatusCreateFailed     KnowledgeBaseStatus = "CREATE_FAILED"
	KnowledgeBaseStatusActive           KnowledgeBaseStatus = "ACTIVE"
	KnowledgeBaseStatusDeleteInProgress KnowledgeBaseStatus = "DELETE_IN_PROGRESS"
	KnowledgeBaseStatusDeleteFailed     KnowledgeBaseStatus = "DELETE_FAILED"
	KnowledgeBaseStatusDeleted          KnowledgeBaseStatus = "DELETED"
)

Enum values for KnowledgeBaseStatus

func (KnowledgeBaseStatus) Values 

func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus

Values returns all known values for KnowledgeBaseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseSummary 

type KnowledgeBaseSummary struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The type of knowledge base.
	//
	// This member is required.
	KnowledgeBaseType KnowledgeBaseType

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// The status of the knowledge base summary.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The description of the knowledge base.
	Description *string

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using
	// the key to invoke Amazon Q in Connect.
	//
	// For more information about setting up a customer managed key for Amazon Q in
	// Connect, see [Enable Amazon Q in Connect for your instance].
	//
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Configuration information about the external data source.
	SourceConfiguration SourceConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// Contains details about how to ingest the documents in a data source.
	VectorIngestionConfiguration *VectorIngestionConfiguration
	// contains filtered or unexported fields
}

Summary information about the knowledge base.

type KnowledgeBaseType 

type KnowledgeBaseType string
const (
	KnowledgeBaseTypeExternal         KnowledgeBaseType = "EXTERNAL"
	KnowledgeBaseTypeCustom           KnowledgeBaseType = "CUSTOM"
	KnowledgeBaseTypeQuickResponses   KnowledgeBaseType = "QUICK_RESPONSES"
	KnowledgeBaseTypeMessageTemplates KnowledgeBaseType = "MESSAGE_TEMPLATES"
	KnowledgeBaseTypeManaged          KnowledgeBaseType = "MANAGED"
)

Enum values for KnowledgeBaseType

func (KnowledgeBaseType) Values 

func (KnowledgeBaseType) Values() []KnowledgeBaseType

Values returns all known values for KnowledgeBaseType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ManagedSourceConfiguration added in v1.12.0 

type ManagedSourceConfiguration interface {
	// contains filtered or unexported methods
}

Source configuration for managed resources.

The following types satisfy this interface: 

ManagedSourceConfigurationMemberWebCrawlerConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.ManagedSourceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ManagedSourceConfigurationMemberWebCrawlerConfiguration:
		_ = v.Value // Value is types.WebCrawlerConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ManagedSourceConfigurationMemberWebCrawlerConfiguration added in v1.12.0 

type ManagedSourceConfigurationMemberWebCrawlerConfiguration struct {
	Value WebCrawlerConfiguration
	// contains filtered or unexported fields
}

Configuration data for web crawler data source.

type ManualSearchAIAgentConfiguration added in v1.12.0 

type ManualSearchAIAgentConfiguration struct {

	// The AI Guardrail identifier for the Answer Generation guardrail used by the
	// MANUAL_SEARCH AI Agent.
	AnswerGenerationAIGuardrailId *string

	// The AI Prompt identifier for the Answer Generation prompt used by the
	// MANUAL_SEARCH AI Agent.
	AnswerGenerationAIPromptId *string

	// The association configurations for overriding behavior on this AI Agent.
	AssociationConfigurations []AssociationConfiguration

	// The locale to which specifies the language and region settings that determine
	// the response language for [QueryAssistant].
	//
	// [QueryAssistant]: https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html
	Locale *string
	// contains filtered or unexported fields
}

The configuration for the MANUAL_SEARCH AI Agent type.

type MessageData added in v1.14.0 

type MessageData interface {
	// contains filtered or unexported methods
}

The message data.

The following types satisfy this interface: 

MessageDataMemberText
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.MessageData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.MessageDataMemberText:
		_ = v.Value // Value is types.TextMessage

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type MessageDataMemberText added in v1.14.0 

type MessageDataMemberText struct {
	Value TextMessage
	// contains filtered or unexported fields
}

The message data in text type.

type MessageInput added in v1.14.0 

type MessageInput struct {

	// The message input value.
	//
	// This member is required.
	Value MessageData
	// contains filtered or unexported fields
}

The message input.

type MessageOutput added in v1.14.0 

type MessageOutput struct {

	// The identifier of a message.
	//
	// This member is required.
	MessageId *string

	// The participant of a message.
	//
	// This member is required.
	Participant Participant

	// The timestamp of a message.
	//
	// This member is required.
	Timestamp *time.Time

	// The value of a message data.
	//
	// This member is required.
	Value MessageData
	// contains filtered or unexported fields
}

The message output.

type MessageTemplateAttachment added in v1.13.0 

type MessageTemplateAttachment struct {

	// The identifier of the attachment file.
	//
	// This member is required.
	AttachmentId *string

	// The presentation information for the attachment file.
	//
	// This member is required.
	ContentDisposition ContentDisposition

	// The name of the attachment file being uploaded. The name should include the
	// file extension.
	//
	// This member is required.
	Name *string

	// The timestamp when the attachment file was uploaded.
	//
	// This member is required.
	UploadedTime *time.Time

	// A pre-signed Amazon S3 URL that can be used to download the attachment file.
	//
	// This member is required.
	Url *string

	// The expiration time of the pre-signed Amazon S3 URL.
	//
	// This member is required.
	UrlExpiry *time.Time
	// contains filtered or unexported fields
}

Information about the message template attachment.

type MessageTemplateAttributeType added in v1.13.0 

type MessageTemplateAttributeType string
const (
	MessageTemplateAttributeTypeSystem          MessageTemplateAttributeType = "SYSTEM"
	MessageTemplateAttributeTypeAgent           MessageTemplateAttributeType = "AGENT"
	MessageTemplateAttributeTypeCustomerProfile MessageTemplateAttributeType = "CUSTOMER_PROFILE"
	MessageTemplateAttributeTypeCustom          MessageTemplateAttributeType = "CUSTOM"
)

Enum values for MessageTemplateAttributeType

func (MessageTemplateAttributeType) Values added in v1.13.0 

func (MessageTemplateAttributeType) Values() []MessageTemplateAttributeType

Values returns all known values for MessageTemplateAttributeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MessageTemplateAttributes added in v1.13.0 

type MessageTemplateAttributes struct {

	// The agent attributes that are used with the message template.
	AgentAttributes *AgentAttributes

	// The custom attributes that are used with the message template.
	CustomAttributes map[string]string

	// The customer profile attributes that are used with the message template.
	CustomerProfileAttributes *CustomerProfileAttributes

	// The system attributes that are used with the message template.
	SystemAttributes *SystemAttributes
	// contains filtered or unexported fields
}

The attributes that are used with the message template.

type MessageTemplateBodyContentProvider added in v1.13.0 

type MessageTemplateBodyContentProvider interface {
	// contains filtered or unexported methods
}

The container of the message template body.

The following types satisfy this interface: 

MessageTemplateBodyContentProviderMemberContent
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.MessageTemplateBodyContentProvider
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.MessageTemplateBodyContentProviderMemberContent:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type MessageTemplateBodyContentProviderMemberContent added in v1.13.0 

type MessageTemplateBodyContentProviderMemberContent struct {
	Value string
	// contains filtered or unexported fields
}

The content of the message template.

type MessageTemplateContentProvider added in v1.13.0 

type MessageTemplateContentProvider interface {
	// contains filtered or unexported methods
}

The container of message template content.

The following types satisfy this interface: 

MessageTemplateContentProviderMemberEmail
MessageTemplateContentProviderMemberSms
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.MessageTemplateContentProvider
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.MessageTemplateContentProviderMemberEmail:
		_ = v.Value // Value is types.EmailMessageTemplateContent

	case *types.MessageTemplateContentProviderMemberSms:
		_ = v.Value // Value is types.SMSMessageTemplateContent

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type MessageTemplateContentProviderMemberEmail added in v1.13.0 

type MessageTemplateContentProviderMemberEmail struct {
	Value EmailMessageTemplateContent
	// contains filtered or unexported fields
}

The content of the message template that applies to the email channel subtype.

type MessageTemplateContentProviderMemberSms added in v1.13.0 

type MessageTemplateContentProviderMemberSms struct {
	Value SMSMessageTemplateContent
	// contains filtered or unexported fields
}

The content of the message template that applies to the SMS channel subtype.

type MessageTemplateData added in v1.13.0 

type MessageTemplateData struct {

	// The channel subtype this message template applies to.
	//
	// This member is required.
	ChannelSubtype ChannelSubtype

	// The content of the message template.
	//
	// This member is required.
	Content MessageTemplateContentProvider

	// The timestamp when the message template was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The Amazon Resource Name (ARN) of the user who last updated the message
	// template data.
	//
	// This member is required.
	LastModifiedBy *string

	// The timestamp when the message template data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The checksum value of the message template content that is referenced by the
	// $LATEST qualifier. It can be returned in MessageTemplateData or
	// ExtendedMessageTemplateData . It’s calculated by content, language,
	// defaultAttributes and Attachments of the message template.
	//
	// This member is required.
	MessageTemplateContentSha256 *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// The types of attributes that the message template contains.
	AttributeTypes []MessageTemplateAttributeType

	// An object that specifies the default values to use for variables in the message
	// template. This object contains different categories of key-value pairs. Each key
	// defines a variable or placeholder in the message template. The corresponding
	// value defines the default value for that variable.
	DefaultAttributes *MessageTemplateAttributes

	// The description of the message template.
	Description *string

	// The configuration information of the grouping of Amazon Q in Connect users.
	GroupingConfiguration *GroupingConfiguration

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The data of a message template.

type MessageTemplateFilterField added in v1.13.0 

type MessageTemplateFilterField struct {

	// The name of the attribute field to filter the message templates by.
	//
	// This member is required.
	Name *string

	// The operator to use for filtering.
	//
	// This member is required.
	Operator MessageTemplateFilterOperator

	// Whether to treat null value as a match for the attribute field.
	IncludeNoExistence *bool

	// The values of attribute field to filter the message template by.
	Values []string
	// contains filtered or unexported fields
}

The message template fields to filter the message template query results by. The following is the list of supported field names:

  • name

  • description

  • channel

  • channelSubtype

  • language

  • qualifier

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

type MessageTemplateFilterOperator added in v1.13.0 

type MessageTemplateFilterOperator string
const (
	MessageTemplateFilterOperatorEquals MessageTemplateFilterOperator = "EQUALS"
	MessageTemplateFilterOperatorPrefix MessageTemplateFilterOperator = "PREFIX"
)

Enum values for MessageTemplateFilterOperator

func (MessageTemplateFilterOperator) Values added in v1.13.0 

func (MessageTemplateFilterOperator) Values() []MessageTemplateFilterOperator

Values returns all known values for MessageTemplateFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MessageTemplateOrderField added in v1.13.0 

type MessageTemplateOrderField struct {

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// The order at which the message templates are sorted by.
	Order Order
	// contains filtered or unexported fields
}

The message template fields to order the message template query results by. The following is the list of supported field names:

  • name

  • description

  • channel

  • channelSubtype

  • language

  • qualifier

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

type MessageTemplateQueryField added in v1.13.0 

type MessageTemplateQueryField struct {

	// The name of the attribute to query the message templates by.
	//
	// This member is required.
	Name *string

	// The operator to use for matching attribute field values in the query.
	//
	// This member is required.
	Operator MessageTemplateQueryOperator

	// The values of the attribute to query the message templates by.
	//
	// This member is required.
	Values []string

	// Whether the query expects only exact matches on the attribute field values. The
	// results of the query will only include exact matches if this parameter is set to
	// false.
	AllowFuzziness *bool

	// The importance of the attribute field when calculating query result relevancy
	// scores. The value set for this parameter affects the ordering of search results.
	Priority Priority
	// contains filtered or unexported fields
}

The message template fields to query message templates by. The following is the list of supported field names:

  • name

  • description

type MessageTemplateQueryOperator added in v1.13.0 

type MessageTemplateQueryOperator string
const (
	MessageTemplateQueryOperatorContains          MessageTemplateQueryOperator = "CONTAINS"
	MessageTemplateQueryOperatorContainsAndPrefix MessageTemplateQueryOperator = "CONTAINS_AND_PREFIX"
)

Enum values for MessageTemplateQueryOperator

func (MessageTemplateQueryOperator) Values added in v1.13.0 

func (MessageTemplateQueryOperator) Values() []MessageTemplateQueryOperator

Values returns all known values for MessageTemplateQueryOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MessageTemplateSearchExpression added in v1.13.0 

type MessageTemplateSearchExpression struct {

	// The configuration of filtering rules applied to message template query results.
	Filters []MessageTemplateFilterField

	// The message template attribute fields on which the query results are ordered.
	OrderOnField *MessageTemplateOrderField

	// The message template query expressions.
	Queries []MessageTemplateQueryField
	// contains filtered or unexported fields
}

The search expression of the message template.

type MessageTemplateSearchResultData added in v1.13.0 

type MessageTemplateSearchResultData struct {

	// The channel subtype this message template applies to.
	//
	// This member is required.
	ChannelSubtype ChannelSubtype

	// The timestamp when the message template was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The Amazon Resource Name (ARN) of the user who last updated the message
	// template data.
	//
	// This member is required.
	LastModifiedBy *string

	// The timestamp when the message template data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// The description of the message template.
	Description *string

	// The configuration information of the grouping of Amazon Q in Connect users.
	GroupingConfiguration *GroupingConfiguration

	// Whether the version of the message template is activated.
	IsActive *bool

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// The version number of the message template version.
	VersionNumber *int64
	// contains filtered or unexported fields
}

The result of message template search.

type MessageTemplateSummary added in v1.13.0 

type MessageTemplateSummary struct {

	// The channel subtype this message template applies to.
	//
	// This member is required.
	ChannelSubtype ChannelSubtype

	// The timestamp when the message template was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The Amazon Resource Name (ARN) of the user who last updated the message
	// template data.
	//
	// This member is required.
	LastModifiedBy *string

	// The timestamp when the message template data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// The version number of the message template version that is activated.
	ActiveVersionNumber *int64

	// The description of the message template.
	Description *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The summary of the message template.

type MessageTemplateVersionSummary added in v1.13.0 

type MessageTemplateVersionSummary struct {

	// The channel subtype this message template applies to.
	//
	// This member is required.
	ChannelSubtype ChannelSubtype

	// Whether the version of the message template is activated.
	//
	// This member is required.
	IsActive *bool

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// The version number of the message template version.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

The summary of the message template version.

type MessageType added in v1.14.0 

type MessageType string
const (
	MessageTypeText MessageType = "TEXT"
)

Enum values for MessageType

func (MessageType) Values added in v1.14.0 

func (MessageType) Values() []MessageType

Values returns all known values for MessageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NotifyRecommendationsReceivedError 

type NotifyRecommendationsReceivedError struct {

	// A recommendation is causing an error.
	Message *string

	// The identifier of the recommendation that is in error.
	RecommendationId *string
	// contains filtered or unexported fields
}

An error occurred when creating a recommendation.

type OrCondition added in v1.6.0 

type OrCondition interface {
	// contains filtered or unexported methods
}

A list of conditions which would be applied together with an OR condition.

The following types satisfy this interface: 

OrConditionMemberAndConditions
OrConditionMemberTagCondition
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.OrCondition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.OrConditionMemberAndConditions:
		_ = v.Value // Value is []types.TagCondition

	case *types.OrConditionMemberTagCondition:
		_ = v.Value // Value is types.TagCondition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type OrConditionMemberAndConditions added in v1.6.0 

type OrConditionMemberAndConditions struct {
	Value []TagCondition
	// contains filtered or unexported fields
}

A list of conditions which would be applied together with an AND condition.

type OrConditionMemberTagCondition added in v1.6.0 

type OrConditionMemberTagCondition struct {
	Value TagCondition
	// contains filtered or unexported fields
}

A leaf node condition which can be used to specify a tag condition.

type Order 

type Order string
const (
	OrderAsc  Order = "ASC"
	OrderDesc Order = "DESC"
)

Enum values for Order

func (Order) Values 

func (Order) Values() []Order

Values returns all known values for Order. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Origin added in v1.12.0 

type Origin string
const (
	OriginSystem   Origin = "SYSTEM"
	OriginCustomer Origin = "CUSTOMER"
)

Enum values for Origin

func (Origin) Values added in v1.12.0 

func (Origin) Values() []Origin

Values returns all known values for Origin. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ParsingConfiguration added in v1.12.0 

type ParsingConfiguration struct {

	// The parsing strategy for the data source.
	//
	// This member is required.
	ParsingStrategy ParsingStrategy

	// Settings for a foundation model used to parse documents for a data source.
	BedrockFoundationModelConfiguration *BedrockFoundationModelConfigurationForParsing
	// contains filtered or unexported fields
}

Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.

type ParsingPrompt added in v1.12.0 

type ParsingPrompt struct {

	// Instructions for interpreting the contents of a document.
	//
	// This member is required.
	ParsingPromptText *string
	// contains filtered or unexported fields
}

Instructions for interpreting the contents of a document.

type ParsingStrategy added in v1.12.0 

type ParsingStrategy string
const (
	ParsingStrategyBedrockFoundationModel ParsingStrategy = "BEDROCK_FOUNDATION_MODEL"
)

Enum values for ParsingStrategy

func (ParsingStrategy) Values added in v1.12.0 

func (ParsingStrategy) Values() []ParsingStrategy

Values returns all known values for ParsingStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Participant added in v1.14.0 

type Participant string
const (
	ParticipantCustomer Participant = "CUSTOMER"
	ParticipantAgent    Participant = "AGENT"
	ParticipantBot      Participant = "BOT"
)

Enum values for Participant

func (Participant) Values added in v1.14.0 

func (Participant) Values() []Participant

Values returns all known values for Participant. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PreconditionFailedException 

type PreconditionFailedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The provided revisionId does not match, indicating the content has been modified since it was last read.

func (*PreconditionFailedException) Error 

func (e *PreconditionFailedException) Error() string

func (*PreconditionFailedException) ErrorCode 

func (e *PreconditionFailedException) ErrorCode() string

func (*PreconditionFailedException) ErrorFault 

func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault

func (*PreconditionFailedException) ErrorMessage 

func (e *PreconditionFailedException) ErrorMessage() string

type Priority 

type Priority string
const (
	PriorityHigh   Priority = "HIGH"
	PriorityMedium Priority = "MEDIUM"
	PriorityLow    Priority = "LOW"
)

Enum values for Priority

func (Priority) Values 

func (Priority) Values() []Priority

Values returns all known values for Priority. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryCondition 

type QueryCondition interface {
	// contains filtered or unexported methods
}

Information about how to query content.

The following types satisfy this interface: 

QueryConditionMemberSingle
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.QueryCondition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QueryConditionMemberSingle:
		_ = v.Value // Value is types.QueryConditionItem

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type QueryConditionComparisonOperator 

type QueryConditionComparisonOperator string
const (
	QueryConditionComparisonOperatorEquals QueryConditionComparisonOperator = "EQUALS"
)

Enum values for QueryConditionComparisonOperator

func (QueryConditionComparisonOperator) Values 

func (QueryConditionComparisonOperator) Values() []QueryConditionComparisonOperator

Values returns all known values for QueryConditionComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryConditionFieldName 

type QueryConditionFieldName string
const (
	QueryConditionFieldNameResultType QueryConditionFieldName = "RESULT_TYPE"
)

Enum values for QueryConditionFieldName

func (QueryConditionFieldName) Values 

func (QueryConditionFieldName) Values() []QueryConditionFieldName

Values returns all known values for QueryConditionFieldName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryConditionItem 

type QueryConditionItem struct {

	// The comparison operator for query condition to query on.
	//
	// This member is required.
	Comparator QueryConditionComparisonOperator

	//  The name of the field for query condition to query on.
	//
	// This member is required.
	Field QueryConditionFieldName

	// The value for the query condition to query on.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The condition for the query.

type QueryConditionMemberSingle 

type QueryConditionMemberSingle struct {
	Value QueryConditionItem
	// contains filtered or unexported fields
}

The condition for the query.

type QueryInputData added in v1.12.0 

type QueryInputData interface {
	// contains filtered or unexported methods
}

Input information for the query.

The following types satisfy this interface: 

QueryInputDataMemberIntentInputData
QueryInputDataMemberQueryTextInputData
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.QueryInputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QueryInputDataMemberIntentInputData:
		_ = v.Value // Value is types.IntentInputData

	case *types.QueryInputDataMemberQueryTextInputData:
		_ = v.Value // Value is types.QueryTextInputData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type QueryInputDataMemberIntentInputData added in v1.12.0 

type QueryInputDataMemberIntentInputData struct {
	Value IntentInputData
	// contains filtered or unexported fields
}

Input information for the intent.

type QueryInputDataMemberQueryTextInputData added in v1.12.0 

type QueryInputDataMemberQueryTextInputData struct {
	Value QueryTextInputData
	// contains filtered or unexported fields
}

Input information for the query.

type QueryRecommendationTriggerData 

type QueryRecommendationTriggerData struct {

	// The text associated with the recommendation trigger.
	Text *string
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

type QueryResultType 

type QueryResultType string
const (
	QueryResultTypeKnowledgeContent QueryResultType = "KNOWLEDGE_CONTENT"
	QueryResultTypeIntentAnswer     QueryResultType = "INTENT_ANSWER"
	QueryResultTypeGenerativeAnswer QueryResultType = "GENERATIVE_ANSWER"
)

Enum values for QueryResultType

func (QueryResultType) Values 

func (QueryResultType) Values() []QueryResultType

Values returns all known values for QueryResultType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryTextInputData added in v1.12.0 

type QueryTextInputData struct {

	// The text to search for.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

Information about the text to search for.

type QuickResponseContentProvider 

type QuickResponseContentProvider interface {
	// contains filtered or unexported methods
}

The container quick response content.

The following types satisfy this interface: 

QuickResponseContentProviderMemberContent
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.QuickResponseContentProvider
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QuickResponseContentProviderMemberContent:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type QuickResponseContentProviderMemberContent 

type QuickResponseContentProviderMemberContent struct {
	Value string
	// contains filtered or unexported fields
}

The content of the quick response.

type QuickResponseContents 

type QuickResponseContents struct {

	// The container quick response content.
	Markdown QuickResponseContentProvider

	// The container quick response content.
	PlainText QuickResponseContentProvider
	// contains filtered or unexported fields
}

The content of the quick response stored in different media types.

type QuickResponseData 

type QuickResponseData struct {

	// The media type of the quick response content.
	//
	//   - Use application/x.quickresponse;format=plain for quick response written in
	//   plain text.
	//
	//   - Use application/x.quickresponse;format=markdown for quick response written
	//   in richtext.
	//
	// This member is required.
	ContentType *string

	// The timestamp when the quick response was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the quick response data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The name of the quick response.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// This member is required.
	QuickResponseArn *string

	// The identifier of the quick response.
	//
	// This member is required.
	QuickResponseId *string

	// The status of the quick response data.
	//
	// This member is required.
	Status QuickResponseStatus

	// The Amazon Connect contact channels this quick response applies to. The
	// supported contact channel types include Chat .
	Channels []string

	// The contents of the quick response.
	Contents *QuickResponseContents

	// The description of the quick response.
	Description *string

	// The configuration information of the user groups that the quick response is
	// accessible to.
	GroupingConfiguration *GroupingConfiguration

	// Whether the quick response is active.
	IsActive *bool

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// data.
	LastModifiedBy *string

	// The shortcut key of the quick response. The value should be unique across the
	// knowledge base.
	ShortcutKey *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the quick response.

type QuickResponseDataProvider 

type QuickResponseDataProvider interface {
	// contains filtered or unexported methods
}

The container of quick response data.

The following types satisfy this interface: 

QuickResponseDataProviderMemberContent
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.QuickResponseDataProvider
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QuickResponseDataProviderMemberContent:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type QuickResponseDataProviderMemberContent 

type QuickResponseDataProviderMemberContent struct {
	Value string
	// contains filtered or unexported fields
}

The content of the quick response.

type QuickResponseFilterField 

type QuickResponseFilterField struct {

	// The name of the attribute field to filter the quick responses by.
	//
	// This member is required.
	Name *string

	// The operator to use for filtering.
	//
	// This member is required.
	Operator QuickResponseFilterOperator

	// Whether to treat null value as a match for the attribute field.
	IncludeNoExistence *bool

	// The values of attribute field to filter the quick response by.
	Values []string
	// contains filtered or unexported fields
}

The quick response fields to filter the quick response query results by.

The following is the list of supported field names.

  • name

  • description

  • shortcutKey

  • isActive

  • channels

  • language

  • contentType

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

type QuickResponseFilterOperator 

type QuickResponseFilterOperator string
const (
	QuickResponseFilterOperatorEquals QuickResponseFilterOperator = "EQUALS"
	QuickResponseFilterOperatorPrefix QuickResponseFilterOperator = "PREFIX"
)

Enum values for QuickResponseFilterOperator

func (QuickResponseFilterOperator) Values 

func (QuickResponseFilterOperator) Values() []QuickResponseFilterOperator

Values returns all known values for QuickResponseFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuickResponseOrderField 

type QuickResponseOrderField struct {

	// The name of the attribute to order the quick response query results by.
	//
	// This member is required.
	Name *string

	// The order at which the quick responses are sorted by.
	Order Order
	// contains filtered or unexported fields
}

The quick response fields to order the quick response query results by.

The following is the list of supported field names.

  • name

  • description

  • shortcutKey

  • isActive

  • channels

  • language

  • contentType

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

type QuickResponseQueryField 

type QuickResponseQueryField struct {

	// The name of the attribute to query the quick responses by.
	//
	// This member is required.
	Name *string

	// The operator to use for matching attribute field values in the query.
	//
	// This member is required.
	Operator QuickResponseQueryOperator

	// The values of the attribute to query the quick responses by.
	//
	// This member is required.
	Values []string

	// Whether the query expects only exact matches on the attribute field values. The
	// results of the query will only include exact matches if this parameter is set to
	// false.
	AllowFuzziness *bool

	// The importance of the attribute field when calculating query result relevancy
	// scores. The value set for this parameter affects the ordering of search results.
	Priority Priority
	// contains filtered or unexported fields
}

The quick response fields to query quick responses by.

The following is the list of supported field names.

  • content

  • name

  • description

  • shortcutKey

type QuickResponseQueryOperator 

type QuickResponseQueryOperator string
const (
	QuickResponseQueryOperatorContains          QuickResponseQueryOperator = "CONTAINS"
	QuickResponseQueryOperatorContainsAndPrefix QuickResponseQueryOperator = "CONTAINS_AND_PREFIX"
)

Enum values for QuickResponseQueryOperator

func (QuickResponseQueryOperator) Values 

func (QuickResponseQueryOperator) Values() []QuickResponseQueryOperator

Values returns all known values for QuickResponseQueryOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuickResponseSearchExpression 

type QuickResponseSearchExpression struct {

	// The configuration of filtering rules applied to quick response query results.
	Filters []QuickResponseFilterField

	// The quick response attribute fields on which the query results are ordered.
	OrderOnField *QuickResponseOrderField

	// The quick response query expressions.
	Queries []QuickResponseQueryField
	// contains filtered or unexported fields
}

Information about the import job.

type QuickResponseSearchResultData 

type QuickResponseSearchResultData struct {

	// The media type of the quick response content.
	//
	//   - Use application/x.quickresponse;format=plain for quick response written in
	//   plain text.
	//
	//   - Use application/x.quickresponse;format=markdown for quick response written
	//   in richtext.
	//
	// This member is required.
	ContentType *string

	// The contents of the quick response.
	//
	// This member is required.
	Contents *QuickResponseContents

	// The timestamp when the quick response was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// Whether the quick response is active.
	//
	// This member is required.
	IsActive *bool

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the quick response search result data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The name of the quick response.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// This member is required.
	QuickResponseArn *string

	// The identifier of the quick response.
	//
	// This member is required.
	QuickResponseId *string

	// The resource status of the quick response.
	//
	// This member is required.
	Status QuickResponseStatus

	// The user defined contact attributes that are resolved when the search result is
	// returned.
	AttributesInterpolated []string

	// The user defined contact attributes that are not resolved when the search
	// result is returned.
	AttributesNotInterpolated []string

	// The Amazon Connect contact channels this quick response applies to. The
	// supported contact channel types include Chat .
	Channels []string

	// The description of the quick response.
	Description *string

	// The configuration information of the user groups that the quick response is
	// accessible to.
	GroupingConfiguration *GroupingConfiguration

	// The language code value for the language in which the quick response is written.
	Language *string

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// search result data.
	LastModifiedBy *string

	// The shortcut key of the quick response. The value should be unique across the
	// knowledge base.
	ShortcutKey *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The result of quick response search.

type QuickResponseStatus 

type QuickResponseStatus string
const (
	QuickResponseStatusCreateInProgress QuickResponseStatus = "CREATE_IN_PROGRESS"
	QuickResponseStatusCreateFailed     QuickResponseStatus = "CREATE_FAILED"
	QuickResponseStatusCreated          QuickResponseStatus = "CREATED"
	QuickResponseStatusDeleteInProgress QuickResponseStatus = "DELETE_IN_PROGRESS"
	QuickResponseStatusDeleteFailed     QuickResponseStatus = "DELETE_FAILED"
	QuickResponseStatusDeleted          QuickResponseStatus = "DELETED"
	QuickResponseStatusUpdateInProgress QuickResponseStatus = "UPDATE_IN_PROGRESS"
	QuickResponseStatusUpdateFailed     QuickResponseStatus = "UPDATE_FAILED"
)

Enum values for QuickResponseStatus

func (QuickResponseStatus) Values 

func (QuickResponseStatus) Values() []QuickResponseStatus

Values returns all known values for QuickResponseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuickResponseSummary 

type QuickResponseSummary struct {

	// The media type of the quick response content.
	//
	//   - Use application/x.quickresponse;format=plain for quick response written in
	//   plain text.
	//
	//   - Use application/x.quickresponse;format=markdown for quick response written
	//   in richtext.
	//
	// This member is required.
	ContentType *string

	// The timestamp when the quick response was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the quick response summary was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The name of the quick response.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// This member is required.
	QuickResponseArn *string

	// The identifier of the quick response.
	//
	// This member is required.
	QuickResponseId *string

	// The resource status of the quick response.
	//
	// This member is required.
	Status QuickResponseStatus

	// The Amazon Connect contact channels this quick response applies to. The
	// supported contact channel types include Chat .
	Channels []string

	// The description of the quick response.
	Description *string

	// Whether the quick response is active.
	IsActive *bool

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// data.
	LastModifiedBy *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The summary information about the quick response.

type RankingData 

type RankingData struct {

	// The relevance score of the content.
	RelevanceLevel RelevanceLevel

	// The relevance level of the recommendation.
	RelevanceScore float64
	// contains filtered or unexported fields
}

Details about the source content ranking data.

type RecommendationData 

type RecommendationData struct {

	// The identifier of the recommendation.
	//
	// This member is required.
	RecommendationId *string

	//  Summary of the recommended content.
	Data *DataSummary

	// The recommended document.
	Document *Document

	// The relevance level of the recommendation.
	RelevanceLevel RelevanceLevel

	// The relevance score of the recommendation.
	RelevanceScore float64

	// The type of recommendation.
	Type RecommendationType
	// contains filtered or unexported fields
}

Information about the recommendation.

type RecommendationSourceType 

type RecommendationSourceType string
const (
	RecommendationSourceTypeIssueDetection RecommendationSourceType = "ISSUE_DETECTION"
	RecommendationSourceTypeRuleEvaluation RecommendationSourceType = "RULE_EVALUATION"
	RecommendationSourceTypeOther          RecommendationSourceType = "OTHER"
)

Enum values for RecommendationSourceType

func (RecommendationSourceType) Values 

func (RecommendationSourceType) Values() []RecommendationSourceType

Values returns all known values for RecommendationSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationTrigger 

type RecommendationTrigger struct {

	// A union type containing information related to the trigger.
	//
	// This member is required.
	Data RecommendationTriggerData

	// The identifier of the recommendation trigger.
	//
	// This member is required.
	Id *string

	// The identifiers of the recommendations.
	//
	// This member is required.
	RecommendationIds []string

	// The source of the recommendation trigger.
	//
	//   - ISSUE_DETECTION: The corresponding recommendations were triggered by a
	//   Contact Lens issue.
	//
	//   - RULE_EVALUATION: The corresponding recommendations were triggered by a
	//   Contact Lens rule.
	//
	// This member is required.
	Source RecommendationSourceType

	// The type of recommendation trigger.
	//
	// This member is required.
	Type RecommendationTriggerType
	// contains filtered or unexported fields
}

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

type RecommendationTriggerData 

type RecommendationTriggerData interface {
	// contains filtered or unexported methods
}

A union type containing information related to the trigger.

The following types satisfy this interface: 

RecommendationTriggerDataMemberQuery
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.RecommendationTriggerData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RecommendationTriggerDataMemberQuery:
		_ = v.Value // Value is types.QueryRecommendationTriggerData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type RecommendationTriggerDataMemberQuery 

type RecommendationTriggerDataMemberQuery struct {
	Value QueryRecommendationTriggerData
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

type RecommendationTriggerType 

type RecommendationTriggerType string
const (
	RecommendationTriggerTypeQuery      RecommendationTriggerType = "QUERY"
	RecommendationTriggerTypeGenerative RecommendationTriggerType = "GENERATIVE"
)

Enum values for RecommendationTriggerType

func (RecommendationTriggerType) Values 

func (RecommendationTriggerType) Values() []RecommendationTriggerType

Values returns all known values for RecommendationTriggerType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationType 

type RecommendationType string
const (
	RecommendationTypeKnowledgeContent   RecommendationType = "KNOWLEDGE_CONTENT"
	RecommendationTypeGenerativeResponse RecommendationType = "GENERATIVE_RESPONSE"
	RecommendationTypeGenerativeAnswer   RecommendationType = "GENERATIVE_ANSWER"
	RecommendationTypeDetectedIntent     RecommendationType = "DETECTED_INTENT"
)

Enum values for RecommendationType

func (RecommendationType) Values 

func (RecommendationType) Values() []RecommendationType

Values returns all known values for RecommendationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceType added in v1.12.0 

type ReferenceType string
const (
	ReferenceTypeWebCrawler    ReferenceType = "WEB_CRAWLER"
	ReferenceTypeKnowledgeBase ReferenceType = "KNOWLEDGE_BASE"
)

Enum values for ReferenceType

func (ReferenceType) Values added in v1.12.0 

func (ReferenceType) Values() []ReferenceType

Values returns all known values for ReferenceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Relevance added in v1.2.0 

type Relevance string
const (
	RelevanceHelpful    Relevance = "HELPFUL"
	RelevanceNotHelpful Relevance = "NOT_HELPFUL"
)

Enum values for Relevance

func (Relevance) Values added in v1.2.0 

func (Relevance) Values() []Relevance

Values returns all known values for Relevance. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RelevanceLevel 

type RelevanceLevel string
const (
	RelevanceLevelHigh   RelevanceLevel = "HIGH"
	RelevanceLevelMedium RelevanceLevel = "MEDIUM"
	RelevanceLevelLow    RelevanceLevel = "LOW"
)

Enum values for RelevanceLevel

func (RelevanceLevel) Values 

func (RelevanceLevel) Values() []RelevanceLevel

Values returns all known values for RelevanceLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenderingConfiguration 

type RenderingConfiguration struct {

	// A URI template containing exactly one variable in ${variableName} format. This
	// can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and
	// Zendesk, the variable must be one of the following:
	//
	//   - Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or
	//   IsDeleted
	//
	//   - ServiceNow: number , short_description , sys_mod_count , workflow_state , or
	//   active
	//
	//   - Zendesk: id , title , updated_at , or draft
	//
	// The variable is replaced with the actual value for a piece of content when
	// calling [GetContent].
	//
	// [GetContent]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html
	TemplateUri *string
	// contains filtered or unexported fields
}

Information about how to render the content.

type RequestTimeoutException 

type RequestTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

func (*RequestTimeoutException) Error 

func (e *RequestTimeoutException) Error() string

func (*RequestTimeoutException) ErrorCode 

func (e *RequestTimeoutException) ErrorCode() string

func (*RequestTimeoutException) ErrorFault 

func (e *RequestTimeoutException) ErrorFault() smithy.ErrorFault

func (*RequestTimeoutException) ErrorMessage 

func (e *RequestTimeoutException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResultData 

type ResultData struct {

	// The identifier of the result data.
	//
	// This member is required.
	ResultId *string

	//  Summary of the recommended content.
	Data *DataSummary

	// The document.
	Document *Document

	// The relevance score of the results.
	RelevanceScore float64

	// The type of the query result.
	Type QueryResultType
	// contains filtered or unexported fields
}

Information about the result.

type RuntimeSessionData added in v1.12.0 

type RuntimeSessionData struct {

	// The key of the data stored on the session.
	//
	// This member is required.
	Key *string

	// The value of the data stored on the session.
	//
	// This member is required.
	Value RuntimeSessionDataValue
	// contains filtered or unexported fields
}

The list of key-value pairs that are stored on the session.

type RuntimeSessionDataValue added in v1.12.0 

type RuntimeSessionDataValue interface {
	// contains filtered or unexported methods
}

A union type that specifies the data stored on the session.

The following types satisfy this interface: 

RuntimeSessionDataValueMemberStringValue
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.RuntimeSessionDataValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RuntimeSessionDataValueMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type RuntimeSessionDataValueMemberStringValue added in v1.12.0 

type RuntimeSessionDataValueMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

The string value of the data stored on the session.

type SMSMessageTemplateContent added in v1.13.0 

type SMSMessageTemplateContent struct {

	// The body to use in SMS messages.
	Body *SMSMessageTemplateContentBody
	// contains filtered or unexported fields
}

The content of the message template that applies to the SMS channel subtype.

type SMSMessageTemplateContentBody added in v1.13.0 

type SMSMessageTemplateContentBody struct {

	// The message body to use in SMS messages.
	PlainText MessageTemplateBodyContentProvider
	// contains filtered or unexported fields
}

The body to use in SMS messages.

type SearchExpression 

type SearchExpression struct {

	// The search expression filters.
	//
	// This member is required.
	Filters []Filter
	// contains filtered or unexported fields
}

The search expression.

type SeedUrl added in v1.12.0 

type SeedUrl struct {

	// URL for crawling
	Url *string
	// contains filtered or unexported fields
}

A URL for crawling.

type SelfServiceAIAgentConfiguration added in v1.14.0 

type SelfServiceAIAgentConfiguration struct {

	// The association configurations for overriding behavior on this AI Agent.
	AssociationConfigurations []AssociationConfiguration

	// The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
	SelfServiceAIGuardrailId *string

	// The AI Prompt identifier for the Self Service Answer Generation prompt used by
	// the SELF_SERVICE AI Agent
	SelfServiceAnswerGenerationAIPromptId *string

	// The AI Prompt identifier for the Self Service Pre-Processing prompt used by the
	// SELF_SERVICE AI Agent
	SelfServicePreProcessingAIPromptId *string
	// contains filtered or unexported fields
}

The configuration for AI Agents of type SELF_SERVICE.

type SelfServiceConversationHistory added in v1.14.0 

type SelfServiceConversationHistory struct {

	// The number of turn of the conversation history data.
	//
	// This member is required.
	TurnNumber *int32

	// The bot response of the conversation history data.
	BotResponse *string

	// The input transcript of the conversation history data.
	InputTranscript *string
	// contains filtered or unexported fields
}

The conversation history data to included in conversation context data before the Amazon Q in Connect session.

type SemanticChunkingConfiguration added in v1.12.0 

type SemanticChunkingConfiguration struct {

	// The dissimilarity threshold for splitting chunks.
	//
	// This member is required.
	BreakpointPercentileThreshold *int32

	// The buffer size.
	//
	// This member is required.
	BufferSize *int32

	// The maximum number of tokens that a chunk can contain.
	//
	// This member is required.
	MaxTokens *int32
	// contains filtered or unexported fields
}

Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.

type ServerSideEncryptionConfiguration 

type ServerSideEncryptionConfiguration struct {

	// The customer managed key used for encryption. For more information about
	// setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance]. For
	// information about valid ID values, see [Key identifiers (KeyId)].
	//
	// [Key identifiers (KeyId)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	KmsKeyId *string
	// contains filtered or unexported fields
}

The configuration information for the customer managed key used for encryption.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SessionData 

type SessionData struct {

	// The name of the session.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the session.
	//
	// This member is required.
	SessionArn *string

	// The identifier of the session.
	//
	// This member is required.
	SessionId *string

	// The configuration of the AI Agents (mapped by AI Agent Type to AI Agent
	// version) that should be used by Amazon Q in Connect for this Session.
	AiAgentConfiguration map[string]AIAgentConfigurationData

	// The description of the session.
	Description *string

	// The configuration information for the session integration.
	IntegrationConfiguration *SessionIntegrationConfiguration

	// An object that can be used to specify Tag conditions.
	TagFilter TagFilter

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the session.

type SessionDataNamespace added in v1.12.0 

type SessionDataNamespace string
const (
	SessionDataNamespaceCustom SessionDataNamespace = "Custom"
)

Enum values for SessionDataNamespace

func (SessionDataNamespace) Values added in v1.12.0 

func (SessionDataNamespace) Values() []SessionDataNamespace

Values returns all known values for SessionDataNamespace. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionIntegrationConfiguration 

type SessionIntegrationConfiguration struct {

	// The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for
	// streaming chat messages.
	TopicIntegrationArn *string
	// contains filtered or unexported fields
}

The configuration information for the session integration.

type SessionSummary 

type SessionSummary struct {

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The Amazon Resource Name (ARN) of the session.
	//
	// This member is required.
	SessionArn *string

	// The identifier of the session.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

Summary information about the session.

type SourceConfiguration 

type SourceConfiguration interface {
	// contains filtered or unexported methods
}

Configuration information about the external data source.

The following types satisfy this interface: 

SourceConfigurationMemberAppIntegrations
SourceConfigurationMemberManagedSourceConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.SourceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SourceConfigurationMemberAppIntegrations:
		_ = v.Value // Value is types.AppIntegrationsConfiguration

	case *types.SourceConfigurationMemberManagedSourceConfiguration:
		_ = v.Value // Value is types.ManagedSourceConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type SourceConfigurationMemberAppIntegrations 

type SourceConfigurationMemberAppIntegrations struct {
	Value AppIntegrationsConfiguration
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

type SourceConfigurationMemberManagedSourceConfiguration added in v1.12.0 

type SourceConfigurationMemberManagedSourceConfiguration struct {
	Value ManagedSourceConfiguration
	// contains filtered or unexported fields
}

Source configuration for managed resources.

type SourceContentDataDetails 

type SourceContentDataDetails struct {

	// The identifier of the source content.
	//
	// This member is required.
	Id *string

	// Details about the source content ranking data.
	//
	// This member is required.
	RankingData *RankingData

	//  Details about the source content text data.
	//
	// This member is required.
	TextData *TextData

	// The type of the source content.
	//
	// This member is required.
	Type SourceContentType

	// Contains information about where the text with a citation begins and ends in
	// the generated output.
	CitationSpan *CitationSpan
	// contains filtered or unexported fields
}

Details about the source content data.

type SourceContentType 

type SourceContentType string
const (
	SourceContentTypeKnowledgeContent SourceContentType = "KNOWLEDGE_CONTENT"
)

Enum values for SourceContentType

func (SourceContentType) Values 

func (SourceContentType) Values() []SourceContentType

Values returns all known values for SourceContentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Status added in v1.12.0 

type Status string
const (
	StatusCreateInProgress Status = "CREATE_IN_PROGRESS"
	StatusCreateFailed     Status = "CREATE_FAILED"
	StatusActive           Status = "ACTIVE"
	StatusDeleteInProgress Status = "DELETE_IN_PROGRESS"
	StatusDeleteFailed     Status = "DELETE_FAILED"
	StatusDeleted          Status = "DELETED"
)

Enum values for Status

func (Status) Values added in v1.12.0 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SyncStatus added in v1.12.0 

type SyncStatus string
const (
	SyncStatusSyncFailed        SyncStatus = "SYNC_FAILED"
	SyncStatusSyncingInProgress SyncStatus = "SYNCING_IN_PROGRESS"
	SyncStatusSyncSuccess       SyncStatus = "SYNC_SUCCESS"
	SyncStatusCreateInProgress  SyncStatus = "CREATE_IN_PROGRESS"
)

Enum values for SyncStatus

func (SyncStatus) Values added in v1.12.0 

func (SyncStatus) Values() []SyncStatus

Values returns all known values for SyncStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SystemAttributes added in v1.13.0 

type SystemAttributes struct {

	// The CustomerEndpoint attribute.
	CustomerEndpoint *SystemEndpointAttributes

	// The name of the task.
	Name *string

	// The SystemEndpoint attribute.
	SystemEndpoint *SystemEndpointAttributes
	// contains filtered or unexported fields
}

The system attributes that are used with the message template.

type SystemEndpointAttributes added in v1.13.0 

type SystemEndpointAttributes struct {

	// The customer's phone number if used with customerEndpoint , or the number the
	// customer dialed to call your contact center if used with systemEndpoint .
	Address *string
	// contains filtered or unexported fields
}

The system endpoint attributes that are used with the message template.

type TagCondition added in v1.6.0 

type TagCondition struct {

	// The tag key in the tag condition.
	//
	// This member is required.
	Key *string

	// The tag value in the tag condition.
	Value *string
	// contains filtered or unexported fields
}

A leaf node condition which can be used to specify a tag condition.

type TagFilter added in v1.6.0 

type TagFilter interface {
	// contains filtered or unexported methods
}

An object that can be used to specify Tag conditions.

The following types satisfy this interface: 

TagFilterMemberAndConditions
TagFilterMemberOrConditions
TagFilterMemberTagCondition
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qconnect/types"
)

func main() {
	var union types.TagFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TagFilterMemberAndConditions:
		_ = v.Value // Value is []types.TagCondition

	case *types.TagFilterMemberOrConditions:
		_ = v.Value // Value is []types.OrCondition

	case *types.TagFilterMemberTagCondition:
		_ = v.Value // Value is types.TagCondition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type TagFilterMemberAndConditions added in v1.6.0 

type TagFilterMemberAndConditions struct {
	Value []TagCondition
	// contains filtered or unexported fields
}

A list of conditions which would be applied together with an AND condition.

type TagFilterMemberOrConditions added in v1.6.0 

type TagFilterMemberOrConditions struct {
	Value []OrCondition
	// contains filtered or unexported fields
}

A list of conditions which would be applied together with an OR condition.

type TagFilterMemberTagCondition added in v1.6.0 

type TagFilterMemberTagCondition struct {
	Value TagCondition
	// contains filtered or unexported fields
}

A leaf node condition which can be used to specify a tag condition.

type TargetType added in v1.2.0 

type TargetType string
const (
	TargetTypeRecommendation TargetType = "RECOMMENDATION"
	TargetTypeResult         TargetType = "RESULT"
)

Enum values for TargetType

func (TargetType) Values added in v1.2.0 

func (TargetType) Values() []TargetType

Values returns all known values for TargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TextData 

type TextData struct {

	// The text of the document.
	Excerpt *DocumentText

	// The text of the document.
	Title *DocumentText
	// contains filtered or unexported fields
}

Details about the source content text data.

type TextFullAIPromptEditTemplateConfiguration added in v1.12.0 

type TextFullAIPromptEditTemplateConfiguration struct {

	// The YAML text for the AI Prompt template.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

type TextMessage added in v1.14.0 

type TextMessage struct {

	// The value of the message data in text type.
	Value *string
	// contains filtered or unexported fields
}

The message data in text type.

type ThrottlingException added in v1.9.0 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The throttling limit has been exceeded.

func (*ThrottlingException) Error added in v1.9.0 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode added in v1.9.0 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault added in v1.9.0 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage added in v1.9.0 

func (e *ThrottlingException) ErrorMessage() string

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

Amazon Q in Connect throws this exception if you have too many tags in your tag set.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UrlConfiguration added in v1.12.0 

type UrlConfiguration struct {

	// List of URLs for crawling.
	SeedUrls []SeedUrl
	// contains filtered or unexported fields
}

The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by a service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VectorIngestionConfiguration added in v1.12.0 

type VectorIngestionConfiguration struct {

	// Details about how to chunk the documents in the data source. A chunk refers to
	// an excerpt from a data source that is returned when the knowledge base that it
	// belongs to is queried.
	ChunkingConfiguration *ChunkingConfiguration

	// A custom parser for data source documents.
	ParsingConfiguration *ParsingConfiguration
	// contains filtered or unexported fields
}

Contains details about how to ingest the documents in a data source.

type VisibilityStatus added in v1.12.0 

type VisibilityStatus string
const (
	VisibilityStatusSaved     VisibilityStatus = "SAVED"
	VisibilityStatusPublished VisibilityStatus = "PUBLISHED"
)

Enum values for VisibilityStatus

func (VisibilityStatus) Values added in v1.12.0 

func (VisibilityStatus) Values() []VisibilityStatus

Values returns all known values for VisibilityStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WebCrawlerConfiguration added in v1.12.0 

type WebCrawlerConfiguration struct {

	// The configuration of the URL/URLs for the web content that you want to crawl.
	// You should be authorized to crawl the URLs.
	//
	// This member is required.
	UrlConfiguration *UrlConfiguration

	// The configuration of crawl limits for the web URLs.
	CrawlerLimits *WebCrawlerLimits

	// A list of one or more exclusion regular expression patterns to exclude certain
	// URLs. If you specify an inclusion and exclusion filter/pattern and both match a
	// URL, the exclusion filter takes precedence and the web content of the URL isn’t
	// crawled.
	ExclusionFilters []string

	// A list of one or more inclusion regular expression patterns to include certain
	// URLs. If you specify an inclusion and exclusion filter/pattern and both match a
	// URL, the exclusion filter takes precedence and the web content of the URL isn’t
	// crawled.
	InclusionFilters []string

	// The scope of what is crawled for your URLs. You can choose to crawl only web
	// pages that belong to the same host or primary domain. For example, only web
	// pages that contain the seed URL
	// https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You
	// can choose to include sub domains in addition to the host or primary domain. For
	// example, web pages that contain aws.amazon.com can also include sub domain
	// docs.aws.amazon.com .
	Scope WebScopeType
	// contains filtered or unexported fields
}

The configuration details for the web data source.

type WebCrawlerLimits added in v1.12.0 

type WebCrawlerLimits struct {

	// Rate of web URLs retrieved per minute.
	RateLimit *int32
	// contains filtered or unexported fields
}

The configuration of crawl limits for the web URLs.

type WebScopeType added in v1.12.0 

type WebScopeType string
const (
	WebScopeTypeHostOnly   WebScopeType = "HOST_ONLY"
	WebScopeTypeSubdomains WebScopeType = "SUBDOMAINS"
)

Enum values for WebScopeType

func (WebScopeType) Values added in v1.12.0 

func (WebScopeType) Values() []WebScopeType

Values returns all known values for WebScopeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.