nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
- `retrievalConfiguration` object — Contains configurations for knowledge base query. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
This data type is used in the following API operations:
Retrieve request – in the filter field
RetrieveAndGenerate request – in the filter field
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
"equals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
"greaterThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
"in": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
"lessThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
"notEquals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
"startsWith": { "key": "animal", "value": "ca" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
"stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).
"stringContains": { "key": "animals", "value": "at" }
SELECTIVE, include the selectiveModeConfiguration field.
- `selectiveModeConfiguration` object — Contains configurations for the metadata fields to include or exclude when considering reranking.
- …
- `modelConfiguration` object, required — The model configuration containing the model ARN for reranking.
- `additionalModelRequestFields` object — Additional request fields to pass to the reranking model.
- `modelArn` string, required — The ARN of the Bedrock reranking model.
- `numberOfRerankedResults` integer — The number of results to return after reranking.
- `type` 'BEDROCK_RERANKING_MODEL', required — The type of reranking configuration.
- `rerankingModelType` 'CUSTOM' | 'MANAGED' | 'NONE' — The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.
- `vectorSearchConfiguration` object — Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
- `filter` object — Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
- `andAll` RetrievalFilter[] — Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
- `andAll` RetrievalFilter[] — Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
- `equals` object — Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
"equals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
"greaterThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
"in": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
"lessThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
"notEquals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
"startsWith": { "key": "animal", "value": "ca" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
"stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).
"stringContains": { "key": "animals", "value": "at" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
"equals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
"greaterThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
"in": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
"lessThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
"notEquals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
"equals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
"greaterThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
"greaterThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
"in": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
"lessThan": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
"lessThanOrEquals": { "key": "year", "value": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example ["dog", "cat"]).
"listContains": { "key": "animals", "value": "cat" }
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
"notEquals": { "key": "animal", "value": "cat" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
"notIn": { "key": "animal", "value": ["cat", "dog"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
"startsWith": { "key": "animal", "value": "ca" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
"stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).
"stringContains": { "key": "animals", "value": "at" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
"startsWith": { "key": "animal", "value": "ca" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
"stringContains": { "key": "animal", "value": "at" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example ["dog", "cat"]).
"stringContains": { "key": "animals", "value": "at" }
HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
- `rerankingConfiguration` object — Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
- `bedrockRerankingConfiguration` object — Contains configurations for an Amazon Bedrock reranker model.
- `metadataConfiguration` object — Contains configurations for the metadata to use in reranking.
- `selectionMode` 'SELECTIVE' | 'ALL', required — Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.
- `selectiveModeConfiguration` object — Contains configurations for the metadata fields to include or exclude when considering reranking.
- …
- `modelConfiguration` object, required — Contains configurations for the reranker model.
- `additionalModelRequestFields` object — A JSON object whose keys are request fields for the model and whose values are values for those fields.
- `modelArn` string, required — The ARN of the reranker model to use.
- `numberOfRerankedResults` integer — The number of results to return after reranking.
- `type` 'BEDROCK_RERANKING_MODEL', required — The type of reranker model.
- `retrievalQuery` object, required — Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request – in the retrievalQuery field
nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
- `retrievalResults` KnowledgeBaseRetrievalResult[], required — A list of results from querying the knowledge base.
- `content` object, required — Contains information about the content of the chunk.
- `audio` object — Audio segment information when the retrieval result contains audio content.
- `s3Uri` string, required — The S3 URI where this specific audio segment is stored in the multimodal storage destination.
- `transcription` string — The text transcription of the audio segment content.
- `byteContent` string — A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.
- `row` RetrievalResultContentColumn[] — Specifies information about the rows with the cells to return in retrieval.
- `columnName` string — The name of the column.
- `columnValue` string — The value in the column.
- `type` 'BLOB' | 'BOOLEAN' | 'DOUBLE' | 'NULL' | 'LONG' | 'STRING' — The data type of the value.
- `text` string — The cited text from the data source.
- `type` 'TEXT' | 'IMAGE' | 'ROW' | 'AUDIO' | 'VIDEO' — The type of content in the retrieval result.
- `video` object — Video segment information when the retrieval result contains video content.
- `s3Uri` string, required — The S3 URI where this specific video segment is stored in the multimodal storage destination.
- `summary` string — A text summary describing the content of the video segment.
- `documentId` string — The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.
- `location` object — Contains information about the location of the data source.
- `confluenceLocation` object — The Confluence data source location.
- `url` string — The Confluence host URL for the data source location.
- `customDocumentLocation` object — Specifies the location of a document in a custom data source.
- `id` string — The ID of the document.
- `googleDriveLocation` object — The Google Drive data source location.
- `url` string — The Google Drive URL for the data source location.
- `kendraDocumentLocation` object — The location of a document in Amazon Kendra.
- `uri` string — The document's uri.
- `oneDriveLocation` object — The Microsoft OneDrive data source location.
- `url` string — The OneDrive URL for the data source location.
- `s3Location` object — The S3 data source location.
- `uri` string — The S3 URI for the data source location.
- `salesforceLocation` object — The Salesforce data source location.
- `url` string — The Salesforce host URL for the data source location.
- `sharePointLocation` object — The SharePoint data source location.
- `url` string — The SharePoint site URL for the data source location.
- `sqlLocation` object — Specifies information about the SQL query used to retrieve the result.
- `query` string — The SQL query used to retrieve the result.
- `type` 'S3' | 'WEB' | 'CONFLUENCE' | 'SALESFORCE' | 'SHAREPOINT' | 'CUSTOM' | 'KENDRA' | 'SQL' | 'ONEDRIVE' | 'GOOGLEDRIVE', required — The type of data source location.
- `webLocation` object — The web URL/URLs data source location.
- `url` string — The web URL/URLs for the data source location.
- `metadata` object — Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
- `score` number, double — The level of relevance of the result to the query.
## Other responses
- `480` — ResourceNotFoundException
- `481` — ConflictException
- `482` — ValidationException
- `483` — InternalServerException
- `484` — DependencyFailedException
- `485` — BadGatewayException
- `486` — ThrottlingException
- `487` — AccessDeniedException
- `488` — ServiceQuotaExceededException
---
[API](https://skmtc.net/aws/apis/bedrock-agent-runtime.md) · [All operations](https://skmtc.net/aws/apis/bedrock-agent-runtime/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/bedrock-agent-runtime/versions/fe358131c0ad/schema)