2025/07/01 - QBusiness - 5 new3 updated api methods
Changes New ChatResponseConfiguration to Customize Q Business chat responses for specific use cases and communication needs. Updated Boosting capability allowing admins to provide preference on date attributes for recency and/or provide a preferred data source.
Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.
See also: AWS API Documentation
Request Syntax
client.list_chat_response_configurations(
applicationId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application for which to list available chat response configurations.
integer
The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.
string
A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.
dict
Response Syntax
{
'chatResponseConfigurations': [
{
'chatResponseConfigurationId': 'string',
'chatResponseConfigurationArn': 'string',
'displayName': 'string',
'responseConfigurationSummary': 'string',
'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
chatResponseConfigurations (list) --
A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.
(dict) --
Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.
chatResponseConfigurationId (string) --
A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.
chatResponseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.
displayName (string) --
A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.
responseConfigurationSummary (string) --
A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.
status (string) --
The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.
createdAt (datetime) --
The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.
updatedAt (datetime) --
The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.
nextToken (string) --
A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the maxResults parameter.
Deletes a specified chat response configuration from an Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.delete_chat_response_configuration(
applicationId='string',
chatResponseConfigurationId='string'
)
string
[REQUIRED]
The unique identifier of theAmazon Q Business application from which to delete the chat response configuration.
string
[REQUIRED]
The unique identifier of the chat response configuration to delete from the specified application.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
See also: AWS API Documentation
Request Syntax
client.create_chat_response_configuration(
applicationId='string',
displayName='string',
clientToken='string',
responseConfigurations={
'string': {
'instructionCollection': {
'responseLength': 'string',
'targetAudience': 'string',
'perspective': 'string',
'outputStyle': 'string',
'identity': 'string',
'tone': 'string',
'customInstructions': 'string',
'examples': 'string'
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
string
[REQUIRED]
A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
string
A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.
This field is autopopulated if not provided.
dict
[REQUIRED]
A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.
(string) --
(dict) --
Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
instructionCollection (dict) --
A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.
responseLength (string) --
Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
targetAudience (string) --
Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
perspective (string) --
Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
outputStyle (string) --
Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
identity (string) --
Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
tone (string) --
Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
customInstructions (string) --
Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
examples (string) --
Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
list
A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.
(dict) --
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: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
dict
Response Syntax
{
'chatResponseConfigurationId': 'string',
'chatResponseConfigurationArn': 'string'
}
Response Structure
(dict) --
chatResponseConfigurationId (string) --
The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.
chatResponseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
See also: AWS API Documentation
Request Syntax
client.get_chat_response_configuration(
applicationId='string',
chatResponseConfigurationId='string'
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.
string
[REQUIRED]
The unique identifier of the chat response configuration to retrieve from the specified application.
dict
Response Syntax
{
'chatResponseConfigurationId': 'string',
'chatResponseConfigurationArn': 'string',
'displayName': 'string',
'createdAt': datetime(2015, 1, 1),
'inUseConfiguration': {
'responseConfigurations': {
'string': {
'instructionCollection': {
'responseLength': 'string',
'targetAudience': 'string',
'perspective': 'string',
'outputStyle': 'string',
'identity': 'string',
'tone': 'string',
'customInstructions': 'string',
'examples': 'string'
}
}
},
'responseConfigurationSummary': 'string',
'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'updatedAt': datetime(2015, 1, 1)
},
'lastUpdateConfiguration': {
'responseConfigurations': {
'string': {
'instructionCollection': {
'responseLength': 'string',
'targetAudience': 'string',
'perspective': 'string',
'outputStyle': 'string',
'identity': 'string',
'tone': 'string',
'customInstructions': 'string',
'examples': 'string'
}
}
},
'responseConfigurationSummary': 'string',
'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
chatResponseConfigurationId (string) --
The unique identifier of the retrieved chat response configuration.
chatResponseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
displayName (string) --
The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.
createdAt (datetime) --
The timestamp indicating when the chat response configuration was initially created.
inUseConfiguration (dict) --
The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.
responseConfigurations (dict) --
A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.
(string) --
(dict) --
Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
instructionCollection (dict) --
A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.
responseLength (string) --
Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
targetAudience (string) --
Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
perspective (string) --
Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
outputStyle (string) --
Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
identity (string) --
Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
tone (string) --
Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
customInstructions (string) --
Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
examples (string) --
Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
responseConfigurationSummary (string) --
A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.
status (string) --
The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.
error (dict) --
Provides information about a Amazon Q Business request error.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
updatedAt (datetime) --
The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.
lastUpdateConfiguration (dict) --
Information about the most recent update to the configuration, including timestamp and modification details.
responseConfigurations (dict) --
A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.
(string) --
(dict) --
Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
instructionCollection (dict) --
A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.
responseLength (string) --
Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
targetAudience (string) --
Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
perspective (string) --
Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
outputStyle (string) --
Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
identity (string) --
Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
tone (string) --
Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
customInstructions (string) --
Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
examples (string) --
Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
responseConfigurationSummary (string) --
A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.
status (string) --
The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.
error (dict) --
Provides information about a Amazon Q Business request error.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
updatedAt (datetime) --
The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.
Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.
See also: AWS API Documentation
Request Syntax
client.update_chat_response_configuration(
applicationId='string',
chatResponseConfigurationId='string',
displayName='string',
responseConfigurations={
'string': {
'instructionCollection': {
'responseLength': 'string',
'targetAudience': 'string',
'perspective': 'string',
'outputStyle': 'string',
'identity': 'string',
'tone': 'string',
'customInstructions': 'string',
'examples': 'string'
}
}
},
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application containing the chat response configuration to update.
string
[REQUIRED]
The unique identifier of the chat response configuration to update within the specified application.
string
The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.
dict
[REQUIRED]
The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.
(string) --
(dict) --
Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
instructionCollection (dict) --
A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.
responseLength (string) --
Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
targetAudience (string) --
Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
perspective (string) --
Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
outputStyle (string) --
Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
identity (string) --
Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
tone (string) --
Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
customInstructions (string) --
Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
examples (string) --
Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
string
A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
{'configuration': {'nativeIndexConfiguration': {'boostingOverride': {'dateConfiguration': {'boostingLevel': {'ONE',
'TWO'}},
'numberConfiguration': {'boostingLevel': {'ONE',
'TWO'}},
'stringConfiguration': {'attributeValueBoosting': {'FIVE',
'FOUR',
'ONE',
'THREE',
'TWO'},
'boostingLevel': {'ONE',
'TWO'}},
'stringListConfiguration': {'boostingLevel': {'ONE',
'TWO'}}},
'version': 'long'}}}
Adds a retriever to your Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.create_retriever(
applicationId='string',
type='NATIVE_INDEX'|'KENDRA_INDEX',
displayName='string',
configuration={
'nativeIndexConfiguration': {
'indexId': 'string',
'version': 123,
'boostingOverride': {
'string': {
'numberConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES'
},
'stringConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'attributeValueBoosting': {
'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'|'THREE'|'FOUR'|'FIVE'
}
},
'dateConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'boostingDurationInSeconds': 123
},
'stringListConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'
}
}
}
},
'kendraIndexConfiguration': {
'indexId': 'string'
}
},
roleArn='string',
clientToken='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The identifier of your Amazon Q Business application.
string
[REQUIRED]
The type of retriever you are using.
string
[REQUIRED]
The name of your retriever.
dict
[REQUIRED]
Provides information on how the retriever used for your Amazon Q Business application is configured.
nativeIndexConfiguration (dict) --
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
indexId (string) -- [REQUIRED]
The identifier for the Amazon Q Business index.
version (integer) --
A read-only field that specifies the version of the NativeIndexConfiguration.
Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:
Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting
Version 2 supports a single String field with an ordered list of up to 5 values
Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels
Version 2 allows specifying prioritization between Date and String fields
Version 2 maintains backward compatibility with existing configurations
boostingOverride (dict) --
Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
(string) --
(dict) --
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.
In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
numberConfiguration (dict) --
Provides information on boosting NUMBER type document attributes.
NUMBER attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
boostingLevel (string) -- [REQUIRED]
Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
boostingType (string) --
Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).
stringConfiguration (dict) --
Provides information on boosting STRING type document attributes.
Version 2 assigns priority tiers to STRING attributes, establishing clear hierarchical relationships with other boosted attributes.
boostingLevel (string) -- [REQUIRED]
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
attributeValueBoosting (dict) --
Specifies specific values of a STRING type document attribute being boosted. When using NativeIndexConfiguration version 2, you can specify up to five values in order of priority.
(string) --
(string) --
dateConfiguration (dict) --
Provides information on boosting DATE type document attributes.
Version 2 assigns priority tiers to DATE attributes, establishing clear hierarchical relationships with other boosted attributes.
boostingLevel (string) -- [REQUIRED]
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
boostingDurationInSeconds (integer) --
Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
stringListConfiguration (dict) --
Provides information on boosting STRING_LIST type document attributes.
STRING_LIST attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
boostingLevel (string) -- [REQUIRED]
Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
kendraIndexConfiguration (dict) --
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
indexId (string) -- [REQUIRED]
The identifier of the Amazon Kendra index.
string
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
string
A token that you provide to identify the request to create your Amazon Q Business application retriever.
This field is autopopulated if not provided.
list
A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
(dict) --
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: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
dict
Response Syntax
{
'retrieverId': 'string',
'retrieverArn': 'string'
}
Response Structure
(dict) --
retrieverId (string) --
The identifier of the retriever you are using.
retrieverArn (string) --
The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
{'configuration': {'nativeIndexConfiguration': {'boostingOverride': {'dateConfiguration': {'boostingLevel': {'ONE',
'TWO'}},
'numberConfiguration': {'boostingLevel': {'ONE',
'TWO'}},
'stringConfiguration': {'attributeValueBoosting': {'FIVE',
'FOUR',
'ONE',
'THREE',
'TWO'},
'boostingLevel': {'ONE',
'TWO'}},
'stringListConfiguration': {'boostingLevel': {'ONE',
'TWO'}}},
'version': 'long'}}}
Gets information about an existing retriever used by an Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.get_retriever(
applicationId='string',
retrieverId='string'
)
string
[REQUIRED]
The identifier of the Amazon Q Business application using the retriever.
string
[REQUIRED]
The identifier of the retriever.
dict
Response Syntax
{
'applicationId': 'string',
'retrieverId': 'string',
'retrieverArn': 'string',
'type': 'NATIVE_INDEX'|'KENDRA_INDEX',
'status': 'CREATING'|'ACTIVE'|'FAILED',
'displayName': 'string',
'configuration': {
'nativeIndexConfiguration': {
'indexId': 'string',
'version': 123,
'boostingOverride': {
'string': {
'numberConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES'
},
'stringConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'attributeValueBoosting': {
'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'|'THREE'|'FOUR'|'FIVE'
}
},
'dateConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'boostingDurationInSeconds': 123
},
'stringListConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'
}
}
}
},
'kendraIndexConfiguration': {
'indexId': 'string'
}
},
'roleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
applicationId (string) --
The identifier of the Amazon Q Business application using the retriever.
retrieverId (string) --
The identifier of the retriever.
retrieverArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
type (string) --
The type of the retriever.
status (string) --
The status of the retriever.
displayName (string) --
The name of the retriever.
configuration (dict) --
Provides information on how the retriever used for your Amazon Q Business application is configured.
nativeIndexConfiguration (dict) --
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
indexId (string) --
The identifier for the Amazon Q Business index.
version (integer) --
A read-only field that specifies the version of the NativeIndexConfiguration.
Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:
Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting
Version 2 supports a single String field with an ordered list of up to 5 values
Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels
Version 2 allows specifying prioritization between Date and String fields
Version 2 maintains backward compatibility with existing configurations
boostingOverride (dict) --
Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
(string) --
(dict) --
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.
In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
numberConfiguration (dict) --
Provides information on boosting NUMBER type document attributes.
NUMBER attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
boostingLevel (string) --
Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
boostingType (string) --
Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).
stringConfiguration (dict) --
Provides information on boosting STRING type document attributes.
Version 2 assigns priority tiers to STRING attributes, establishing clear hierarchical relationships with other boosted attributes.
boostingLevel (string) --
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
attributeValueBoosting (dict) --
Specifies specific values of a STRING type document attribute being boosted. When using NativeIndexConfiguration version 2, you can specify up to five values in order of priority.
(string) --
(string) --
dateConfiguration (dict) --
Provides information on boosting DATE type document attributes.
Version 2 assigns priority tiers to DATE attributes, establishing clear hierarchical relationships with other boosted attributes.
boostingLevel (string) --
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
boostingDurationInSeconds (integer) --
Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
stringListConfiguration (dict) --
Provides information on boosting STRING_LIST type document attributes.
STRING_LIST attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
boostingLevel (string) --
Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
kendraIndexConfiguration (dict) --
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
indexId (string) --
The identifier of the Amazon Kendra index.
roleArn (string) --
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
createdAt (datetime) --
The Unix timestamp when the retriever was created.
updatedAt (datetime) --
The Unix timestamp when the retriever was last updated.
{'configuration': {'nativeIndexConfiguration': {'boostingOverride': {'dateConfiguration': {'boostingLevel': {'ONE',
'TWO'}},
'numberConfiguration': {'boostingLevel': {'ONE',
'TWO'}},
'stringConfiguration': {'attributeValueBoosting': {'FIVE',
'FOUR',
'ONE',
'THREE',
'TWO'},
'boostingLevel': {'ONE',
'TWO'}},
'stringListConfiguration': {'boostingLevel': {'ONE',
'TWO'}}},
'version': 'long'}}}
Updates the retriever used for your Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.update_retriever(
applicationId='string',
retrieverId='string',
configuration={
'nativeIndexConfiguration': {
'indexId': 'string',
'version': 123,
'boostingOverride': {
'string': {
'numberConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES'
},
'stringConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'attributeValueBoosting': {
'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'|'THREE'|'FOUR'|'FIVE'
}
},
'dateConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO',
'boostingDurationInSeconds': 123
},
'stringListConfiguration': {
'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'
}
}
}
},
'kendraIndexConfiguration': {
'indexId': 'string'
}
},
displayName='string',
roleArn='string'
)
string
[REQUIRED]
The identifier of your Amazon Q Business application.
string
[REQUIRED]
The identifier of your retriever.
dict
Provides information on how the retriever used for your Amazon Q Business application is configured.
nativeIndexConfiguration (dict) --
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
indexId (string) -- [REQUIRED]
The identifier for the Amazon Q Business index.
version (integer) --
A read-only field that specifies the version of the NativeIndexConfiguration.
Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:
Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting
Version 2 supports a single String field with an ordered list of up to 5 values
Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels
Version 2 allows specifying prioritization between Date and String fields
Version 2 maintains backward compatibility with existing configurations
boostingOverride (dict) --
Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
(string) --
(dict) --
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.
In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
numberConfiguration (dict) --
Provides information on boosting NUMBER type document attributes.
NUMBER attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
boostingLevel (string) -- [REQUIRED]
Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
boostingType (string) --
Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).
stringConfiguration (dict) --
Provides information on boosting STRING type document attributes.
Version 2 assigns priority tiers to STRING attributes, establishing clear hierarchical relationships with other boosted attributes.
boostingLevel (string) -- [REQUIRED]
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
attributeValueBoosting (dict) --
Specifies specific values of a STRING type document attribute being boosted. When using NativeIndexConfiguration version 2, you can specify up to five values in order of priority.
(string) --
(string) --
dateConfiguration (dict) --
Provides information on boosting DATE type document attributes.
Version 2 assigns priority tiers to DATE attributes, establishing clear hierarchical relationships with other boosted attributes.
boostingLevel (string) -- [REQUIRED]
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
boostingDurationInSeconds (integer) --
Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
stringListConfiguration (dict) --
Provides information on boosting STRING_LIST type document attributes.
STRING_LIST attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
boostingLevel (string) -- [REQUIRED]
Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
kendraIndexConfiguration (dict) --
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
indexId (string) -- [REQUIRED]
The identifier of the Amazon Kendra index.
string
The name of your retriever.
string
The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
dict
Response Syntax
{}
Response Structure
(dict) --