Skip to content

Commit

Permalink
feat(client-bedrock-agent-runtime): Updating Bedrock Knowledge Base M…
Browse files Browse the repository at this point in the history 
…etadata & Filters feature with two new filters listContains and stringContains
  • Loading branch information
awstools committed May 15, 2024
1 parent c7cfb66 commit 91b3891
Show file tree
Hide file tree
Showing 5 changed files with 173 additions and 23 deletions.
4 changes: 4 additions & 0 deletions clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ export interface RetrieveAndGenerateCommandOutput extends RetrieveAndGenerateRes
* in: "<FilterAttribute>",
* notIn: "<FilterAttribute>",
* startsWith: "<FilterAttribute>",
* listContains: "<FilterAttribute>",
* stringContains: "<FilterAttribute>",
* andAll: [ // RetrievalFilterList
* {// Union: only one key present
* equals: "<FilterAttribute>",
Expand All @@ -93,6 +95,8 @@ export interface RetrieveAndGenerateCommandOutput extends RetrieveAndGenerateRes
* in: "<FilterAttribute>",
* notIn: "<FilterAttribute>",
* startsWith: "<FilterAttribute>",
* listContains: "<FilterAttribute>",
* stringContains: "<FilterAttribute>",
* andAll: [
* "<RetrievalFilter>",
* ],
Expand Down
4 changes: 4 additions & 0 deletions clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ export interface RetrieveCommandOutput extends RetrieveResponse, __MetadataBeare
* in: "<FilterAttribute>",
* notIn: "<FilterAttribute>",
* startsWith: "<FilterAttribute>",
* listContains: "<FilterAttribute>",
* stringContains: "<FilterAttribute>",
* andAll: [ // RetrievalFilterList
* {// Union: only one key present
* equals: "<FilterAttribute>",
Expand All @@ -88,6 +90,8 @@ export interface RetrieveCommandOutput extends RetrieveResponse, __MetadataBeare
* in: "<FilterAttribute>",
* notIn: "<FilterAttribute>",
* startsWith: "<FilterAttribute>",
* listContains: "<FilterAttribute>",
* stringContains: "<FilterAttribute>",
* andAll: [
* "<RetrievalFilter>",
* ],
Expand Down
150 changes: 139 additions & 11 deletions clients/client-bedrock-agent-runtime/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2721,7 +2721,7 @@ export interface RetrieveResponse {
}

/**
* <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
* <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>. See the examples below to see how to use these filters.</p>
* <p>This data type is used in the following API operations:</p>
* <ul>
* <li>
Expand All @@ -2743,18 +2743,24 @@ export type RetrievalFilter =
| RetrievalFilter.InMember
| RetrievalFilter.LessThanMember
| RetrievalFilter.LessThanOrEqualsMember
| RetrievalFilter.ListContainsMember
| RetrievalFilter.NotEqualsMember
| RetrievalFilter.NotInMember
| RetrievalFilter.OrAllMember
| RetrievalFilter.StartsWithMember
| RetrievalFilter.StringContainsMember
| RetrievalFilter.$UnknownMember;

/**
* @public
*/
export namespace RetrievalFilter {
/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object.</p>
* <p>The following example would return data sources with an <code>animal</code> attribute whose value is <code>cat</code>:</p>
* <p>
* <code>"equals": \{ "key": "animal", "value": "cat" \}</code>
* </p>
* @public
*/
export interface EqualsMember {
Expand All @@ -2767,13 +2773,19 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object are returned.</p>
* <p>The following example would return data sources that don't contain an <code>animal</code> attribute whose value is <code>cat</code>.</p>
* <p>
* <code>"notEquals": \{ "key": "animal", "value": "cat" \}</code>
* </p>
* @public
*/
export interface NotEqualsMember {
Expand All @@ -2786,13 +2798,19 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object.</p>
* <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than <code>1989</code>:</p>
* <p>
* <code>"greaterThan": \{ "key": "year", "value": 1989 \}</code>
* </p>
* @public
*/
export interface GreaterThanMember {
Expand All @@ -2805,13 +2823,19 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object.</p>
* <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than or equal to <code>1989</code>:</p>
* <p>
* <code>"greaterThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
* </p>
* @public
*/
export interface GreaterThanOrEqualsMember {
Expand All @@ -2824,13 +2848,19 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object.</p>
* <p>The following example would return data sources with an <code>year</code> attribute whose value is less than to <code>1989</code>.</p>
* <p>
* <code>"lessThan": \{ "key": "year", "value": 1989 \}</code>
* </p>
* @public
*/
export interface LessThanMember {
Expand All @@ -2843,13 +2873,19 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object.</p>
* <p>The following example would return data sources with an <code>year</code> attribute whose value is less than or equal to <code>1989</code>.</p>
* <p>
* <code>"lessThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
* </p>
* @public
*/
export interface LessThanOrEqualsMember {
Expand All @@ -2862,13 +2898,19 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object.</p>
* <p>The following example would return data sources with an <code>animal</code> attribute that is either <code>cat</code> or <code>dog</code>:</p>
* <p>
* <code>"in": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
* </p>
* @public
*/
export interface InMember {
Expand All @@ -2881,13 +2923,19 @@ export namespace RetrievalFilter {
in: FilterAttribute;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object.</p>
* <p>The following example would return data sources whose <code>animal</code> attribute is neither <code>cat</code> nor <code>dog</code>.</p>
* <p>
* <code>"notIn": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
* </p>
* @public
*/
export interface NotInMember {
Expand All @@ -2900,13 +2948,19 @@ export namespace RetrievalFilter {
in?: never;
notIn: FilterAttribute;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>
* <p>The following example would return data sources with an <code>animal</code> attribute starts with <code>ca</code> (for example, <code>cat</code> or <code>camel</code>).</p>
* <p>
* <code>"startsWith": \{ "key": "animal", "value": "ca" \}</code>
* </p>
* @public
*/
export interface StartsWithMember {
Expand All @@ -2919,13 +2973,75 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith: FilterAttribute;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.</p>
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is a list that contains the <code>value</code> as one of its members.</p>
* <p>The following example would return data sources with an <code>animals</code> attribute that is a list containing a <code>cat</code> member (for example <code>["dog", "cat"]</code>).</p>
* <p>
* <code>"listContains": \{ "key": "animals", "value": "cat" \}</code>
* </p>
* @public
*/
export interface ListContainsMember {
equals?: never;
notEquals?: never;
greaterThan?: never;
greaterThanOrEquals?: never;
lessThan?: never;
lessThanOrEquals?: never;
in?: never;
notIn?: never;
startsWith?: never;
listContains: FilterAttribute;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is one of the following:</p>
* <ul>
* <li>
* <p>A string that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animal</code> attribute that contains the substring <code>at</code> (for example <code>cat</code>).</p>
* <p>
* <code>"stringContains": \{ "key": "animal", "value": "at" \}</code>
* </p>
* </li>
* <li>
* <p>A list with a member that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animals</code> attribute that is a list containing a member that contains the substring <code>at</code> (for example <code>["dog", "cat"]</code>).</p>
* <p>
* <code>"stringContains": \{ "key": "animals", "value": "at" \}</code>
* </p>
* </li>
* </ul>
* @public
*/
export interface StringContainsMember {
equals?: never;
notEquals?: never;
greaterThan?: never;
greaterThanOrEquals?: never;
lessThan?: never;
lessThanOrEquals?: never;
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains: FilterAttribute;
andAll?: never;
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>
* @public
*/
export interface AndAllMember {
Expand All @@ -2938,13 +3054,15 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll: RetrievalFilter[];
orAll?: never;
$unknown?: never;
}

/**
* <p>Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.</p>
* <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>
* @public
*/
export interface OrAllMember {
Expand All @@ -2957,6 +3075,8 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll: RetrievalFilter[];
$unknown?: never;
Expand All @@ -2975,6 +3095,8 @@ export namespace RetrievalFilter {
in?: never;
notIn?: never;
startsWith?: never;
listContains?: never;
stringContains?: never;
andAll?: never;
orAll?: never;
$unknown: [string, any];
Expand All @@ -2990,6 +3112,8 @@ export namespace RetrievalFilter {
in: (value: FilterAttribute) => T;
notIn: (value: FilterAttribute) => T;
startsWith: (value: FilterAttribute) => T;
listContains: (value: FilterAttribute) => T;
stringContains: (value: FilterAttribute) => T;
andAll: (value: RetrievalFilter[]) => T;
orAll: (value: RetrievalFilter[]) => T;
_: (name: string, value: any) => T;
Expand All @@ -3005,6 +3129,8 @@ export namespace RetrievalFilter {
if (value.in !== undefined) return visitor.in(value.in);
if (value.notIn !== undefined) return visitor.notIn(value.notIn);
if (value.startsWith !== undefined) return visitor.startsWith(value.startsWith);
if (value.listContains !== undefined) return visitor.listContains(value.listContains);
if (value.stringContains !== undefined) return visitor.stringContains(value.stringContains);
if (value.andAll !== undefined) return visitor.andAll(value.andAll);
if (value.orAll !== undefined) return visitor.orAll(value.orAll);
return visitor._(value.$unknown[0], value.$unknown[1]);
Expand Down Expand Up @@ -3667,6 +3793,8 @@ export const RetrievalFilterFilterSensitiveLog = (obj: RetrievalFilter): any =>
if (obj.in !== undefined) return { in: obj.in };
if (obj.notIn !== undefined) return { notIn: obj.notIn };
if (obj.startsWith !== undefined) return { startsWith: obj.startsWith };
if (obj.listContains !== undefined) return { listContains: obj.listContains };
if (obj.stringContains !== undefined) return { stringContains: obj.stringContains };
if (obj.andAll !== undefined) return { andAll: SENSITIVE_STRING };
if (obj.orAll !== undefined) return { orAll: SENSITIVE_STRING };
if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
Expand Down
2 changes: 2 additions & 0 deletions clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -818,10 +818,12 @@ const se_RetrievalFilter = (input: RetrievalFilter, context: __SerdeContext): an
in: (value) => ({ in: se_FilterAttribute(value, context) }),
lessThan: (value) => ({ lessThan: se_FilterAttribute(value, context) }),
lessThanOrEquals: (value) => ({ lessThanOrEquals: se_FilterAttribute(value, context) }),
listContains: (value) => ({ listContains: se_FilterAttribute(value, context) }),
notEquals: (value) => ({ notEquals: se_FilterAttribute(value, context) }),
notIn: (value) => ({ notIn: se_FilterAttribute(value, context) }),
orAll: (value) => ({ orAll: se_RetrievalFilterList(value, context) }),
startsWith: (value) => ({ startsWith: se_FilterAttribute(value, context) }),
stringContains: (value) => ({ stringContains: se_FilterAttribute(value, context) }),
_: (name, value) => ({ name: value } as any),
});
};
Expand Down
Loading

0 comments on commit 91b3891

Please sign in to comment.