types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APISchema 

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

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

The following types satisfy this interface: 

APISchemaMemberPayload
APISchemaMemberS3
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.APISchemaMemberS3:
		_ = v.Value // Value is types.S3

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

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

	}
}

type APISchemaMemberPayload 

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

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

type APISchemaMemberS3 

type APISchemaMemberS3 struct {
	Value S3
	// contains filtered or unexported fields
}

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

type APISchemaType 

type APISchemaType string
const (
	APISchemaTypeOpenApiV3 APISchemaType = "OPEN_API_V3"
)

Enum values for APISchemaType

func (APISchemaType) Values 

func (APISchemaType) Values() []APISchemaType

Values returns all known values for APISchemaType. 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 AccessConfiguration 

type AccessConfiguration struct {

	// A list of AccessControlList objects.
	//
	// This member is required.
	AccessControls []AccessControl

	// Describes the member relation within the AccessControlList object.
	MemberRelation MemberRelation
	// contains filtered or unexported fields
}

Used to configure access permissions for a document.

type AccessControl 

type AccessControl struct {

	// Contains a list of principals, where a principal can be either a USER or a GROUP
	// . Each principal can be have the following type of document access: ALLOW or
	// DENY .
	//
	// This member is required.
	Principals []Principal

	// Describes the member relation within a principal list.
	MemberRelation MemberRelation
	// contains filtered or unexported fields
}

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY .

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
You don't have access to perform this action. Make sure you have the required

permission policies and user accounts and try again.

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 ActionExecution 

type ActionExecution struct {

	// A mapping of field names to the field values in input that an end user provides
	// to Amazon Q Business requests to perform their plugin action.
	//
	// This member is required.
	Payload map[string]ActionExecutionPayloadField

	// A string used to retain information about the hierarchical contexts within an
	// action execution event payload.
	//
	// This member is required.
	PayloadFieldNameSeparator *string

	// The identifier of the plugin the action is attached to.
	//
	// This member is required.
	PluginId *string
	// contains filtered or unexported fields
}

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

type ActionExecutionEvent 

type ActionExecutionEvent struct {

	// A mapping of field names to the field values in input that an end user provides
	// to Amazon Q Business requests to perform their plugin action.
	//
	// This member is required.
	Payload map[string]ActionExecutionPayloadField

	// A string used to retain information about the hierarchical contexts within a
	// action execution event payload.
	//
	// This member is required.
	PayloadFieldNameSeparator *string

	// The identifier of the plugin for which the action is being requested.
	//
	// This member is required.
	PluginId *string
	// contains filtered or unexported fields
}

A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.

type ActionExecutionPayloadField 

type ActionExecutionPayloadField struct {

	// The content of a user input field in an plugin action execution payload.
	//
	// This member is required.
	Value document.Interface
	// contains filtered or unexported fields
}

A user input field in an plugin action execution payload.

type ActionPayloadFieldType 

type ActionPayloadFieldType string
const (
	ActionPayloadFieldTypeString  ActionPayloadFieldType = "STRING"
	ActionPayloadFieldTypeNumber  ActionPayloadFieldType = "NUMBER"
	ActionPayloadFieldTypeArray   ActionPayloadFieldType = "ARRAY"
	ActionPayloadFieldTypeBoolean ActionPayloadFieldType = "BOOLEAN"
)

Enum values for ActionPayloadFieldType

func (ActionPayloadFieldType) Values 

func (ActionPayloadFieldType) Values() []ActionPayloadFieldType

Values returns all known values for ActionPayloadFieldType. 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 ActionReview 

type ActionReview struct {

	// Field values that an end user needs to provide to Amazon Q Business for Amazon
	// Q Business to perform the requested plugin action.
	Payload map[string]ActionReviewPayloadField

	// A string used to retain information about the hierarchical contexts within an
	// action review payload.
	PayloadFieldNameSeparator *string

	// The identifier of the plugin associated with the action review.
	PluginId *string

	// The type of plugin.
	PluginType PluginType
	// contains filtered or unexported fields
}

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

type ActionReviewEvent 

type ActionReviewEvent struct {

	// The identifier of the conversation with which the action review event is
	// associated.
	ConversationId *string

	// Field values that an end user needs to provide to Amazon Q Business for Amazon
	// Q Business to perform the requested plugin action.
	Payload map[string]ActionReviewPayloadField

	// A string used to retain information about the hierarchical contexts within an
	// action review event payload.
	PayloadFieldNameSeparator *string

	// The identifier of the plugin associated with the action review event.
	PluginId *string

	// The type of plugin.
	PluginType PluginType

	// The identifier of an Amazon Q Business AI generated associated with the action
	// review event.
	SystemMessageId *string

	// The identifier of the conversation with which the plugin action is associated.
	UserMessageId *string
	// contains filtered or unexported fields
}

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

type ActionReviewPayloadField 

type ActionReviewPayloadField struct {

	// The expected data format for the action review input field value. For example,
	// in PTO request, from and to would be of datetime allowed format.
	AllowedFormat *string

	// Information about the field values that an end user can use to provide to
	// Amazon Q Business for Amazon Q Business to perform the requested plugin action.
	AllowedValues []ActionReviewPayloadFieldAllowedValue

	// The field level description of each action review input field. This could be an
	// explanation of the field. In the Amazon Q Business web experience, these
	// descriptions could be used to display as tool tips to help users understand the
	// field.
	DisplayDescription *string

	//  The name of the field.
	DisplayName *string

	// The display order of fields in a payload.
	DisplayOrder *int32

	// Information about whether the field is required.
	Required *bool

	// The type of field.
	Type ActionPayloadFieldType

	// The field value.
	Value document.Interface
	// contains filtered or unexported fields
}

A user input field in an plugin action review payload.

type ActionReviewPayloadFieldAllowedValue 

type ActionReviewPayloadFieldAllowedValue struct {

	// The name of the field.
	DisplayValue document.Interface

	// The field value.
	Value document.Interface
	// contains filtered or unexported fields
}

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

type Application 

