View Source AWS.QBusiness (aws-elixir v0.14.1)
Amazon Q is in preview release and is subject to change.
This is the Amazon Q (for business use) API Reference. Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q (for business use) Developer Guide .
For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q in the Amazon Q (for business use) Developer Guide.
You can use the following AWS SDKs to access Amazon Q APIs:
The following resources provide additional information about using the Amazon Q API:
Summary
Functions
Asynchronously deletes one or more documents added using the BatchPutDocument
API from an Amazon Q index.
Adds one or more documents to an Amazon Q index.
Starts or continues a non-streaming Amazon Q conversation.
Creates an Amazon Q application.
Creates an Amazon Q index.
Creates an Amazon Q plugin.
Adds a retriever to your Amazon Q application.
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Creates an Amazon Q web experience.
Deletes an Amazon Q application.
Deletes chat controls configured for an existing Amazon Q application.
Deletes an Amazon Q web experience conversation.
Deletes an Amazon Q data source connector.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
Deletes an Amazon Q index.
Deletes an Amazon Q plugin.
Deletes the retriever used by an Amazon Q application.
Deletes a user by email id.
Deletes an Amazon Q web experience.
Gets information about an existing Amazon Q application.
Gets information about an chat controls configured for an existing Amazon Q application.
Gets information about an existing Amazon Q data source connector.
Describes a group by group name.
Gets information about an existing Amazon Q index.
Gets information about an existing Amazon Q plugin.
Gets information about an existing retriever used by an Amazon Q application.
Describes the universally unique identifier (UUID) associated with a local user in a data source.
Gets information about an existing Amazon Q web experience.
Lists Amazon Q applications.
Lists one or more Amazon Q conversations.
Get information about an Amazon Q data source connector synchronization.
Lists the Amazon Q data source connectors that you have created.
A list of documents attached to an index.
Provides a list of groups that are mapped to users.
Lists the Amazon Q indices you have created.
Gets a list of messages associated with an Amazon Q web experience.
Lists configured Amazon Q plugins.
Lists the retriever used by an Amazon Q application.
Gets a list of tags associated with a specified resource.
Lists one or more Amazon Q Web Experiences.
Enables your end user to to provide feedback on their Amazon Q generated chat responses.
Create, or updates, a mapping of users—who have access to a document—to groups.
Starts a data source connector synchronization job.
Stops an Amazon Q data source connector synchronization job already in progress.
Adds the specified tag to the specified Amazon Q application or data source resource.
Removes a tag from an Amazon Q application or a data source.
Updates an existing Amazon Q application.
Updates an set of chat controls configured for an existing Amazon Q application.
Updates an existing Amazon Q data source connector.
Updates an Amazon Q index.
Updates an Amazon Q plugin.
Updates the retriever used for your Amazon Q application.
Updates a information associated with a user id.
Updates an Amazon Q web experience.
Functions
batch_delete_document(client, application_id, index_id, input, options \\ [])
View SourceAsynchronously deletes one or more documents added using the BatchPutDocument
API from an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
batch_put_document(client, application_id, index_id, input, options \\ [])
View SourceAdds one or more documents to an Amazon Q index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.
add custom attributes to documents in an Amazon Q index.
attach an access control list to the documents added to an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Starts or continues a non-streaming Amazon Q conversation.
Creates an Amazon Q application.
Creates an Amazon Q index.
To determine if index creation has completed, check the Status
field returned
from a call to DescribeIndex
. The Status
field is set to ACTIVE
when the
index is ready to use.
Once the index is active, you can index your documents using the
BatchPutDocument
API or the CreateDataSource
API.
Creates an Amazon Q plugin.
Adds a retriever to your Amazon Q application.
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
create_web_experience(client, application_id, input, options \\ [])
View SourceCreates an Amazon Q web experience.
Deletes an Amazon Q application.
delete_chat_controls_configuration(client, application_id, input, options \\ [])
View SourceDeletes chat controls configured for an existing Amazon Q application.
delete_conversation(client, application_id, conversation_id, input, options \\ [])
View SourceDeletes an Amazon Q web experience conversation.
delete_data_source(client, application_id, data_source_id, index_id, input, options \\ [])
View SourceDeletes an Amazon Q data source connector.
While the data source is being deleted, the Status
field returned by a call to
the DescribeDataSource
API is set to DELETING
.
delete_group(client, application_id, group_name, index_id, input, options \\ [])
View SourceDeletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.
If you want to delete, update, or replace users or sub groups of a group, you
need to use the PutGroup
operation. For example, if a user in the group
"Engineering" leaves the engineering team and another user takes their place,
you provide an updated list of users or sub groups that belong to the
"Engineering" group when calling PutGroup
.
delete_index(client, application_id, index_id, input, options \\ [])
View SourceDeletes an Amazon Q index.
delete_plugin(client, application_id, plugin_id, input, options \\ [])
View SourceDeletes an Amazon Q plugin.
delete_retriever(client, application_id, retriever_id, input, options \\ [])
View SourceDeletes the retriever used by an Amazon Q application.
delete_user(client, application_id, user_id, input, options \\ [])
View SourceDeletes a user by email id.
delete_web_experience(client, application_id, web_experience_id, input, options \\ [])
View SourceDeletes an Amazon Q web experience.
Gets information about an existing Amazon Q application.
get_chat_controls_configuration(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets information about an chat controls configured for an existing Amazon Q application.
get_data_source(client, application_id, data_source_id, index_id, options \\ [])
View SourceGets information about an existing Amazon Q data source connector.
get_group(client, application_id, group_name, index_id, data_source_id \\ nil, options \\ [])
View SourceDescribes a group by group name.
Gets information about an existing Amazon Q index.
Gets information about an existing Amazon Q plugin.
get_retriever(client, application_id, retriever_id, options \\ [])
View SourceGets information about an existing retriever used by an Amazon Q application.
Describes the universally unique identifier (UUID) associated with a local user in a data source.
get_web_experience(client, application_id, web_experience_id, options \\ [])
View SourceGets information about an existing Amazon Q web experience.
list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists Amazon Q applications.
list_conversations(client, application_id, max_results \\ nil, next_token \\ nil, user_id, options \\ [])
View SourceLists one or more Amazon Q conversations.
list_data_source_sync_jobs(client, application_id, data_source_id, index_id, end_time \\ nil, max_results \\ nil, next_token \\ nil, start_time \\ nil, status_filter \\ nil, options \\ [])
View SourceGet information about an Amazon Q data source connector synchronization.
list_data_sources(client, application_id, index_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Amazon Q data source connectors that you have created.
list_documents(client, application_id, index_id, data_source_ids \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceA list of documents attached to an index.
list_groups(client, application_id, index_id, data_source_id \\ nil, max_results \\ nil, next_token \\ nil, updated_earlier_than, options \\ [])
View SourceProvides a list of groups that are mapped to users.
list_indices(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Amazon Q indices you have created.
list_messages(client, application_id, conversation_id, max_results \\ nil, next_token \\ nil, user_id, options \\ [])
View SourceGets a list of messages associated with an Amazon Q web experience.
list_plugins(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists configured Amazon Q plugins.
list_retrievers(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the retriever used by an Amazon Q application.
Gets a list of tags associated with a specified resource.
Amazon Q applications and data sources can have tags associated with them.
list_web_experiences(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists one or more Amazon Q Web Experiences.
put_feedback(client, application_id, conversation_id, message_id, input, options \\ [])
View SourceEnables your end user to to provide feedback on their Amazon Q generated chat responses.
Create, or updates, a mapping of users—who have access to a document—to groups.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q chat results.
start_data_source_sync_job(client, application_id, data_source_id, index_id, input, options \\ [])
View SourceStarts a data source connector synchronization job.
If a synchronization job is already in progress, Amazon Q returns a
ConflictException
.
stop_data_source_sync_job(client, application_id, data_source_id, index_id, input, options \\ [])
View SourceStops an Amazon Q data source connector synchronization job already in progress.
Adds the specified tag to the specified Amazon Q application or data source resource.
If the tag already exists, the existing value is replaced with the new value.
Removes a tag from an Amazon Q application or a data source.
Updates an existing Amazon Q application.
update_chat_controls_configuration(client, application_id, input, options \\ [])
View SourceUpdates an set of chat controls configured for an existing Amazon Q application.
update_data_source(client, application_id, data_source_id, index_id, input, options \\ [])
View SourceUpdates an existing Amazon Q data source connector.
update_index(client, application_id, index_id, input, options \\ [])
View SourceUpdates an Amazon Q index.
update_plugin(client, application_id, plugin_id, input, options \\ [])
View SourceUpdates an Amazon Q plugin.
update_retriever(client, application_id, retriever_id, input, options \\ [])
View SourceUpdates the retriever used for your Amazon Q application.
update_user(client, application_id, user_id, input, options \\ [])
View SourceUpdates a information associated with a user id.
update_web_experience(client, application_id, web_experience_id, input, options \\ [])
View SourceUpdates an Amazon Q web experience.