|
103 | 103 | "base": null, |
104 | 104 | "refs": { |
105 | 105 | "ExternalSourcesGenerationConfiguration$additionalModelRequestFields": "<p>Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in custom model parameters specific to the language model being used.</p>", |
106 | | - "GenerationConfiguration$additionalModelRequestFields": "<p>Additional model parameters and corresponding values not included in the <code>textInferenceConfig</code> structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.</p>" |
| 106 | + "GenerationConfiguration$additionalModelRequestFields": "<p>Additional model parameters and corresponding values not included in the <code>textInferenceConfig</code> structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.</p>", |
| 107 | + "VectorSearchBedrockRerankingModelConfiguration$additionalModelRequestFields": "<p>A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.</p>" |
107 | 108 | } |
108 | 109 | }, |
109 | 110 | "AdditionalModelRequestFieldsKey": { |
|
151 | 152 | "UpdateMarketplaceModelEndpointRequest$endpointArn": "<p>The Amazon Resource Name (ARN) of the endpoint you want to update.</p>" |
152 | 153 | } |
153 | 154 | }, |
| 155 | + "AttributeType": { |
| 156 | + "base": null, |
| 157 | + "refs": { |
| 158 | + "MetadataAttributeSchema$type": "<p>The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.</p>" |
| 159 | + } |
| 160 | + }, |
154 | 161 | "AuthorizationStatus": { |
155 | 162 | "base": null, |
156 | 163 | "refs": { |
|
237 | 244 | "base": null, |
238 | 245 | "refs": { |
239 | 246 | "ExternalSourcesRetrieveAndGenerateConfiguration$modelArn": "<p>The Amazon Resource Name (ARN) of the foundation model or <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html\">inference profile</a> used to generate responses. </p>", |
| 247 | + "ImplicitFilterConfiguration$modelArn": "<p>The Amazon Resource Name (ARN) of the foundation model used for implicit filtering. This model processes the query to extract relevant filtering criteria.</p>", |
240 | 248 | "KnowledgeBaseRetrieveAndGenerateConfiguration$modelArn": "<p>The Amazon Resource Name (ARN) of the foundation model or <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html\">inference profile</a> used to generate responses.</p>" |
241 | 249 | } |
242 | 250 | }, |
|
254 | 262 | "ListFoundationModelAgreementOffersResponse$modelId": "<p>Model Id of the foundation model.</p>" |
255 | 263 | } |
256 | 264 | }, |
| 265 | + "BedrockRerankingModelArn": { |
| 266 | + "base": null, |
| 267 | + "refs": { |
| 268 | + "VectorSearchBedrockRerankingModelConfiguration$modelArn": "<p>The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.</p>" |
| 269 | + } |
| 270 | + }, |
257 | 271 | "Boolean": { |
258 | 272 | "base": null, |
259 | 273 | "refs": { |
|
1053 | 1067 | "RetrieveAndGenerateConfiguration$externalSourcesConfiguration": "<p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>" |
1054 | 1068 | } |
1055 | 1069 | }, |
| 1070 | + "FieldForReranking": { |
| 1071 | + "base": "<p>Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.</p>", |
| 1072 | + "refs": { |
| 1073 | + "FieldsForReranking$member": null |
| 1074 | + } |
| 1075 | + }, |
| 1076 | + "FieldForRerankingFieldNameString": { |
| 1077 | + "base": null, |
| 1078 | + "refs": { |
| 1079 | + "FieldForReranking$fieldName": "<p>The name of the metadata field to be used during the reranking process.</p>" |
| 1080 | + } |
| 1081 | + }, |
| 1082 | + "FieldsForReranking": { |
| 1083 | + "base": null, |
| 1084 | + "refs": { |
| 1085 | + "RerankingMetadataSelectiveModeConfiguration$fieldsToInclude": "<p>A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.</p>", |
| 1086 | + "RerankingMetadataSelectiveModeConfiguration$fieldsToExclude": "<p>A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.</p>" |
| 1087 | + } |
| 1088 | + }, |
1056 | 1089 | "FilterAttribute": { |
1057 | 1090 | "base": "<p>Specifies the name of the metadata attribute/field to apply filters. You must match the name of the attribute/field in your data source/document metadata.</p>", |
1058 | 1091 | "refs": { |
|
2003 | 2036 | "ByteContentDoc$identifier": "<p>The file name of the document contained in the wrapper object.</p>" |
2004 | 2037 | } |
2005 | 2038 | }, |
| 2039 | + "ImplicitFilterConfiguration": { |
| 2040 | + "base": "<p>Configuration for implicit filtering in Knowledge Base vector searches. Implicit filtering allows you to automatically filter search results based on metadata attributes without requiring explicit filter expressions in each query.</p>", |
| 2041 | + "refs": { |
| 2042 | + "KnowledgeBaseVectorSearchConfiguration$implicitFilterConfiguration": "<p>Configuration for implicit filtering in Knowledge Base vector searches. This allows the system to automatically apply filters based on the query context without requiring explicit filter expressions.</p>" |
| 2043 | + } |
| 2044 | + }, |
2006 | 2045 | "ImportedModelArn": { |
2007 | 2046 | "base": null, |
2008 | 2047 | "refs": { |
|
2512 | 2551 | "ModelInvocationJobSummary$message": "<p>If the batch inference job failed, this field contains a message describing why the job failed.</p>" |
2513 | 2552 | } |
2514 | 2553 | }, |
| 2554 | + "MetadataAttributeSchema": { |
| 2555 | + "base": "<p>Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.</p>", |
| 2556 | + "refs": { |
| 2557 | + "MetadataAttributeSchemaList$member": null |
| 2558 | + } |
| 2559 | + }, |
| 2560 | + "MetadataAttributeSchemaDescriptionString": { |
| 2561 | + "base": null, |
| 2562 | + "refs": { |
| 2563 | + "MetadataAttributeSchema$description": "<p>An optional description of the metadata attribute that provides additional context about its purpose and usage.</p>" |
| 2564 | + } |
| 2565 | + }, |
| 2566 | + "MetadataAttributeSchemaKeyString": { |
| 2567 | + "base": null, |
| 2568 | + "refs": { |
| 2569 | + "MetadataAttributeSchema$key": "<p>The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.</p>" |
| 2570 | + } |
| 2571 | + }, |
| 2572 | + "MetadataAttributeSchemaList": { |
| 2573 | + "base": null, |
| 2574 | + "refs": { |
| 2575 | + "ImplicitFilterConfiguration$metadataAttributes": "<p>A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering. Each attribute defines a key, type, and optional description.</p>" |
| 2576 | + } |
| 2577 | + }, |
| 2578 | + "MetadataConfigurationForReranking": { |
| 2579 | + "base": "<p>Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.</p>", |
| 2580 | + "refs": { |
| 2581 | + "VectorSearchBedrockRerankingConfiguration$metadataConfiguration": "<p>Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.</p>" |
| 2582 | + } |
| 2583 | + }, |
2515 | 2584 | "MetricFloat": { |
2516 | 2585 | "base": null, |
2517 | 2586 | "refs": { |
|
3226 | 3295 | "RequestMetadataMap$value": null |
3227 | 3296 | } |
3228 | 3297 | }, |
| 3298 | + "RerankingMetadataSelectionMode": { |
| 3299 | + "base": null, |
| 3300 | + "refs": { |
| 3301 | + "MetadataConfigurationForReranking$selectionMode": "<p>The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).</p>" |
| 3302 | + } |
| 3303 | + }, |
| 3304 | + "RerankingMetadataSelectiveModeConfiguration": { |
| 3305 | + "base": "<p>Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.</p>", |
| 3306 | + "refs": { |
| 3307 | + "MetadataConfigurationForReranking$selectiveModeConfiguration": "<p>Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.</p>" |
| 3308 | + } |
| 3309 | + }, |
3229 | 3310 | "ResourceNotFoundException": { |
3230 | 3311 | "base": "<p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>", |
3231 | 3312 | "refs": { |
|
3808 | 3889 | "TermDetails$validityTerm": "<p>Describes the validity terms.</p>" |
3809 | 3890 | } |
3810 | 3891 | }, |
| 3892 | + "VectorSearchBedrockRerankingConfiguration": { |
| 3893 | + "base": "<p>Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.</p>", |
| 3894 | + "refs": { |
| 3895 | + "VectorSearchRerankingConfiguration$bedrockRerankingConfiguration": "<p>Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.</p>" |
| 3896 | + } |
| 3897 | + }, |
| 3898 | + "VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger": { |
| 3899 | + "base": null, |
| 3900 | + "refs": { |
| 3901 | + "VectorSearchBedrockRerankingConfiguration$numberOfRerankedResults": "<p>The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.</p>" |
| 3902 | + } |
| 3903 | + }, |
| 3904 | + "VectorSearchBedrockRerankingModelConfiguration": { |
| 3905 | + "base": "<p>Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.</p>", |
| 3906 | + "refs": { |
| 3907 | + "VectorSearchBedrockRerankingConfiguration$modelConfiguration": "<p>Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.</p>" |
| 3908 | + } |
| 3909 | + }, |
| 3910 | + "VectorSearchRerankingConfiguration": { |
| 3911 | + "base": "<p>Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.</p>", |
| 3912 | + "refs": { |
| 3913 | + "KnowledgeBaseVectorSearchConfiguration$rerankingConfiguration": "<p>Configuration for reranking search results in Knowledge Base vector searches. Reranking improves search relevance by reordering initial vector search results using more sophisticated relevance models.</p>" |
| 3914 | + } |
| 3915 | + }, |
| 3916 | + "VectorSearchRerankingConfigurationType": { |
| 3917 | + "base": null, |
| 3918 | + "refs": { |
| 3919 | + "VectorSearchRerankingConfiguration$type": "<p>The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.</p>" |
| 3920 | + } |
| 3921 | + }, |
3811 | 3922 | "VpcConfig": { |
3812 | 3923 | "base": "<p>The configuration of a virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/usingVPC.html\">Protect your data using Amazon Virtual Private Cloud and Amazon Web Services PrivateLink</a>.</p>", |
3813 | 3924 | "refs": { |
|
0 commit comments