type Application struct {

	// The identifier for the Amazon Q Business application.
	ApplicationId *string

	// The Unix timestamp when the Amazon Q Business application was created.
	CreatedAt *time.Time

	// The name of the Amazon Q Business application.
	DisplayName *string

	// The status of the Amazon Q Business application. The application is ready to
	// use when the status is ACTIVE .
	Status ApplicationStatus

	// The Unix timestamp when the Amazon Q Business application was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Summary information for an Amazon Q Business application.

type ApplicationStatus 

type ApplicationStatus string
const (
	ApplicationStatusCreating ApplicationStatus = "CREATING"
	ApplicationStatusActive   ApplicationStatus = "ACTIVE"
	ApplicationStatusDeleting ApplicationStatus = "DELETING"
	ApplicationStatusFailed   ApplicationStatus = "FAILED"
	ApplicationStatusUpdating ApplicationStatus = "UPDATING"
)

Enum values for ApplicationStatus

func (ApplicationStatus) Values 

func (ApplicationStatus) Values() []ApplicationStatus

Values returns all known values for ApplicationStatus. 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 AppliedAttachmentsConfiguration 

type AppliedAttachmentsConfiguration struct {

	// Information about whether file upload during chat functionality is activated
	// for your application.
	AttachmentsControlMode AttachmentsControlMode
	// contains filtered or unexported fields
}

Configuration information about the file upload during chat feature for your application.

type AppliedCreatorModeConfiguration 

type AppliedCreatorModeConfiguration struct {

	//  Information about whether creator mode is enabled or disabled for an Amazon Q
	// Business application.
	//
	// This member is required.
	CreatorModeControl CreatorModeControl
	// contains filtered or unexported fields
}

The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.

For more information, see Admin controls and guardrails and Conversation settings.

type AttachmentInput 

type AttachmentInput struct {

	// The data contained within the uploaded file.
	//
	// This member is required.
	Data []byte

	// The name of the file.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A file directly uploaded into a web experience chat.

type AttachmentInputEvent 

type AttachmentInputEvent struct {

	// A file directly uploaded into a web experience chat.
	Attachment *AttachmentInput
	// contains filtered or unexported fields
}

A file input event activated by a end user request to upload files into their web experience chat.

type AttachmentOutput 

type AttachmentOutput struct {

	// An error associated with a file uploaded during chat.
	Error *ErrorDetail

	// The name of a file uploaded during chat.
	Name *string

	// The status of a file uploaded during chat.
	Status AttachmentStatus
	// contains filtered or unexported fields
}

The details of a file uploaded during chat.

type AttachmentStatus 

type AttachmentStatus string
const (
	AttachmentStatusFailed    AttachmentStatus = "FAILED"
	AttachmentStatusSucceeded AttachmentStatus = "SUCCEEDED"
)

Enum values for AttachmentStatus

func (AttachmentStatus) Values 

func (AttachmentStatus) Values() []AttachmentStatus

Values returns all known values for AttachmentStatus. 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 AttachmentsConfiguration 

type AttachmentsConfiguration struct {

	// Status information about whether file upload functionality is activated or
	// deactivated for your end user.
	//
	// This member is required.
	AttachmentsControlMode AttachmentsControlMode
	// contains filtered or unexported fields
}

Configuration information for the file upload during chat feature.

type AttachmentsControlMode 

type AttachmentsControlMode string
const (
	AttachmentsControlModeEnabled  AttachmentsControlMode = "ENABLED"
	AttachmentsControlModeDisabled AttachmentsControlMode = "DISABLED"
)

Enum values for AttachmentsControlMode

func (AttachmentsControlMode) Values 

func (AttachmentsControlMode) Values() []AttachmentsControlMode

Values returns all known values for AttachmentsControlMode. 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 AttributeFilter 

type AttributeFilter struct {

	// Performs a logical AND operation on all supplied filters.
	AndAllFilters []AttributeFilter

	// Returns true when a document contains all the specified document attributes or
	// metadata fields. Supported for the following [document attribute value types]: stringListValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	ContainsAll *DocumentAttribute

	// Returns true when a document contains any of the specified document attributes
	// or metadata fields. Supported for the following [document attribute value types]: dateValue , longValue ,
	// stringListValue and stringValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	ContainsAny *DocumentAttribute

	// Performs an equals operation on two document attributes or metadata fields.
	// Supported for the following [document attribute value types]: dateValue , longValue , stringListValue and
	// stringValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	EqualsTo *DocumentAttribute

	// Performs a greater than operation on two document attributes or metadata
	// fields. Supported for the following [document attribute value types]: dateValue and longValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	GreaterThan *DocumentAttribute

	// Performs a greater or equals than operation on two document attributes or
	// metadata fields. Supported for the following [document attribute value types]: dateValue and longValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	GreaterThanOrEquals *DocumentAttribute

	// Performs a less than operation on two document attributes or metadata fields.
	// Supported for the following [document attribute value types]: dateValue and longValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	LessThan *DocumentAttribute

	// Performs a less than or equals operation on two document attributes or metadata
	// fields.Supported for the following [document attribute value type]: dateValue and longValue .
	//
	// [document attribute value type]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	LessThanOrEquals *DocumentAttribute

	// Performs a logical NOT operation on all supplied filters.
	NotFilter *AttributeFilter

	//  Performs a logical OR operation on all supplied filters.
	OrAllFilters []AttributeFilter
	// contains filtered or unexported fields
}

Enables filtering of responses based on document attributes or metadata fields.

type AttributeType 

type AttributeType string
const (
	AttributeTypeString     AttributeType = "STRING"
	AttributeTypeStringList AttributeType = "STRING_LIST"
	AttributeTypeNumber     AttributeType = "NUMBER"
	AttributeTypeDate       AttributeType = "DATE"
)

Enum values for AttributeType

func (AttributeType) Values 

func (AttributeType) Values() []AttributeType

Values returns all known values for AttributeType. 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 AttributeValueOperator 

type AttributeValueOperator string
const (
	AttributeValueOperatorDelete AttributeValueOperator = "DELETE"
)

Enum values for AttributeValueOperator

func (AttributeValueOperator) Values 

func (AttributeValueOperator) Values() []AttributeValueOperator

Values returns all known values for AttributeValueOperator. 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 AuthChallengeRequest 

type AuthChallengeRequest struct {

	// The URL sent by Amazon Q Business to the third party authentication server to
	// authenticate a custom plugin user through an OAuth protocol.
	//
	// This member is required.
	AuthorizationUrl *string
	// contains filtered or unexported fields
}

A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.

type AuthChallengeRequestEvent 

type AuthChallengeRequestEvent struct {

	// The URL sent by Amazon Q Business to a third party authentication server in
	// response to an authentication verification event activated by an end user
	// request to use a custom plugin.
	//
	// This member is required.
	AuthorizationUrl *string
	// contains filtered or unexported fields
}

An authentication verification event activated by an end user request to use a custom plugin.

type AuthChallengeResponse 

type AuthChallengeResponse struct {

	// The mapping of key-value pairs in an authentication challenge response.
	//
	// This member is required.
	ResponseMap map[string]string
	// contains filtered or unexported fields
}

Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.

type AuthChallengeResponseEvent 

type AuthChallengeResponseEvent struct {

	// The mapping of key-value pairs in an authentication challenge response.
	//
	// This member is required.
	ResponseMap map[string]string
	// contains filtered or unexported fields
}

An authentication verification event response by a third party authentication server to Amazon Q Business.

type BasicAuthConfiguration 

type BasicAuthConfiguration struct {

	// The ARN of an IAM role used by Amazon Q Business to access the basic
	// authentication credentials stored in a Secrets Manager secret.
	//
	// This member is required.
	RoleArn *string

	// The ARN of the Secrets Manager secret that stores the basic authentication
	// credentials used for plugin configuration..
	//
	// This member is required.
	SecretArn *string
	// contains filtered or unexported fields
}

Information about the basic authentication credentials used to configure a plugin.

type BlockedPhrasesConfiguration 

type BlockedPhrasesConfiguration struct {

	// A list of phrases blocked from a Amazon Q Business web experience chat.
	BlockedPhrases []string

	// The configured custom message displayed to an end user informing them that
	// they've used a blocked phrase during chat.
	SystemMessageOverride *string
	// contains filtered or unexported fields
}

Provides information about the phrases blocked from chat by your chat control configuration.

type BlockedPhrasesConfigurationUpdate 

type BlockedPhrasesConfigurationUpdate struct {

	// Creates or updates a blocked phrases configuration in your Amazon Q Business
	// application.
	BlockedPhrasesToCreateOrUpdate []string

	// Deletes a blocked phrases configuration in your Amazon Q Business application.
	BlockedPhrasesToDelete []string

	// The configured custom message displayed to your end user when they use blocked
	// phrase during chat.
	SystemMessageOverride *string
	// contains filtered or unexported fields
}

Updates a blocked phrases configuration in your Amazon Q Business application.

type ChatInputStream 

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

The streaming input for the Chat API.

The following types satisfy this interface: 

ChatInputStreamMemberActionExecutionEvent
ChatInputStreamMemberAttachmentEvent
ChatInputStreamMemberAuthChallengeResponseEvent
ChatInputStreamMemberConfigurationEvent
ChatInputStreamMemberEndOfInputEvent
ChatInputStreamMemberTextEvent
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.ChatInputStreamMemberAttachmentEvent:
		_ = v.Value // Value is types.AttachmentInputEvent

	case *types.ChatInputStreamMemberAuthChallengeResponseEvent:
		_ = v.Value // Value is types.AuthChallengeResponseEvent

	case *types.ChatInputStreamMemberConfigurationEvent:
		_ = v.Value // Value is types.ConfigurationEvent

	case *types.ChatInputStreamMemberEndOfInputEvent:
		_ = v.Value // Value is types.EndOfInputEvent

	case *types.ChatInputStreamMemberTextEvent:
		_ = v.Value // Value is types.TextInputEvent

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

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

	}
}

type ChatInputStreamMemberActionExecutionEvent 

type ChatInputStreamMemberActionExecutionEvent struct {
	Value ActionExecutionEvent
	// contains filtered or unexported fields
}

A request from an end user to perform an Amazon Q Business plugin action.

type ChatInputStreamMemberAttachmentEvent 

type ChatInputStreamMemberAttachmentEvent struct {
	Value AttachmentInputEvent
	// contains filtered or unexported fields
}

A request by an end user to upload a file during chat.

type ChatInputStreamMemberAuthChallengeResponseEvent 

type ChatInputStreamMemberAuthChallengeResponseEvent struct {
	Value AuthChallengeResponseEvent
	// contains filtered or unexported fields
}

An authentication verification event response by a third party authentication server to Amazon Q Business.

type ChatInputStreamMemberConfigurationEvent 

type ChatInputStreamMemberConfigurationEvent struct {
	Value ConfigurationEvent
	// contains filtered or unexported fields
}

A configuration event activated by an end user request to select a specific chat mode.

type ChatInputStreamMemberEndOfInputEvent 

type ChatInputStreamMemberEndOfInputEvent struct {
	Value EndOfInputEvent
	// contains filtered or unexported fields
}

The end of the streaming input for the Chat API.

type ChatInputStreamMemberTextEvent 

type ChatInputStreamMemberTextEvent struct {
	Value TextInputEvent
	// contains filtered or unexported fields
}

Information about the payload of the ChatInputStream event containing the end user message input.

type ChatMode 

type ChatMode string
const (
	ChatModeRetrievalMode ChatMode = "RETRIEVAL_MODE"
	ChatModeCreatorMode   ChatMode = "CREATOR_MODE"
	ChatModePluginMode    ChatMode = "PLUGIN_MODE"
)

Enum values for ChatMode

func (ChatMode) Values 

func (ChatMode) Values() []ChatMode

Values returns all known values for ChatMode. 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 ChatModeConfiguration 

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

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

The following types satisfy this interface: 

ChatModeConfigurationMemberPluginConfiguration
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

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

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

	}
}

type ChatModeConfigurationMemberPluginConfiguration 

type ChatModeConfigurationMemberPluginConfiguration struct {
	Value PluginConfiguration
	// contains filtered or unexported fields
}

Configuration information required to invoke chat in PLUGIN_MODE .

type ChatOutputStream 

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

The streaming output for the Chat API.

The following types satisfy this interface: 

ChatOutputStreamMemberActionReviewEvent
ChatOutputStreamMemberAuthChallengeRequestEvent
ChatOutputStreamMemberFailedAttachmentEvent
ChatOutputStreamMemberMetadataEvent
ChatOutputStreamMemberTextEvent
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.ChatOutputStreamMemberAuthChallengeRequestEvent:
		_ = v.Value // Value is types.AuthChallengeRequestEvent

	case *types.ChatOutputStreamMemberFailedAttachmentEvent:
		_ = v.Value // Value is types.FailedAttachmentEvent

	case *types.ChatOutputStreamMemberMetadataEvent:
		_ = v.Value // Value is types.MetadataEvent

	case *types.ChatOutputStreamMemberTextEvent:
		_ = v.Value // Value is types.TextOutputEvent

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

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

	}
}

type ChatOutputStreamMemberActionReviewEvent 

type ChatOutputStreamMemberActionReviewEvent struct {
	Value ActionReviewEvent
	// contains filtered or unexported fields
}

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

type ChatOutputStreamMemberAuthChallengeRequestEvent 

type ChatOutputStreamMemberAuthChallengeRequestEvent struct {
	Value AuthChallengeRequestEvent
	// contains filtered or unexported fields
}

An authentication verification event activated by an end user request to use a custom plugin.

