Package software.amazon.awssdk.services.qbusiness.model
package software.amazon.awssdk.services.qbusiness.model
-
ClassDescriptionUsed to configure access permissions for a document.A list of principals.You don't have access to perform this action.Performs an Amazon Q Business plugin action during a non-streaming chat conversation.A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.A user input field in an plugin action execution payload.An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation.An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation.A user input field in an plugin action review payload.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.Contains details about the OpenAPI schema for a custom plugin.Summary information for an Amazon Q Business application.Configuration information about the file upload during chat feature for your application.The creator mode specific admin controls configured for an Amazon Q Business application.A file directly uploaded into a web experience chat.A file input event activated by a end user request to upload files into their web experience chat.The details of a file uploaded during chat.Configuration information for the file upload during chat feature.Enables filtering of responses based on document attributes or metadata fields.A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.An authentication verification event activated by an end user request to use a custom plugin.Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.An authentication verification event response by a third party authentication server to Amazon Q Business.Information about the basic authentication credentials used to configure a plugin.Provides information about the phrases blocked from chat by your chat control configuration.Updates a blocked phrases configuration in your Amazon Q Business application.Base interface for all event types in ChatInputStream.The known possible types of events for
ChatInputStream
.Configuration information for Amazon Q Business conversation modes.Base interface for all event types in ChatOutputStream.The known possible types of events forChatOutputStream
.Response handler for the Chat API.Builder forChatResponseHandler
.Visitor for subtypes ofChatOutputStream
.Builder forChatResponseHandler.Visitor
.A configuration event activated by an end user request to select a specific chat mode.You are trying to perform an action that conflicts with the current status of your resource.A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.A conversation in an Amazon Q Business application.Configuration information required to invoke chat inCREATOR_MODE
.Configuration information required to create a custom plugin.A data source in an Amazon Q Business application.Provides information about an Amazon Q Business data source connector synchronization job.Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).Provides information on boostingDATE
type document attributes.A document deleted from an Amazon Q Business data source connector.A document in an Amazon Q Business application.A document attribute or metadata field.Provides information on boosting supported Amazon Q Business document attribute types.The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.Configuration information for document attributes.The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.The value of a document attribute.The contents of a document.The details of a document within an Amazon Q Business index.Provides the configuration information for altering document metadata and content during the document ingestion process.The identifier of the data source Amazon Q Business will generate responses from.Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business.The end of the streaming input for theChat
API.Provides information about a data source sync error.A failed file upload during web experience chat.A list of documents that could not be removed from an Amazon Q Business index.A list of users or sub groups that belong to a group.Provides the details of a group's status.Summary information for groups.Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.Summary information for your Amazon Q Business index.Provides information about index capacity configuration.Provides information about the number of documents in an index.Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.An issue occurred with the internal server used for your Amazon Q Business service.Stores an Amazon Kendra index as a retriever.You don't have permissions to perform the action because your license is inactive.The sub groups that belong to a group.The users that belong to a group.A message in an Amazon Q Business web experience.End user feedback on an AI-generated web experience chat message usefulness.A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.Configuration information for an Amazon Q Business index.Information about invoking a custom plugin without any authentication or authorization requirement.Provides information on boostingNUMBER
type document attributes.Information about the OAuth 2.0 authentication credential/token used to configure a plugin.Information about an Amazon Q Business plugin and its configuration.Authentication configuration information for an Amazon Q Business plugin.Configuration information required to invoke chat inPLUGIN_MODE
.Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.Provides information about a group associated with the principal.Provides information about a user associated with a principal.The resource you want to use doesn’t exist.Summary information for the retriever used for your Amazon Q Business application.Provides information on how the retriever used for your Amazon Q Business application is configured.Guardrail rules for an Amazon Q Business application.Provides configuration information about a rule.Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.You have exceeded the set limits for your Amazon Q Business service.Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.The documents used to generate an Amazon Q Business web experience response.Provides information on boostingSTRING
type document attributes.Provides information on boostingSTRING_LIST
type document attributes.A list of key/value pairs that identify an index, FAQ, or data source.Provides information about text documents in an index.An input event for a end user message in an Amazon Q Business web experience.An output event for an AI-generated response in an Amazon Q Business web experience.Provides information about a text extract in a chat response that can be attributed to a source document.The request was denied due to throttling.The topic specific controls configured for an Amazon Q Business application.Aliases attached to a user id within an Amazon Q Business application.Provides information about users and groups associated with a topic control rule.The input doesn't meet the constraints set by the Amazon Q Business service.The input failed to meet the constraints specified by Amazon Q Business in a specified field.Provides information for an Amazon Q Business web experience.Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.