Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
retrieve¶
Description¶
Retrieves content from knowledge sources based on a query.
See also: AWS API Documentation
retrieve uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.
Synopsis¶
retrieve
--assistant-id <value>
--retrieval-configuration <value>
--retrieval-query <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--assistant-id (string)
The identifier of the Amazon Q in Connect assistant for content retrieval.
--retrieval-configuration (structure)
The configuration for the content retrieval operation.
knowledgeSource -> (tagged union structure)
The knowledge source configuration for content retrieval.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:assistantAssociationIds.assistantAssociationIds -> (list)
The list of assistant association identifiers for the knowledge source.
(string)
filter -> (tagged union structure)
The filter configuration for content retrieval.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:andAll,equals,greaterThan,greaterThanOrEquals,in,lessThan,lessThanOrEquals,listContains,notEquals,notIn,orAll,startsWith,stringContains.andAll -> (list)
Filter configuration that requires all conditions to be met.
(tagged union structure)
Configuration for filtering content during retrieval operations.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:andAll,equals,greaterThan,greaterThanOrEquals,in,lessThan,lessThanOrEquals,listContains,notEquals,notIn,orAll,startsWith,stringContains.andAll -> (list)
Filter configuration that requires all conditions to be met.
( … recursive … )
equals -> (structure)
Filter configuration for exact equality matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.greaterThan -> (structure)
Filter configuration for greater than comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.greaterThanOrEquals -> (structure)
Filter configuration for greater than or equal comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.in -> (structure)
Filter configuration for membership in a set of values.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.lessThan -> (structure)
Filter configuration for less than comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.lessThanOrEquals -> (structure)
Filter configuration for less than or equal comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.listContains -> (structure)
Filter configuration for checking if a list contains a value.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.notEquals -> (structure)
Filter configuration for inequality matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.notIn -> (structure)
Filter configuration for exclusion from a set of values.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.orAll -> (list)
Filter configuration where any condition can be met.
( … recursive … )
startsWith -> (structure)
Filter configuration for prefix matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.stringContains -> (structure)
Filter configuration for substring matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.equals -> (structure)
Filter configuration for exact equality matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.greaterThan -> (structure)
Filter configuration for greater than comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.greaterThanOrEquals -> (structure)
Filter configuration for greater than or equal comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.in -> (structure)
Filter configuration for membership in a set of values.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.lessThan -> (structure)
Filter configuration for less than comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.lessThanOrEquals -> (structure)
Filter configuration for less than or equal comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.listContains -> (structure)
Filter configuration for checking if a list contains a value.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.notEquals -> (structure)
Filter configuration for inequality matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.notIn -> (structure)
Filter configuration for exclusion from a set of values.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.orAll -> (list)
Filter configuration where any condition can be met.
(tagged union structure)
Configuration for filtering content during retrieval operations.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:andAll,equals,greaterThan,greaterThanOrEquals,in,lessThan,lessThanOrEquals,listContains,notEquals,notIn,orAll,startsWith,stringContains.andAll -> (list)
Filter configuration that requires all conditions to be met.
( … recursive … )
equals -> (structure)
Filter configuration for exact equality matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.greaterThan -> (structure)
Filter configuration for greater than comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.greaterThanOrEquals -> (structure)
Filter configuration for greater than or equal comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.in -> (structure)
Filter configuration for membership in a set of values.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.lessThan -> (structure)
Filter configuration for less than comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.lessThanOrEquals -> (structure)
Filter configuration for less than or equal comparison.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.listContains -> (structure)
Filter configuration for checking if a list contains a value.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.notEquals -> (structure)
Filter configuration for inequality matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.notIn -> (structure)
Filter configuration for exclusion from a set of values.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.orAll -> (list)
Filter configuration where any condition can be met.
( … recursive … )
startsWith -> (structure)
Filter configuration for prefix matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.stringContains -> (structure)
Filter configuration for substring matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.startsWith -> (structure)
Filter configuration for prefix matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.stringContains -> (structure)
Filter configuration for substring matching.
key -> (string)
The key of the filter attribute.value -> (document)
The value of the filter attribute.numberOfResults -> (integer)
The number of results to retrieve.overrideKnowledgeBaseSearchType -> (string)
Override setting for the knowledge base search type during retrieval.
JSON Syntax:
{
"knowledgeSource": {
"assistantAssociationIds": ["string", ...]
},
"filter": {
"andAll": [
{
"andAll": [
{ ... recursive ... }
...
],
"equals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"orAll": [
{ ... recursive ... }
...
],
"startsWith": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
}
}
...
],
"equals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"orAll": [
{
"andAll": [
{ ... recursive ... }
...
],
"equals": {
"key": "string",
"value": {...}
},
"greaterThan": {
"key": "string",
"value": {...}
},
"greaterThanOrEquals": {
"key": "string",
"value": {...}
},
"in": {
"key": "string",
"value": {...}
},
"lessThan": {
"key": "string",
"value": {...}
},
"lessThanOrEquals": {
"key": "string",
"value": {...}
},
"listContains": {
"key": "string",
"value": {...}
},
"notEquals": {
"key": "string",
"value": {...}
},
"notIn": {
"key": "string",
"value": {...}
},
"orAll": [
{ ... recursive ... }
...
],
"startsWith": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
}
}
...
],
"startsWith": {
"key": "string",
"value": {...}
},
"stringContains": {
"key": "string",
"value": {...}
}
},
"numberOfResults": integer,
"overrideKnowledgeBaseSearchType": "HYBRID"|"SEMANTIC"
}
--retrieval-query (string)
The query for content retrieval.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
results -> (list)
The results of the content retrieval operation.
(structure)
A single result from a content retrieval operation.
associationId -> (string)
The identifier of the assistant association for the retrieved result.sourceId -> (string)
The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.referenceType -> (string)
A type to define the KB origin of a retrieved content.contentText -> (string)
The text content of the retrieved result.