type ChatOutputStreamMemberFailedAttachmentEvent 

type ChatOutputStreamMemberFailedAttachmentEvent struct {
	Value FailedAttachmentEvent
	// contains filtered or unexported fields
}

A failed file upload event during a web experience chat.

type ChatOutputStreamMemberMetadataEvent 

type ChatOutputStreamMemberMetadataEvent struct {
	Value MetadataEvent
	// contains filtered or unexported fields
}

A metadata event for a AI-generated text output message in a Amazon Q Business conversation.

type ChatOutputStreamMemberTextEvent 

type ChatOutputStreamMemberTextEvent struct {
	Value TextOutputEvent
	// contains filtered or unexported fields
}

Information about the payload of the ChatOutputStream event containing the AI-generated message output.

type ConfigurationEvent 

type ConfigurationEvent struct {

	// Enables filtering of responses based on document attributes or metadata fields.
	AttributeFilter *AttributeFilter

	// The chat modes available to an Amazon Q Business end user.
	//
	//   - RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application.
	//   When this mode is enabled, Amazon Q Business generates responses only from data
	//   sources connected to an Amazon Q Business application.
	//
	//   - CREATOR_MODE - By selecting this mode, users can choose to generate
	//   responses only from the LLM knowledge, without consulting connected data
	//   sources, for a chat request.
	//
	//   - PLUGIN_MODE - By selecting this mode, users can choose to use plugins in
	//   chat.
	//
	// For more information, see [Admin controls and guardrails], [Plugins], and [Conversation settings].
	//
	// [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
	// [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
	// [Plugins]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html
	ChatMode ChatMode

	// Configuration information for Amazon Q Business conversation modes.
	//
	// For more information, see [Admin controls and guardrails] and [Conversation settings].
	//
	// [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
	// [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
	ChatModeConfiguration ChatModeConfiguration
	// contains filtered or unexported fields
}

A configuration event activated by an end user request to select a specific chat mode.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

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 ContentBlockerRule 

type ContentBlockerRule struct {

	// The configured custom message displayed to an end user informing them that
	// they've used a blocked phrase during chat.
	SystemMessageOverride *string
	// contains filtered or unexported fields
}

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

type ContentRetrievalRule 

type ContentRetrievalRule struct {

	// Specifies data sources in a Amazon Q Business application to use for content
	// generation.
	EligibleDataSources []EligibleDataSource
	// contains filtered or unexported fields
}

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

type ContentType 

type ContentType string
const (
	ContentTypePdf       ContentType = "PDF"
	ContentTypeHtml      ContentType = "HTML"
	ContentTypeMsWord    ContentType = "MS_WORD"
	ContentTypePlainText ContentType = "PLAIN_TEXT"
	ContentTypePpt       ContentType = "PPT"
	ContentTypeRtf       ContentType = "RTF"
	ContentTypeXml       ContentType = "XML"
	ContentTypeXslt      ContentType = "XSLT"
	ContentTypeMsExcel   ContentType = "MS_EXCEL"
	ContentTypeCsv       ContentType = "CSV"
	ContentTypeJson      ContentType = "JSON"
	ContentTypeMd        ContentType = "MD"
)

Enum values for ContentType

func (ContentType) Values 

func (ContentType) Values() []ContentType

Values returns all known values for ContentType. 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 Conversation 

type Conversation struct {

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string

	// The start time of the conversation.
	StartTime *time.Time

	// The title of the conversation.
	Title *string
	// contains filtered or unexported fields
}

A conversation in an Amazon Q Business application.

type CreatorModeConfiguration 

type CreatorModeConfiguration struct {

	// Status information about whether CREATOR_MODE has been enabled or disabled. The
	// default status is DISABLED .
	//
	// This member is required.
	CreatorModeControl CreatorModeControl
	// contains filtered or unexported fields
}

Configuration information required to invoke chat in CREATOR_MODE .

For more information, see Admin controls and guardrails and Conversation settings.

type CreatorModeControl 

type CreatorModeControl string
const (
	CreatorModeControlEnabled  CreatorModeControl = "ENABLED"
	CreatorModeControlDisabled CreatorModeControl = "DISABLED"
)

Enum values for CreatorModeControl

func (CreatorModeControl) Values 

func (CreatorModeControl) Values() []CreatorModeControl

Values returns all known values for CreatorModeControl. 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 CustomPluginConfiguration 

type CustomPluginConfiguration struct {

	// Contains either details about the S3 object containing the OpenAPI schema for
	// the action group or the JSON or YAML-formatted payload defining the schema.
	//
	// This member is required.
	ApiSchema APISchema

	// The type of OpenAPI schema to use.
	//
	// This member is required.
	ApiSchemaType APISchemaType

	// A description for your custom plugin configuration.
	//
	// This member is required.
	Description *string
	// contains filtered or unexported fields
}

Configuration information required to create a custom plugin.

type DataSource 

type DataSource struct {

	// The Unix timestamp when the Amazon Q Business data source was created.
	CreatedAt *time.Time

	// The identifier of the Amazon Q Business data source.
	DataSourceId *string

	// The name of the Amazon Q Business data source.
	DisplayName *string

	// The status of the Amazon Q Business data source.
	Status DataSourceStatus

	// The type of the Amazon Q Business data source.
	Type *string

	// The Unix timestamp when the Amazon Q Business data source was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

A data source in an Amazon Q Business application.

type DataSourceStatus 

type DataSourceStatus string
const (
	DataSourceStatusPendingCreation DataSourceStatus = "PENDING_CREATION"
	DataSourceStatusCreating        DataSourceStatus = "CREATING"
	DataSourceStatusActive          DataSourceStatus = "ACTIVE"
	DataSourceStatusDeleting        DataSourceStatus = "DELETING"
	DataSourceStatusFailed          DataSourceStatus = "FAILED"
	DataSourceStatusUpdating        DataSourceStatus = "UPDATING"
)

Enum values for DataSourceStatus

func (DataSourceStatus) Values 

func (DataSourceStatus) Values() []DataSourceStatus

Values returns all known values for DataSourceStatus. 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 DataSourceSyncJob 

type DataSourceSyncJob struct {

	// If the reason that the synchronization failed is due to an error with the
	// underlying data source, this field contains a code that identifies the error.
	DataSourceErrorCode *string

	// The Unix timestamp when the synchronization job completed.
	EndTime *time.Time

	// If the Status field is set to FAILED , the ErrorCode field indicates the reason
	// the synchronization failed.
	Error *ErrorDetail

	// The identifier of a data source synchronization job.
	ExecutionId *string

	// Maps a batch delete document request to a specific data source sync job. This
	// is optional and should only be supplied when documents are deleted by a data
	// source connector.
	Metrics *DataSourceSyncJobMetrics

	// The Unix time stamp when the data source synchronization job started.
	StartTime *time.Time

	// The status of the synchronization job. When the Status field is set to SUCCEEDED
	// , the synchronization job is done. If the status code is FAILED , the ErrorCode
	// and ErrorMessage fields give you the reason for the failure.
	Status DataSourceSyncJobStatus
	// contains filtered or unexported fields
}

Provides information about an Amazon Q Business data source connector synchronization job.

type DataSourceSyncJobMetrics 

type DataSourceSyncJobMetrics struct {

	// The current count of documents added from the data source during the data
	// source sync.
	DocumentsAdded *string

	// The current count of documents deleted from the data source during the data
	// source sync.
	DocumentsDeleted *string

	// The current count of documents that failed to sync from the data source during
	// the data source sync.
	DocumentsFailed *string

	// The current count of documents modified in the data source during the data
	// source sync.
	DocumentsModified *string

	// The current count of documents crawled by the ongoing sync job in the data
	// source.
	DocumentsScanned *string
	// contains filtered or unexported fields
}

Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.

type DataSourceSyncJobStatus 

type DataSourceSyncJobStatus string
const (
	DataSourceSyncJobStatusFailed          DataSourceSyncJobStatus = "FAILED"
	DataSourceSyncJobStatusSucceeded       DataSourceSyncJobStatus = "SUCCEEDED"
	DataSourceSyncJobStatusSyncing         DataSourceSyncJobStatus = "SYNCING"
	DataSourceSyncJobStatusIncomplete      DataSourceSyncJobStatus = "INCOMPLETE"
	DataSourceSyncJobStatusStopping        DataSourceSyncJobStatus = "STOPPING"
	DataSourceSyncJobStatusAborted         DataSourceSyncJobStatus = "ABORTED"
	DataSourceSyncJobStatusSyncingIndexing DataSourceSyncJobStatus = "SYNCING_INDEXING"
)

Enum values for DataSourceSyncJobStatus

func (DataSourceSyncJobStatus) Values 

func (DataSourceSyncJobStatus) Values() []DataSourceSyncJobStatus

Values returns all known values for DataSourceSyncJobStatus. 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 DataSourceVpcConfiguration 

type DataSourceVpcConfiguration struct {

	// A list of identifiers of security groups within your Amazon VPC. The security
	// groups should enable Amazon Q Business to connect to the data source.
	//
	// This member is required.
	SecurityGroupIds []string

	// A list of identifiers for subnets within your Amazon VPC. The subnets should be
	// able to connect to each other in the VPC, and they should have outgoing access
	// to the Internet through a NAT device.
	//
	// This member is required.
	SubnetIds []string
	// contains filtered or unexported fields
}

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

type DateAttributeBoostingConfiguration 

type DateAttributeBoostingConfiguration struct {

	// Specifies how much a document attribute is boosted.
	//
	// This member is required.
	BoostingLevel DocumentAttributeBoostingLevel

	// Specifies the duration, in seconds, of a boost applies to a DATE type document
	// attribute.
	BoostingDurationInSeconds *int64
	// contains filtered or unexported fields
}

Provides information on boosting DATE type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

type DeleteDocument 

type DeleteDocument struct {

	// The identifier of the deleted document.
	//
	// This member is required.
	DocumentId *string
	// contains filtered or unexported fields
}

A document deleted from an Amazon Q Business data source connector.

type Document 

type Document struct {

	// The identifier of the document.
	//
	// This member is required.
	Id *string

	// Configuration information for access permission to a document.
	AccessConfiguration *AccessConfiguration

	// Custom attributes to apply to the document for refining Amazon Q Business web
	// experience responses.
	Attributes []DocumentAttribute

	// The contents of the document.
	Content DocumentContent

	// The file type of the document in the Blob field.
	//
	// If you want to index snippets or subsets of HTML documents instead of the
	// entirety of the HTML documents, you add the HTML start and closing tags (
	// <HTML>content</HTML> ) around the content.
	ContentType ContentType

	// The configuration information for altering document metadata and content during
	// the document ingestion process.
	DocumentEnrichmentConfiguration *DocumentEnrichmentConfiguration

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

A document in an Amazon Q Business application.

type DocumentAttribute 

type DocumentAttribute struct {

	// The identifier for the attribute.
	//
	// This member is required.
	Name *string

	// The value of the attribute.
	//
	// This member is required.
	Value DocumentAttributeValue
	// contains filtered or unexported fields
}

A document attribute or metadata field.

type DocumentAttributeBoostingConfiguration 

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

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfigurationobject of the UpdateIndexAPI. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

The following types satisfy this interface: 

DocumentAttributeBoostingConfigurationMemberDateConfiguration
DocumentAttributeBoostingConfigurationMemberNumberConfiguration
DocumentAttributeBoostingConfigurationMemberStringConfiguration
DocumentAttributeBoostingConfigurationMemberStringListConfiguration
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.DocumentAttributeBoostingConfigurationMemberNumberConfiguration:
		_ = v.Value // Value is types.NumberAttributeBoostingConfiguration

	case *types.DocumentAttributeBoostingConfigurationMemberStringConfiguration:
		_ = v.Value // Value is types.StringAttributeBoostingConfiguration

	case *types.DocumentAttributeBoostingConfigurationMemberStringListConfiguration:
		_ = v.Value // Value is types.StringListAttributeBoostingConfiguration

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

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

	}
}

type DocumentAttributeBoostingConfigurationMemberDateConfiguration 

type DocumentAttributeBoostingConfigurationMemberDateConfiguration struct {
	Value DateAttributeBoostingConfiguration
	// contains filtered or unexported fields
}

Provides information on boosting DATE type document attributes.

type DocumentAttributeBoostingConfigurationMemberNumberConfiguration 

type DocumentAttributeBoostingConfigurationMemberNumberConfiguration struct {
	Value NumberAttributeBoostingConfiguration
	// contains filtered or unexported fields
}

Provides information on boosting NUMBER type document attributes.

type DocumentAttributeBoostingConfigurationMemberStringConfiguration 

type DocumentAttributeBoostingConfigurationMemberStringConfiguration struct {
	Value StringAttributeBoostingConfiguration
	// contains filtered or unexported fields
}

Provides information on boosting STRING type document attributes.

type DocumentAttributeBoostingConfigurationMemberStringListConfiguration 

type DocumentAttributeBoostingConfigurationMemberStringListConfiguration struct {
	Value StringListAttributeBoostingConfiguration
	// contains filtered or unexported fields
}

Provides information on boosting STRING_LIST type document attributes.

type DocumentAttributeBoostingLevel 

type DocumentAttributeBoostingLevel string
const (
	DocumentAttributeBoostingLevelNone     DocumentAttributeBoostingLevel = "NONE"
	DocumentAttributeBoostingLevelLow      DocumentAttributeBoostingLevel = "LOW"
	DocumentAttributeBoostingLevelMedium   DocumentAttributeBoostingLevel = "MEDIUM"
	DocumentAttributeBoostingLevelHigh     DocumentAttributeBoostingLevel = "HIGH"
	DocumentAttributeBoostingLevelVeryHigh DocumentAttributeBoostingLevel = "VERY_HIGH"
)

Enum values for DocumentAttributeBoostingLevel

func (DocumentAttributeBoostingLevel) Values 

func (DocumentAttributeBoostingLevel) Values() []DocumentAttributeBoostingLevel

Values returns all known values for DocumentAttributeBoostingLevel. 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 DocumentAttributeCondition 

type DocumentAttributeCondition struct {

	// The identifier of the document attribute used for the condition.
	//
	// For example, 'Source_URI' could be an identifier for the attribute or metadata
	// field that contains source URIs associated with the documents.
	//
	// Amazon Q Business currently doesn't support _document_body as an attribute key
	// used for the condition.
	//
	// This member is required.
	Key *string

	// The identifier of the document attribute used for the condition.
	//
	// For example, 'Source_URI' could be an identifier for the attribute or metadata
	// field that contains source URIs associated with the documents.
	//
	// Amazon Q Business currently does not support _document_body as an attribute key
	// used for the condition.
	//
	// This member is required.
	Operator DocumentEnrichmentConditionOperator

	// The value of a document attribute. You can only provide one value for a
	// document attribute.
	Value DocumentAttributeValue
	// contains filtered or unexported fields
}

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business then will map your newly created metadata field to your index field.

type DocumentAttributeConfiguration 

type DocumentAttributeConfiguration struct {

	// The name of the document attribute.
	Name *string

	// Information about whether the document attribute can be used by an end user to
	// search for information on their web experience.
	Search Status

	// The type of document attribute.
	Type AttributeType
	// contains filtered or unexported fields
}

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

type DocumentAttributeTarget 

type DocumentAttributeTarget struct {

	// The identifier of the target document attribute or metadata field. For example,
	// 'Department' could be an identifier for the target attribute or metadata field
	// that includes the department names associated with the documents.
	//
	// This member is required.
	Key *string

	// TRUE to delete the existing target value for your specified target attribute
	// key. You cannot create a target value and set this to TRUE .
	AttributeValueOperator AttributeValueOperator

	// The value of a document attribute. You can only provide one value for a
	// document attribute.
	Value DocumentAttributeValue
	// contains filtered or unexported fields
}

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE . This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTargetDocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeConditionDocumentAttributeCondition .

type DocumentAttributeValue 

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

The value of a document attribute. You can only provide one value for a document attribute.

The following types satisfy this interface: 

DocumentAttributeValueMemberDateValue
DocumentAttributeValueMemberLongValue
DocumentAttributeValueMemberStringListValue
DocumentAttributeValueMemberStringValue
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.DocumentAttributeValueMemberLongValue:
		_ = v.Value // Value is int64

	case *types.DocumentAttributeValueMemberStringListValue:
		_ = v.Value // Value is []string

	case *types.DocumentAttributeValueMemberStringValue:
		_ = v.Value // Value is string

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

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

	}
}

type DocumentAttributeValueMemberDateValue 

type DocumentAttributeValueMemberDateValue struct {
	Value time.Time
	// contains filtered or unexported fields
}

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

type DocumentAttributeValueMemberLongValue 

type DocumentAttributeValueMemberLongValue struct {
	Value int64
	// contains filtered or unexported fields
}

A long integer value.

type DocumentAttributeValueMemberStringListValue 

type DocumentAttributeValueMemberStringListValue struct {
	Value []string
	// contains filtered or unexported fields
}

A list of strings.

type DocumentAttributeValueMemberStringValue 

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

A string.

type DocumentContent 

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

The contents of a document.

The following types satisfy this interface: 

DocumentContentMemberBlob
DocumentContentMemberS3
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.DocumentContentMemberS3:
		_ = v.Value // Value is types.S3

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

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

	}
}

type DocumentContentMemberBlob 

type DocumentContentMemberBlob struct {
	Value []byte
	// contains filtered or unexported fields
}

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

type DocumentContentMemberS3 

type DocumentContentMemberS3 struct {
	Value S3
	// contains filtered or unexported fields
}

The path to the document in an Amazon S3 bucket.

type DocumentContentOperator 

type DocumentContentOperator string
const (
	DocumentContentOperatorDelete DocumentContentOperator = "DELETE"
)

Enum values for DocumentContentOperator

func (DocumentContentOperator) Values 

func (DocumentContentOperator) Values() []DocumentContentOperator

Values returns all known values for DocumentContentOperator. 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 DocumentDetails 

type DocumentDetails struct {

	// The timestamp for when the document was created.
	CreatedAt *time.Time

	// The identifier of the document.
	DocumentId *string

	// An error message associated with the document.
	Error *ErrorDetail

	// The current status of the document.
	Status DocumentStatus

	// The timestamp for when the document was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The details of a document within an Amazon Q Business index.

type DocumentEnrichmentConditionOperator 

type DocumentEnrichmentConditionOperator string
const (
	DocumentEnrichmentConditionOperatorGreaterThan         DocumentEnrichmentConditionOperator = "GREATER_THAN"
	DocumentEnrichmentConditionOperatorGreaterThanOrEquals DocumentEnrichmentConditionOperator = "GREATER_THAN_OR_EQUALS"
	DocumentEnrichmentConditionOperatorLessThan            DocumentEnrichmentConditionOperator = "LESS_THAN"
	DocumentEnrichmentConditionOperatorLessThanOrEquals    DocumentEnrichmentConditionOperator = "LESS_THAN_OR_EQUALS"
	DocumentEnrichmentConditionOperatorEquals              DocumentEnrichmentConditionOperator = "EQUALS"
	DocumentEnrichmentConditionOperatorNotEquals           DocumentEnrichmentConditionOperator = "NOT_EQUALS"
	DocumentEnrichmentConditionOperatorContains            DocumentEnrichmentConditionOperator = "CONTAINS"
	DocumentEnrichmentConditionOperatorNotContains         DocumentEnrichmentConditionOperator = "NOT_CONTAINS"
	DocumentEnrichmentConditionOperatorExists              DocumentEnrichmentConditionOperator = "EXISTS"
	DocumentEnrichmentConditionOperatorNotExists           DocumentEnrichmentConditionOperator = "NOT_EXISTS"
	DocumentEnrichmentConditionOperatorBeginsWith          DocumentEnrichmentConditionOperator = "BEGINS_WITH"
)

Enum values for DocumentEnrichmentConditionOperator

func (DocumentEnrichmentConditionOperator) Values 

func (DocumentEnrichmentConditionOperator) Values() []DocumentEnrichmentConditionOperator

Values returns all known values for DocumentEnrichmentConditionOperator. 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 DocumentEnrichmentConfiguration 

type DocumentEnrichmentConfiguration struct {

	// Configuration information to alter document attributes or metadata fields and
	// content when ingesting documents into Amazon Q Business.
	InlineConfigurations []InlineDocumentEnrichmentConfiguration

	// Provides the configuration information for invoking a Lambda function in Lambda
	// to alter document metadata and content when ingesting documents into Amazon Q
	// Business.
	//
	// You can configure your Lambda function using the PreExtractionHookConfiguration
	// parameter if you want to apply advanced alterations on the original or raw
	// documents.
	//
	// If you want to apply advanced alterations on the Amazon Q Business structured
	// documents, you must configure your Lambda function using
	// PostExtractionHookConfiguration .
	//
	// You can only invoke one Lambda function. However, this function can invoke
	// other functions it requires.
	//
	// For more information, see [Custom document enrichment].
	//
	// [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
	PostExtractionHookConfiguration *HookConfiguration

	// Provides the configuration information for invoking a Lambda function in Lambda
	// to alter document metadata and content when ingesting documents into Amazon Q
	// Business.
	//
	// You can configure your Lambda function using the PreExtractionHookConfiguration
	// parameter if you want to apply advanced alterations on the original or raw
	// documents.
	//
	// If you want to apply advanced alterations on the Amazon Q Business structured
	// documents, you must configure your Lambda function using
	// PostExtractionHookConfiguration .
	//
	// You can only invoke one Lambda function. However, this function can invoke
	// other functions it requires.
	//
	// For more information, see [Custom document enrichment].
	//
	// [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
	PreExtractionHookConfiguration *HookConfiguration
	// contains filtered or unexported fields
}

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

type DocumentStatus 

type DocumentStatus string
const (
	DocumentStatusReceived              DocumentStatus = "RECEIVED"
	DocumentStatusProcessing            DocumentStatus = "PROCESSING"
	DocumentStatusIndexed               DocumentStatus = "INDEXED"
	DocumentStatusUpdated               DocumentStatus = "UPDATED"
	DocumentStatusFailed                DocumentStatus = "FAILED"
	DocumentStatusDeleting              DocumentStatus = "DELETING"
	DocumentStatusDeleted               DocumentStatus = "DELETED"
	DocumentStatusDocumentFailedToIndex DocumentStatus = "DOCUMENT_FAILED_TO_INDEX"
)

Enum values for DocumentStatus

func (DocumentStatus) Values 

func (DocumentStatus) Values() []DocumentStatus

Values returns all known values for DocumentStatus. 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 EligibleDataSource 

type EligibleDataSource struct {

	// The identifier of the data source.
	DataSourceId *string

	// The identifier of the index the data source is attached to.
	IndexId *string
	// contains filtered or unexported fields
}

The identifier of the data source Amazon Q Business will generate responses from.

type EncryptionConfiguration 

type EncryptionConfiguration struct {

	// The identifier of the KMS key. Amazon Q Business doesn't support asymmetric
	// keys.
	KmsKeyId *string
	// contains filtered or unexported fields
}

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

type EndOfInputEvent 

type EndOfInputEvent struct {
	// contains filtered or unexported fields
}

The end of the streaming input for the Chat API.

type ErrorCode 

type ErrorCode string
const (
	ErrorCodeInternalError    ErrorCode = "InternalError"
	ErrorCodeInvalidRequest   ErrorCode = "InvalidRequest"
	ErrorCodeResourceInactive ErrorCode = "ResourceInactive"
	ErrorCodeResourceNotFound ErrorCode = "ResourceNotFound"
)

Enum values for ErrorCode

func (ErrorCode) Values 

func (ErrorCode) Values() []ErrorCode

Values returns all known values for ErrorCode. 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 ErrorDetail 

type ErrorDetail struct {

	// The code associated with the data source sync error.
	ErrorCode ErrorCode

	// The message explaining the data source sync error.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Provides information about a data source sync error.

type FailedAttachmentEvent 

type FailedAttachmentEvent struct {

	// The details of a file uploaded during chat.
	Attachment *AttachmentOutput

	//  The identifier of the conversation associated with the failed file upload.
	ConversationId *string

	// The identifier of the AI-generated message associated with the file upload.
	SystemMessageId *string

	// The identifier of the end user chat message associated with the file upload.
	UserMessageId *string
	// contains filtered or unexported fields
}

A failed file upload during web experience chat.

type FailedDocument 

type FailedDocument struct {

	// The identifier of the Amazon Q Business data source connector that contains the
	// failed document.
	DataSourceId *string

	// An explanation for why the document couldn't be removed from the index.
	Error *ErrorDetail

	// The identifier of the document that couldn't be removed from the Amazon Q
	// Business index.
	Id *string
	// contains filtered or unexported fields
}

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

type GroupMembers 

type GroupMembers struct {

	// A list of sub groups that belong to a group. For example, the sub groups
	// "Research", "Engineering", and "Sales and Marketing" all belong to the group
	// "Company".
	MemberGroups []MemberGroup

	// A list of users that belong to a group. For example, a list of interns all
	// belong to the "Interns" group.
	MemberUsers []MemberUser
	// contains filtered or unexported fields
}

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

type GroupStatus 

type GroupStatus string
const (
	GroupStatusFailed     GroupStatus = "FAILED"
	GroupStatusSucceeded  GroupStatus = "SUCCEEDED"
	GroupStatusProcessing GroupStatus = "PROCESSING"
	GroupStatusDeleting   GroupStatus = "DELETING"
	GroupStatusDeleted    GroupStatus = "DELETED"
)

Enum values for GroupStatus

func (GroupStatus) Values 

func (GroupStatus) Values() []GroupStatus

Values returns all known values for GroupStatus. 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 GroupStatusDetail 

type GroupStatusDetail struct {

	// The details of an error associated a group status.
	ErrorDetail *ErrorDetail

	// The Unix timestamp when the Amazon Q Business application was last updated.
	LastUpdatedAt *time.Time

	// The status of a group.
	Status GroupStatus
	// contains filtered or unexported fields
}

Provides the details of a group's status.

type GroupSummary 

type GroupSummary struct {

	// The name of the group the summary information is for.
	GroupName *string
	// contains filtered or unexported fields
}

Summary information for groups.

type HookConfiguration 

type HookConfiguration struct {

	// The condition used for when a Lambda function should be invoked.
	//
	// For example, you can specify a condition that if there are empty date-time
	// values, then Amazon Q Business should invoke a function that inserts the current
	// date-time.
	InvocationCondition *DocumentAttributeCondition

	// The Amazon Resource Name (ARN) of a role with permission to run a Lambda
	// function during ingestion. For more information, see [IAM roles for Custom Document Enrichment (CDE)].
	//
	// [IAM roles for Custom Document Enrichment (CDE)]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role
	LambdaArn *string

	// The Amazon Resource Name (ARN) of a role with permission to run
	// PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering
	// document metadata and content during the document ingestion process.
	RoleArn *string

	// Stores the original, raw documents or the structured, parsed documents before
	// and after altering them. For more information, see [Data contracts for Lambda functions].
	//
	// [Data contracts for Lambda functions]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts
	S3BucketName *string
	// contains filtered or unexported fields
}

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration .

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

type Index 

type Index struct {

	// The Unix timestamp when the index was created.
	CreatedAt *time.Time

	// The name of the index.
	DisplayName *string

	// The identifier for the index.
	IndexId *string

	// The current status of the index. When the status is ACTIVE , the index is ready.
	Status IndexStatus

	// The Unix timestamp when the index was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Summary information for your Amazon Q Business index.

type IndexCapacityConfiguration 

type IndexCapacityConfiguration struct {

	// The number of storage units configured for an Amazon Q Business index.
	Units *int32
	// contains filtered or unexported fields
}

Provides information about index capacity configuration.

type IndexStatistics 

type IndexStatistics struct {

	// The number of documents indexed.
	TextDocumentStatistics *TextDocumentStatistics
	// contains filtered or unexported fields
}

Provides information about the number of documents in an index.

type IndexStatus 

type IndexStatus string
const (
	IndexStatusCreating IndexStatus = "CREATING"
	IndexStatusActive   IndexStatus = "ACTIVE"
	IndexStatusDeleting IndexStatus = "DELETING"
	IndexStatusFailed   IndexStatus = "FAILED"
	IndexStatusUpdating IndexStatus = "UPDATING"
)

Enum values for IndexStatus

func (IndexStatus) Values 

func (IndexStatus) Values() []IndexStatus

Values returns all known values for IndexStatus. 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 IndexType 

type IndexType string
const (
	IndexTypeEnterprise IndexType = "ENTERPRISE"
	IndexTypeStarter    IndexType = "STARTER"
)

Enum values for IndexType

func (IndexType) Values 

func (IndexType) Values() []IndexType

Values returns all known values for IndexType. 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 InlineDocumentEnrichmentConfiguration 

type InlineDocumentEnrichmentConfiguration struct {

	// The condition used for the target document attribute or metadata field when
	// ingesting documents into Amazon Q Business. You use this with [DocumentAttributeTarget]
	// DocumentAttributeTarget to apply the condition.
	//
	// For example, you can create the 'Department' target field and have it prefill
	// department names associated with the documents based on information in the
	// 'Source_URI' field. Set the condition that if the 'Source_URI' field contains
	// 'financial' in its URI value, then prefill the target field 'Department' with
	// the target value 'Finance' for the document.
	//
	// Amazon Q Business can't create a target field if it has not already been
	// created as an index field. After you create your index field, you can create a
	// document metadata field using DocumentAttributeTarget . Amazon Q Business then
	// will map your newly created metadata field to your index field.
	//
	// [DocumentAttributeTarget]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
	Condition *DocumentAttributeCondition

	// TRUE to delete content if the condition used for the target attribute is met.
	DocumentContentOperator DocumentContentOperator

	// The target document attribute or metadata field you want to alter when
	// ingesting documents into Amazon Q Business.
	//
	// For example, you can delete all customer identification numbers associated with
	// the documents, stored in the document metadata field called 'Customer_ID' by
	// setting the target key as 'Customer_ID' and the deletion flag to TRUE . This
	// removes all customer ID values in the field 'Customer_ID'. This would scrub
	// personally identifiable information from each document's metadata.
	//
	// Amazon Q Business can't create a target field if it has not already been
	// created as an index field. After you create your index field, you can create a
	// document metadata field using [DocumentAttributeTarget]DocumentAttributeTarget . Amazon Q Business will
	// then map your newly created document attribute to your index field.
	//
	// You can also use this with [DocumentAttributeCondition]DocumentAttributeCondition .
	//
	// [DocumentAttributeTarget]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
	// [DocumentAttributeCondition]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
	Target *DocumentAttributeTarget
	// contains filtered or unexported fields
}

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration HookConfiguration .

For more information, see Custom document enrichment.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Supportfor help.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

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

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type KendraIndexConfiguration 

type KendraIndexConfiguration struct {

	// The identifier of the Amazon Kendra index.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

Stores an Amazon Kendra index as a retriever.

type LicenseNotFoundException 

type LicenseNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

func (*LicenseNotFoundException) Error 

func (e *LicenseNotFoundException) Error() string

func (*LicenseNotFoundException) ErrorCode 

func (e *LicenseNotFoundException) ErrorCode() string

func (*LicenseNotFoundException) ErrorFault 

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

func (*LicenseNotFoundException) ErrorMessage 

func (e *LicenseNotFoundException) ErrorMessage() string

type MemberGroup 

type MemberGroup struct {

	// The name of the sub group.
	//
	// This member is required.
	GroupName *string

	// The type of the sub group.
	Type MembershipType
	// contains filtered or unexported fields
}

The sub groups that belong to a group.

type MemberRelation 

type MemberRelation string
const (
	MemberRelationAnd MemberRelation = "AND"
	MemberRelationOr  MemberRelation = "OR"
)

Enum values for MemberRelation

func (MemberRelation) Values 

func (MemberRelation) Values() []MemberRelation

Values returns all known values for MemberRelation. 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 MemberUser 

type MemberUser struct {

	// The identifier of the user you want to map to a group.
	//
	// This member is required.
	UserId *string

	// The type of the user.
	Type MembershipType
	// contains filtered or unexported fields
}

The users that belong to a group.

type MembershipType 

type MembershipType string
const (
	MembershipTypeIndex      MembershipType = "INDEX"
	MembershipTypeDatasource MembershipType = "DATASOURCE"
)

Enum values for MembershipType

func (MembershipType) Values 

func (MembershipType) Values() []MembershipType

Values returns all known values for MembershipType. 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 Message 

type Message struct {

	// Performs an Amazon Q Business plugin action during a non-streaming chat
	// conversation.
	ActionExecution *ActionExecution

	// An output event that Amazon Q Business returns to an user who wants to perform
	// a plugin action during a non-streaming chat conversation. It contains
	// information about the selected action with a list of possible user input fields,
	// some pre-populated by Amazon Q Business.
	ActionReview *ActionReview

	// A file directly uploaded into an Amazon Q Business web experience chat.
	Attachments []AttachmentOutput

	// The content of the Amazon Q Business web experience message.
	Body *string

	// The identifier of the Amazon Q Business web experience message.
	MessageId *string

	// The source documents used to generate Amazon Q Business web experience message.
	SourceAttribution []*SourceAttribution

	// The timestamp of the first Amazon Q Business web experience message.
	Time *time.Time

	// The type of Amazon Q Business message, whether HUMAN or AI generated.
	Type MessageType
	// contains filtered or unexported fields
}

A message in an Amazon Q Business web experience.

type MessageType 

type MessageType string
const (
	MessageTypeUser   MessageType = "USER"
	MessageTypeSystem MessageType = "SYSTEM"
)

Enum values for MessageType

func (MessageType) Values 

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 MessageUsefulness 

type MessageUsefulness string
const (
	MessageUsefulnessUseful    MessageUsefulness = "USEFUL"
	MessageUsefulnessNotUseful MessageUsefulness = "NOT_USEFUL"
)

Enum values for MessageUsefulness

func (MessageUsefulness) Values 

func (MessageUsefulness) Values() []MessageUsefulness

Values returns all known values for MessageUsefulness. 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 MessageUsefulnessFeedback 

type MessageUsefulnessFeedback struct {

	// The timestamp for when the feedback was submitted.
	//
	// This member is required.
	SubmittedAt *time.Time

	// The usefulness value assigned by an end user to a message.
	//
	// This member is required.
	Usefulness MessageUsefulness

	// A comment given by an end user on the usefulness of an AI-generated chat
	// message.
	Comment *string

	// The reason for a usefulness rating.
	Reason MessageUsefulnessReason
	// contains filtered or unexported fields
}

End user feedback on an AI-generated web experience chat message usefulness.

type MessageUsefulnessReason 

type MessageUsefulnessReason string
const (
	MessageUsefulnessReasonNotFactuallyCorrect       MessageUsefulnessReason = "NOT_FACTUALLY_CORRECT"
	MessageUsefulnessReasonHarmfulOrUnsafe           MessageUsefulnessReason = "HARMFUL_OR_UNSAFE"
	MessageUsefulnessReasonIncorrectOrMissingSources MessageUsefulnessReason = "INCORRECT_OR_MISSING_SOURCES"
	MessageUsefulnessReasonNotHelpful                MessageUsefulnessReason = "NOT_HELPFUL"
	MessageUsefulnessReasonFactuallyCorrect          MessageUsefulnessReason = "FACTUALLY_CORRECT"
	MessageUsefulnessReasonComplete                  MessageUsefulnessReason = "COMPLETE"
	MessageUsefulnessReasonRelevantSources           MessageUsefulnessReason = "RELEVANT_SOURCES"
	MessageUsefulnessReasonHelpful                   MessageUsefulnessReason = "HELPFUL"
	MessageUsefulnessReasonNotBasedOnDocuments       MessageUsefulnessReason = "NOT_BASED_ON_DOCUMENTS"
	MessageUsefulnessReasonNotComplete               MessageUsefulnessReason = "NOT_COMPLETE"
	MessageUsefulnessReasonNotConcise                MessageUsefulnessReason = "NOT_CONCISE"
	MessageUsefulnessReasonOther                     MessageUsefulnessReason = "OTHER"
)

Enum values for MessageUsefulnessReason

func (MessageUsefulnessReason) Values 

func (MessageUsefulnessReason) Values() []MessageUsefulnessReason

Values returns all known values for MessageUsefulnessReason. 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 MetadataEvent 

type MetadataEvent struct {

	// The identifier of the conversation with which the generated metadata is
	// associated.
	ConversationId *string

	// The final text output message generated by the system.
	FinalTextMessage *string

	// The source documents used to generate the conversation response.
	SourceAttributions []*SourceAttribution

	// The identifier of an Amazon Q Business AI generated message within the
	// conversation.
	SystemMessageId *string

	// The identifier of an Amazon Q Business end user text input message within the
	// conversation.
	UserMessageId *string
	// contains filtered or unexported fields
}

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

type NativeIndexConfiguration 

type NativeIndexConfiguration struct {

	// The identifier for the Amazon Q Business index.
	//
	// This member is required.
	IndexId *string

	// Overrides the default boosts applied by Amazon Q Business to supported document
	// attribute data types.
	BoostingOverride map[string]DocumentAttributeBoostingConfiguration
	// contains filtered or unexported fields
}

Configuration information for an Amazon Q Business index.

type NoAuthConfiguration 

type NoAuthConfiguration struct {
	// contains filtered or unexported fields
}

Information about invoking a custom plugin without any authentication or authorization requirement.

type NumberAttributeBoostingConfiguration 

type NumberAttributeBoostingConfiguration struct {

	// Specifies the duration, in seconds, of a boost applies to a NUMBER type
	// document attribute.
	//
	// This member is required.
	BoostingLevel DocumentAttributeBoostingLevel

	// Specifies how much a document attribute is boosted.
	BoostingType NumberAttributeBoostingType
	// contains filtered or unexported fields
}

Provides information on boosting NUMBER type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

type NumberAttributeBoostingType 

type NumberAttributeBoostingType string
const (
	NumberAttributeBoostingTypePrioritizeLargerValues  NumberAttributeBoostingType = "PRIORITIZE_LARGER_VALUES"
	NumberAttributeBoostingTypePrioritizeSmallerValues NumberAttributeBoostingType = "PRIORITIZE_SMALLER_VALUES"
)

Enum values for NumberAttributeBoostingType

func (NumberAttributeBoostingType) Values 

func (NumberAttributeBoostingType) Values() []NumberAttributeBoostingType

Values returns all known values for NumberAttributeBoostingType. 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 OAuth2ClientCredentialConfiguration 

type OAuth2ClientCredentialConfiguration struct {

	// The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0
	// authentication credentials stored in a Secrets Manager secret.
	//
	// This member is required.
	RoleArn *string

	// The ARN of the Secrets Manager secret that stores the OAuth 2.0
	// credentials/token used for plugin configuration.
	//
	// This member is required.
	SecretArn *string
	// contains filtered or unexported fields
}

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

type Plugin 

type Plugin struct {

	// The status of the plugin.
	BuildStatus PluginBuildStatus

	// The timestamp for when the plugin was created.
	CreatedAt *time.Time

	// The name of the plugin.
	DisplayName *string

	// The identifier of the plugin.
	PluginId *string

	// The plugin server URL used for configuration.
	ServerUrl *string

	// The current status of the plugin.
	State PluginState

	// The type of the plugin.
	Type PluginType

	// The timestamp for when the plugin was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Information about an Amazon Q Business plugin and its configuration.

type PluginAuthConfiguration 

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

Authentication configuration information for an Amazon Q Business plugin.

The following types satisfy this interface: 

PluginAuthConfigurationMemberBasicAuthConfiguration
PluginAuthConfigurationMemberNoAuthConfiguration
PluginAuthConfigurationMemberOAuth2ClientCredentialConfiguration
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.PluginAuthConfigurationMemberNoAuthConfiguration:
		_ = v.Value // Value is types.NoAuthConfiguration

	case *types.PluginAuthConfigurationMemberOAuth2ClientCredentialConfiguration:
		_ = v.Value // Value is types.OAuth2ClientCredentialConfiguration

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

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

	}
}

type PluginAuthConfigurationMemberBasicAuthConfiguration 

type PluginAuthConfigurationMemberBasicAuthConfiguration struct {
	Value BasicAuthConfiguration
	// contains filtered or unexported fields
}

Information about the basic authentication credentials used to configure a plugin.

type PluginAuthConfigurationMemberNoAuthConfiguration 

type PluginAuthConfigurationMemberNoAuthConfiguration struct {
	Value NoAuthConfiguration
	// contains filtered or unexported fields
}

Information about invoking a custom plugin without any authentication.

type PluginAuthConfigurationMemberOAuth2ClientCredentialConfiguration 

type PluginAuthConfigurationMemberOAuth2ClientCredentialConfiguration struct {
	Value OAuth2ClientCredentialConfiguration
	// contains filtered or unexported fields
}

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

type PluginBuildStatus 

type PluginBuildStatus string
const (
	PluginBuildStatusReady            PluginBuildStatus = "READY"
	PluginBuildStatusCreateInProgress PluginBuildStatus = "CREATE_IN_PROGRESS"
	PluginBuildStatusCreateFailed     PluginBuildStatus = "CREATE_FAILED"
	PluginBuildStatusUpdateInProgress PluginBuildStatus = "UPDATE_IN_PROGRESS"
	PluginBuildStatusUpdateFailed     PluginBuildStatus = "UPDATE_FAILED"
	PluginBuildStatusDeleteInProgress PluginBuildStatus = "DELETE_IN_PROGRESS"
	PluginBuildStatusDeleteFailed     PluginBuildStatus = "DELETE_FAILED"
)

Enum values for PluginBuildStatus

func (PluginBuildStatus) Values 

func (PluginBuildStatus) Values() []PluginBuildStatus

Values returns all known values for PluginBuildStatus. 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 PluginConfiguration 

type PluginConfiguration struct {

	//  The identifier of the plugin you want to use.
	//
	// This member is required.
	PluginId *string
	// contains filtered or unexported fields
}

Configuration information required to invoke chat in PLUGIN_MODE .

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

type PluginState 

type PluginState string
const (
	PluginStateEnabled  PluginState = "ENABLED"
	PluginStateDisabled PluginState = "DISABLED"
)

Enum values for PluginState

func (PluginState) Values 

func (PluginState) Values() []PluginState

Values returns all known values for PluginState. 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 PluginType 

type PluginType string
const (
	PluginTypeServiceNow PluginType = "SERVICE_NOW"
	PluginTypeSalesforce PluginType = "SALESFORCE"
	PluginTypeJira       PluginType = "JIRA"
	PluginTypeZendesk    PluginType = "ZENDESK"
	PluginTypeCustom     PluginType = "CUSTOM"
)

Enum values for PluginType

func (PluginType) Values 

func (PluginType) Values() []PluginType

Values returns all known values for PluginType. 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 Principal 

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

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

The following types satisfy this interface: 

PrincipalMemberGroup
PrincipalMemberUser
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.PrincipalMemberUser:
		_ = v.Value // Value is types.PrincipalUser

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

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

	}
}

type PrincipalGroup 

type PrincipalGroup struct {

	// Provides information about whether to allow or deny access to the principal.
	//
	// This member is required.
	Access ReadAccessType

	// The type of group.
	MembershipType MembershipType

	// The name of the group.
	Name *string
	// contains filtered or unexported fields
}

Provides information about a group associated with the principal.

type PrincipalMemberGroup 

type PrincipalMemberGroup struct {
	Value PrincipalGroup
	// contains filtered or unexported fields
}

The group associated with the principal.

type PrincipalMemberUser 

type PrincipalMemberUser struct {
	Value PrincipalUser
	// contains filtered or unexported fields
}

The user associated with the principal.

type PrincipalUser 

type PrincipalUser struct {

	// Provides information about whether to allow or deny access to the principal.
	//
	// This member is required.
	Access ReadAccessType

	//  The identifier of the user.
	Id *string

	// The type of group.
	MembershipType MembershipType
	// contains filtered or unexported fields
}

Provides information about a user associated with a principal.

type ReadAccessType 

type ReadAccessType string
const (
	ReadAccessTypeAllow ReadAccessType = "ALLOW"
	ReadAccessTypeDeny  ReadAccessType = "DENY"
)

Enum values for ReadAccessType

func (ReadAccessType) Values 

func (ReadAccessType) Values() []ReadAccessType

Values returns all known values for ReadAccessType. 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 ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

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 ResponseScope 

type ResponseScope string
const (
	ResponseScopeEnterpriseContentOnly    ResponseScope = "ENTERPRISE_CONTENT_ONLY"
	ResponseScopeExtendedKnowledgeEnabled ResponseScope = "EXTENDED_KNOWLEDGE_ENABLED"
)

Enum values for ResponseScope

func (ResponseScope) Values 

func (ResponseScope) Values() []ResponseScope

Values returns all known values for ResponseScope. 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 Retriever 

type Retriever struct {

	// The identifier of the Amazon Q Business application using the retriever.
	ApplicationId *string

	// The name of your retriever.
	DisplayName *string

	// The identifier of the retriever used by your Amazon Q Business application.
	RetrieverId *string

	// The status of your retriever.
	Status RetrieverStatus

	// The type of your retriever.
	Type RetrieverType
	// contains filtered or unexported fields
}

Summary information for the retriever used for your Amazon Q Business application.

type RetrieverConfiguration 

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

Provides information on how the retriever used for your Amazon Q Business application is configured.

The following types satisfy this interface: 

RetrieverConfigurationMemberKendraIndexConfiguration
RetrieverConfigurationMemberNativeIndexConfiguration
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.RetrieverConfigurationMemberNativeIndexConfiguration:
		_ = v.Value // Value is types.NativeIndexConfiguration

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

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

	}
}

type RetrieverConfigurationMemberKendraIndexConfiguration 

type RetrieverConfigurationMemberKendraIndexConfiguration struct {
	Value KendraIndexConfiguration
	// contains filtered or unexported fields
}

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

type RetrieverConfigurationMemberNativeIndexConfiguration 

type RetrieverConfigurationMemberNativeIndexConfiguration struct {
	Value NativeIndexConfiguration
	// contains filtered or unexported fields
}

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

type RetrieverStatus 

type RetrieverStatus string
const (
	RetrieverStatusCreating RetrieverStatus = "CREATING"
	RetrieverStatusActive   RetrieverStatus = "ACTIVE"
	RetrieverStatusFailed   RetrieverStatus = "FAILED"
)

Enum values for RetrieverStatus

func (RetrieverStatus) Values 

func (RetrieverStatus) Values() []RetrieverStatus

Values returns all known values for RetrieverStatus. 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 RetrieverType 

type RetrieverType string
const (
	RetrieverTypeNativeIndex RetrieverType = "NATIVE_INDEX"
	RetrieverTypeKendraIndex RetrieverType = "KENDRA_INDEX"
)

Enum values for RetrieverType

func (RetrieverType) Values 

func (RetrieverType) Values() []RetrieverType

Values returns all known values for RetrieverType. 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 Rule 

type Rule struct {

	// The type of rule.
	//
	// This member is required.
	RuleType RuleType

	// Users and groups to be excluded from a rule.
	ExcludedUsersAndGroups *UsersAndGroups

	// Users and groups to be included in a rule.
	IncludedUsersAndGroups *UsersAndGroups

	// The configuration information for a rule.
	RuleConfiguration RuleConfiguration
	// contains filtered or unexported fields
}

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

type RuleConfiguration 

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

Provides configuration information about a rule.

The following types satisfy this interface: 

RuleConfigurationMemberContentBlockerRule
RuleConfigurationMemberContentRetrievalRule
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

	case *types.RuleConfigurationMemberContentRetrievalRule:
		_ = v.Value // Value is types.ContentRetrievalRule

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

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

	}
}

type RuleConfigurationMemberContentBlockerRule 

type RuleConfigurationMemberContentBlockerRule struct {
	Value ContentBlockerRule
	// contains filtered or unexported fields
}

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

type RuleConfigurationMemberContentRetrievalRule 

type RuleConfigurationMemberContentRetrievalRule struct {
	Value ContentRetrievalRule
	// contains filtered or unexported fields
}

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

type RuleType 

type RuleType string
const (
	RuleTypeContentBlockerRule   RuleType = "CONTENT_BLOCKER_RULE"
	RuleTypeContentRetrievalRule RuleType = "CONTENT_RETRIEVAL_RULE"
)

Enum values for RuleType

func (RuleType) Values 

func (RuleType) Values() []RuleType

Values returns all known values for RuleType. 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 S3 

type S3 struct {

	// The name of the S3 bucket that contains the file.
	//
	// This member is required.
	Bucket *string

	// The name of the file.
	//
	// This member is required.
	Key *string
	// contains filtered or unexported fields
}

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

type SamlConfiguration 

type SamlConfiguration struct {

	// The metadata XML that your IdP generated.
	//
	// This member is required.
	MetadataXML *string

	// The Amazon Resource Name (ARN) of an IAM role assumed by users when they
	// authenticate into their Amazon Q Business web experience, containing the
	// relevant Amazon Q Business permissions for conversing with Amazon Q Business.
	//
	// This member is required.
	RoleArn *string

	// The user attribute name in your IdP that maps to the user email.
	//
	// This member is required.
	UserIdAttribute *string

	// The group attribute name in your IdP that maps to user groups.
	UserGroupAttribute *string
	// contains filtered or unexported fields
}

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

You have exceeded the set limits for your Amazon Q Business service.

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 SnippetExcerpt 

type SnippetExcerpt struct {

	// The relevant text excerpt from a source that was used to generate a citation
	// text segment in an Amazon Q chat response.
	Text *string
	// contains filtered or unexported fields
}

Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

type SourceAttribution 

type SourceAttribution struct {

	// The number attached to a citation in an Amazon Q Business generated response.
	CitationNumber *int32

	// The content extract from the document on which the generated response is based.
	Snippet *string

	// A text extract from a source document that is used for source attribution.
	TextMessageSegments []TextSegment

	// The title of the document which is the source for the Amazon Q Business
	// generated response.
	Title *string

	// The Unix timestamp when the Amazon Q Business application was last updated.
	UpdatedAt *time.Time

	// The URL of the document which is the source for the Amazon Q Business generated
	// response.
	Url *string
	// contains filtered or unexported fields
}

The documents used to generate an Amazon Q Business web experience response.

type Status 

type Status string
const (
	StatusEnabled  Status = "ENABLED"
	StatusDisabled Status = "DISABLED"
)

Enum values for Status

func (Status) Values 

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 StringAttributeBoostingConfiguration 

type StringAttributeBoostingConfiguration struct {

	// Specifies how much a document attribute is boosted.
	//
	// This member is required.
	BoostingLevel DocumentAttributeBoostingLevel

	// Specifies specific values of a STRING type document attribute being boosted.
	AttributeValueBoosting map[string]StringAttributeValueBoostingLevel
	// contains filtered or unexported fields
}

Provides information on boosting STRING type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfigurationobject of the UpdateIndexAPI. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

type StringAttributeValueBoostingLevel 

type StringAttributeValueBoostingLevel string
const (
	StringAttributeValueBoostingLevelLow      StringAttributeValueBoostingLevel = "LOW"
	StringAttributeValueBoostingLevelMedium   StringAttributeValueBoostingLevel = "MEDIUM"
	StringAttributeValueBoostingLevelHigh     StringAttributeValueBoostingLevel = "HIGH"
	StringAttributeValueBoostingLevelVeryHigh StringAttributeValueBoostingLevel = "VERY_HIGH"
)

Enum values for StringAttributeValueBoostingLevel

func (StringAttributeValueBoostingLevel) Values 

func (StringAttributeValueBoostingLevel) Values() []StringAttributeValueBoostingLevel

Values returns all known values for StringAttributeValueBoostingLevel. 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 StringListAttributeBoostingConfiguration 

type StringListAttributeBoostingConfiguration struct {

	// Specifies how much a document attribute is boosted.
	//
	// This member is required.
	BoostingLevel DocumentAttributeBoostingLevel
	// contains filtered or unexported fields
}

Provides information on boosting STRING_LIST type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfigurationobject of the UpdateIndexAPI. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

type Tag 

type Tag struct {

	//  The key for the tag. Keys are not case sensitive and must be unique for the
	// Amazon Q Business application or data source.
	//
	// This member is required.
	Key *string

	// The value associated with the tag. The value may be an empty string but it
	// can't be null.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

type TextDocumentStatistics 

type TextDocumentStatistics struct {

	// The total size, in bytes, of the indexed documents.
	IndexedTextBytes *int64

	// The number of text documents indexed.
	IndexedTextDocumentCount *int32
	// contains filtered or unexported fields
}

Provides information about text documents in an index.

type TextInputEvent 

type TextInputEvent struct {

	// A user message in a text message input event.
	//
	// This member is required.
	UserMessage *string
	// contains filtered or unexported fields
}

An input event for a end user message in an Amazon Q Business web experience.

type TextOutputEvent 

type TextOutputEvent struct {

	// The identifier of the conversation with which the text output event is
	// associated.
	ConversationId *string

	// An AI-generated message in a TextOutputEvent .
	SystemMessage *string

	// The identifier of an AI-generated message in a TextOutputEvent .
	SystemMessageId *string

	// The identifier of an end user message in a TextOutputEvent .
	UserMessageId *string
	// contains filtered or unexported fields
}

An output event for an AI-generated response in an Amazon Q Business web experience.

type TextSegment 

type TextSegment struct {

	// The zero-based location in the response string where the source attribution
	// starts.
	BeginOffset *int32

	// The zero-based location in the response string where the source attribution
	// ends.
	EndOffset *int32

	// The relevant text excerpt from a source that was used to generate a citation
	// text segment in an Amazon Q Business chat response.
	SnippetExcerpt *SnippetExcerpt
	// contains filtered or unexported fields
}

Provides information about a text extract in a chat response that can be attributed to a source document.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to throttling. Reduce the number of requests and try again.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

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

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TopicConfiguration 

type TopicConfiguration struct {

	// A name for your topic control configuration.
	//
	// This member is required.
	Name *string

	// Rules defined for a topic configuration.
	//
	// This member is required.
	Rules []Rule

	// A description for your topic control configuration. Use this to outline how the
	// large language model (LLM) should use this topic control configuration.
	Description *string

	// A list of example phrases that you expect the end user to use in relation to
	// the topic.
	ExampleChatMessages []string
	// contains filtered or unexported fields
}

The topic specific controls configured for an Amazon Q Business application.

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 UserAlias 

type UserAlias struct {

	// The identifier of the user id associated with the user aliases.
	//
	// This member is required.
	UserId *string

	// The identifier of the data source that the user aliases are associated with.
	DataSourceId *string

	// The identifier of the index that the user aliases are associated with.
	IndexId *string
	// contains filtered or unexported fields
}

Aliases attached to a user id within an Amazon Q Business application.

type UsersAndGroups 

type UsersAndGroups struct {

	// The user groups associated with a topic control rule.
	UserGroups []string

	// The user ids associated with a topic control rule.
	UserIds []string
	// contains filtered or unexported fields
}

Provides information about users and groups associated with a topic control rule.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// contains filtered or unexported fields
}

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

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 ValidationExceptionField 

type ValidationExceptionField struct {

	// A message about the validation exception.
	//
	// This member is required.
	Message *string

	// The field name where the invalid entry was detected.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The input failed to meet the constraints specified by Amazon Q Business in a specified field.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. 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 WebExperience 

type WebExperience struct {

	// The Unix timestamp when the Amazon Q Business application was last updated.
	CreatedAt *time.Time

	// The endpoint URLs for your Amazon Q Business web experience. The URLs are
	// unique and fully hosted by Amazon Web Services.
	DefaultEndpoint *string

	// The status of your Amazon Q Business web experience.
	Status WebExperienceStatus

	// The Unix timestamp when your Amazon Q Business web experience was updated.
	UpdatedAt *time.Time

	// The identifier of your Amazon Q Business web experience.
	WebExperienceId *string
	// contains filtered or unexported fields
}

Provides information for an Amazon Q Business web experience.

type WebExperienceAuthConfiguration 

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

Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

The following types satisfy this interface: 

WebExperienceAuthConfigurationMemberSamlConfiguration
Example (OutputUsage) 
package main

import (
	"e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/qbusiness/types"
	"fmt"
)

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

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

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

	}
}

type WebExperienceAuthConfigurationMemberSamlConfiguration 

type WebExperienceAuthConfigurationMemberSamlConfiguration struct {
	Value SamlConfiguration
	// contains filtered or unexported fields
}

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

type WebExperienceSamplePromptsControlMode 

type WebExperienceSamplePromptsControlMode string
const (
	WebExperienceSamplePromptsControlModeEnabled  WebExperienceSamplePromptsControlMode = "ENABLED"
	WebExperienceSamplePromptsControlModeDisabled WebExperienceSamplePromptsControlMode = "DISABLED"
)

Enum values for WebExperienceSamplePromptsControlMode

func (WebExperienceSamplePromptsControlMode) Values 

func (WebExperienceSamplePromptsControlMode) Values() []WebExperienceSamplePromptsControlMode

Values returns all known values for WebExperienceSamplePromptsControlMode. 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 WebExperienceStatus 

type WebExperienceStatus string
const (
	WebExperienceStatusCreating          WebExperienceStatus = "CREATING"
	WebExperienceStatusActive            WebExperienceStatus = "ACTIVE"
	WebExperienceStatusDeleting          WebExperienceStatus = "DELETING"
	WebExperienceStatusFailed            WebExperienceStatus = "FAILED"
	WebExperienceStatusPendingAuthConfig WebExperienceStatus = "PENDING_AUTH_CONFIG"
)

Enum values for WebExperienceStatus

func (WebExperienceStatus) Values 

func (WebExperienceStatus) Values() []WebExperienceStatus

Values returns all known values for WebExperienceStatus. 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

  • enums.go
  • errors.go
  • types.go

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.