@aws-sdk/client-bedrock-agent-runtime 3.705.0 → 3.706.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/index.js +115 -1
- package/dist-es/BedrockAgentRuntime.js +2 -0
- package/dist-es/commands/GenerateQueryCommand.js +23 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +45 -0
- package/dist-es/protocols/Aws_restJson1.js +28 -0
- package/dist-types/BedrockAgentRuntime.d.ts +7 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +3 -2
- package/dist-types/commands/GenerateQueryCommand.d.ts +115 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +51 -6
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +51 -6
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +17 -2
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +17 -2
- package/dist-types/commands/RetrieveCommand.d.ts +17 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +267 -4
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GenerateQueryCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +97 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +1 -1
|
@@ -1796,6 +1796,150 @@ export interface InvokeFlowResponse {
|
|
|
1796
1796
|
*/
|
|
1797
1797
|
responseStream: AsyncIterable<FlowResponseStream> | undefined;
|
|
1798
1798
|
}
|
|
1799
|
+
/**
|
|
1800
|
+
* @public
|
|
1801
|
+
* @enum
|
|
1802
|
+
*/
|
|
1803
|
+
export declare const InputQueryType: {
|
|
1804
|
+
readonly TEXT: "TEXT";
|
|
1805
|
+
};
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
export type InputQueryType = (typeof InputQueryType)[keyof typeof InputQueryType];
|
|
1810
|
+
/**
|
|
1811
|
+
* <p>Contains information about a natural language query to transform into SQL.</p>
|
|
1812
|
+
* @public
|
|
1813
|
+
*/
|
|
1814
|
+
export interface QueryGenerationInput {
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>The type of the query.</p>
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
type: InputQueryType | undefined;
|
|
1820
|
+
/**
|
|
1821
|
+
* <p>The text of the query.</p>
|
|
1822
|
+
* @public
|
|
1823
|
+
*/
|
|
1824
|
+
text: string | undefined;
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
* @enum
|
|
1829
|
+
*/
|
|
1830
|
+
export declare const QueryTransformationMode: {
|
|
1831
|
+
readonly TEXT_TO_SQL: "TEXT_TO_SQL";
|
|
1832
|
+
};
|
|
1833
|
+
/**
|
|
1834
|
+
* @public
|
|
1835
|
+
*/
|
|
1836
|
+
export type QueryTransformationMode = (typeof QueryTransformationMode)[keyof typeof QueryTransformationMode];
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>Contains configurations for a knowledge base to use in transformation.</p>
|
|
1839
|
+
* @public
|
|
1840
|
+
*/
|
|
1841
|
+
export interface TextToSqlKnowledgeBaseConfiguration {
|
|
1842
|
+
/**
|
|
1843
|
+
* <p>The ARN of the knowledge base</p>
|
|
1844
|
+
* @public
|
|
1845
|
+
*/
|
|
1846
|
+
knowledgeBaseArn: string | undefined;
|
|
1847
|
+
}
|
|
1848
|
+
/**
|
|
1849
|
+
* @public
|
|
1850
|
+
* @enum
|
|
1851
|
+
*/
|
|
1852
|
+
export declare const TextToSqlConfigurationType: {
|
|
1853
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
1854
|
+
};
|
|
1855
|
+
/**
|
|
1856
|
+
* @public
|
|
1857
|
+
*/
|
|
1858
|
+
export type TextToSqlConfigurationType = (typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType];
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>Contains configurations for transforming text to SQL.</p>
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1863
|
+
export interface TextToSqlConfiguration {
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>The type of resource to use in transformation.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
type: TextToSqlConfigurationType | undefined;
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>Specifies configurations for a knowledge base to use in transformation.</p>
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
knowledgeBaseConfiguration?: TextToSqlKnowledgeBaseConfiguration | undefined;
|
|
1874
|
+
}
|
|
1875
|
+
/**
|
|
1876
|
+
* <p>Contains configurations for transforming the natural language query into SQL.</p>
|
|
1877
|
+
* @public
|
|
1878
|
+
*/
|
|
1879
|
+
export interface TransformationConfiguration {
|
|
1880
|
+
/**
|
|
1881
|
+
* <p>The mode of the transformation.</p>
|
|
1882
|
+
* @public
|
|
1883
|
+
*/
|
|
1884
|
+
mode: QueryTransformationMode | undefined;
|
|
1885
|
+
/**
|
|
1886
|
+
* <p>Specifies configurations for transforming text to SQL.</p>
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
textToSqlConfiguration?: TextToSqlConfiguration | undefined;
|
|
1890
|
+
}
|
|
1891
|
+
/**
|
|
1892
|
+
* @public
|
|
1893
|
+
*/
|
|
1894
|
+
export interface GenerateQueryRequest {
|
|
1895
|
+
/**
|
|
1896
|
+
* <p>Specifies information about a natural language query to transform into SQL.</p>
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
queryGenerationInput: QueryGenerationInput | undefined;
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>Specifies configurations for transforming the natural language query into SQL.</p>
|
|
1902
|
+
* @public
|
|
1903
|
+
*/
|
|
1904
|
+
transformationConfiguration: TransformationConfiguration | undefined;
|
|
1905
|
+
}
|
|
1906
|
+
/**
|
|
1907
|
+
* @public
|
|
1908
|
+
* @enum
|
|
1909
|
+
*/
|
|
1910
|
+
export declare const GeneratedQueryType: {
|
|
1911
|
+
readonly REDSHIFT_SQL: "REDSHIFT_SQL";
|
|
1912
|
+
};
|
|
1913
|
+
/**
|
|
1914
|
+
* @public
|
|
1915
|
+
*/
|
|
1916
|
+
export type GeneratedQueryType = (typeof GeneratedQueryType)[keyof typeof GeneratedQueryType];
|
|
1917
|
+
/**
|
|
1918
|
+
* <p>Contains information about a query generated for a natural language query.</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
export interface GeneratedQuery {
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>The type of transformed query.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
type?: GeneratedQueryType | undefined;
|
|
1927
|
+
/**
|
|
1928
|
+
* <p>An SQL query that corresponds to the natural language query.</p>
|
|
1929
|
+
* @public
|
|
1930
|
+
*/
|
|
1931
|
+
sql?: string | undefined;
|
|
1932
|
+
}
|
|
1933
|
+
/**
|
|
1934
|
+
* @public
|
|
1935
|
+
*/
|
|
1936
|
+
export interface GenerateQueryResponse {
|
|
1937
|
+
/**
|
|
1938
|
+
* <p>A list of objects, each of which defines a generated query that can correspond to the natural language queries.</p>
|
|
1939
|
+
* @public
|
|
1940
|
+
*/
|
|
1941
|
+
queries?: GeneratedQuery[] | undefined;
|
|
1942
|
+
}
|
|
1799
1943
|
/**
|
|
1800
1944
|
* <p>A content block.</p>
|
|
1801
1945
|
* @public
|
|
@@ -2289,7 +2433,57 @@ export interface GeneratedResponsePart {
|
|
|
2289
2433
|
textResponsePart?: TextResponsePart | undefined;
|
|
2290
2434
|
}
|
|
2291
2435
|
/**
|
|
2292
|
-
*
|
|
2436
|
+
* @public
|
|
2437
|
+
* @enum
|
|
2438
|
+
*/
|
|
2439
|
+
export declare const RetrievalResultContentColumnType: {
|
|
2440
|
+
readonly BLOB: "BLOB";
|
|
2441
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
2442
|
+
readonly DOUBLE: "DOUBLE";
|
|
2443
|
+
readonly LONG: "LONG";
|
|
2444
|
+
readonly NULL: "NULL";
|
|
2445
|
+
readonly STRING: "STRING";
|
|
2446
|
+
};
|
|
2447
|
+
/**
|
|
2448
|
+
* @public
|
|
2449
|
+
*/
|
|
2450
|
+
export type RetrievalResultContentColumnType = (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType];
|
|
2451
|
+
/**
|
|
2452
|
+
* <p>Contains information about a column with a cell to return in retrieval.</p>
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2455
|
+
export interface RetrievalResultContentColumn {
|
|
2456
|
+
/**
|
|
2457
|
+
* <p>The name of the column.</p>
|
|
2458
|
+
* @public
|
|
2459
|
+
*/
|
|
2460
|
+
columnName?: string | undefined;
|
|
2461
|
+
/**
|
|
2462
|
+
* <p>The value in the column.</p>
|
|
2463
|
+
* @public
|
|
2464
|
+
*/
|
|
2465
|
+
columnValue?: string | undefined;
|
|
2466
|
+
/**
|
|
2467
|
+
* <p>The data type of the value.</p>
|
|
2468
|
+
* @public
|
|
2469
|
+
*/
|
|
2470
|
+
type?: RetrievalResultContentColumnType | undefined;
|
|
2471
|
+
}
|
|
2472
|
+
/**
|
|
2473
|
+
* @public
|
|
2474
|
+
* @enum
|
|
2475
|
+
*/
|
|
2476
|
+
export declare const RetrievalResultContentType: {
|
|
2477
|
+
readonly IMAGE: "IMAGE";
|
|
2478
|
+
readonly ROW: "ROW";
|
|
2479
|
+
readonly TEXT: "TEXT";
|
|
2480
|
+
};
|
|
2481
|
+
/**
|
|
2482
|
+
* @public
|
|
2483
|
+
*/
|
|
2484
|
+
export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType];
|
|
2485
|
+
/**
|
|
2486
|
+
* <p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</p>
|
|
2293
2487
|
* <p>This data type is used in the following API operations:</p>
|
|
2294
2488
|
* <ul>
|
|
2295
2489
|
* <li>
|
|
@@ -2308,11 +2502,26 @@ export interface GeneratedResponsePart {
|
|
|
2308
2502
|
* @public
|
|
2309
2503
|
*/
|
|
2310
2504
|
export interface RetrievalResultContent {
|
|
2505
|
+
/**
|
|
2506
|
+
* <p>The type of content in the retrieval result.</p>
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
type?: RetrievalResultContentType | undefined;
|
|
2311
2510
|
/**
|
|
2312
2511
|
* <p>The cited text from the data source.</p>
|
|
2313
2512
|
* @public
|
|
2314
2513
|
*/
|
|
2315
|
-
text
|
|
2514
|
+
text?: string | undefined;
|
|
2515
|
+
/**
|
|
2516
|
+
* <p>A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: <code>data:image/jpeg;base64,$\{base64-encoded string\}</code>.</p>
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
byteContent?: string | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>Specifies information about the rows with the cells to return in retrieval.</p>
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2524
|
+
row?: RetrievalResultContentColumn[] | undefined;
|
|
2316
2525
|
}
|
|
2317
2526
|
/**
|
|
2318
2527
|
* <p>The Confluence data source location.</p>
|
|
@@ -2336,6 +2545,17 @@ export interface RetrievalResultCustomDocumentLocation {
|
|
|
2336
2545
|
*/
|
|
2337
2546
|
id?: string | undefined;
|
|
2338
2547
|
}
|
|
2548
|
+
/**
|
|
2549
|
+
* <p>The location of a result in Amazon Kendra.</p>
|
|
2550
|
+
* @public
|
|
2551
|
+
*/
|
|
2552
|
+
export interface RetrievalResultKendraDocumentLocation {
|
|
2553
|
+
/**
|
|
2554
|
+
* <p>The document's uri.</p>
|
|
2555
|
+
* @public
|
|
2556
|
+
*/
|
|
2557
|
+
uri?: string | undefined;
|
|
2558
|
+
}
|
|
2339
2559
|
/**
|
|
2340
2560
|
* <p>The S3 data source location.</p>
|
|
2341
2561
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -2384,6 +2604,17 @@ export interface RetrievalResultSharePointLocation {
|
|
|
2384
2604
|
*/
|
|
2385
2605
|
url?: string | undefined;
|
|
2386
2606
|
}
|
|
2607
|
+
/**
|
|
2608
|
+
* <p>Contains information about the SQL query used to retrieve the result.</p>
|
|
2609
|
+
* @public
|
|
2610
|
+
*/
|
|
2611
|
+
export interface RetrievalResultSqlLocation {
|
|
2612
|
+
/**
|
|
2613
|
+
* <p>The SQL query used to retrieve the result.</p>
|
|
2614
|
+
* @public
|
|
2615
|
+
*/
|
|
2616
|
+
query?: string | undefined;
|
|
2617
|
+
}
|
|
2387
2618
|
/**
|
|
2388
2619
|
* @public
|
|
2389
2620
|
* @enum
|
|
@@ -2391,9 +2622,11 @@ export interface RetrievalResultSharePointLocation {
|
|
|
2391
2622
|
export declare const RetrievalResultLocationType: {
|
|
2392
2623
|
readonly CONFLUENCE: "CONFLUENCE";
|
|
2393
2624
|
readonly CUSTOM: "CUSTOM";
|
|
2625
|
+
readonly KENDRA: "KENDRA";
|
|
2394
2626
|
readonly S3: "S3";
|
|
2395
2627
|
readonly SALESFORCE: "SALESFORCE";
|
|
2396
2628
|
readonly SHAREPOINT: "SHAREPOINT";
|
|
2629
|
+
readonly SQL: "SQL";
|
|
2397
2630
|
readonly WEB: "WEB";
|
|
2398
2631
|
};
|
|
2399
2632
|
/**
|
|
@@ -2425,7 +2658,7 @@ export interface RetrievalResultWebLocation {
|
|
|
2425
2658
|
* </li>
|
|
2426
2659
|
* <li>
|
|
2427
2660
|
* <p>
|
|
2428
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>
|
|
2661
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>location</code> field</p>
|
|
2429
2662
|
* </li>
|
|
2430
2663
|
* </ul>
|
|
2431
2664
|
* @public
|
|
@@ -2466,6 +2699,16 @@ export interface RetrievalResultLocation {
|
|
|
2466
2699
|
* @public
|
|
2467
2700
|
*/
|
|
2468
2701
|
customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The location of a document in Amazon Kendra.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
kendraDocumentLocation?: RetrievalResultKendraDocumentLocation | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>Specifies information about the SQL query used to retrieve the result.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
sqlLocation?: RetrievalResultSqlLocation | undefined;
|
|
2469
2712
|
}
|
|
2470
2713
|
/**
|
|
2471
2714
|
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
@@ -6337,7 +6580,7 @@ export interface KnowledgeBaseQuery {
|
|
|
6337
6580
|
*/
|
|
6338
6581
|
export interface KnowledgeBaseRetrievalResult {
|
|
6339
6582
|
/**
|
|
6340
|
-
* <p>Contains
|
|
6583
|
+
* <p>Contains information about the content of the chunk.</p>
|
|
6341
6584
|
* @public
|
|
6342
6585
|
*/
|
|
6343
6586
|
content: RetrievalResultContent | undefined;
|
|
@@ -7352,6 +7595,22 @@ export declare const FlowResponseStreamFilterSensitiveLog: (obj: FlowResponseStr
|
|
|
7352
7595
|
* @internal
|
|
7353
7596
|
*/
|
|
7354
7597
|
export declare const InvokeFlowResponseFilterSensitiveLog: (obj: InvokeFlowResponse) => any;
|
|
7598
|
+
/**
|
|
7599
|
+
* @internal
|
|
7600
|
+
*/
|
|
7601
|
+
export declare const QueryGenerationInputFilterSensitiveLog: (obj: QueryGenerationInput) => any;
|
|
7602
|
+
/**
|
|
7603
|
+
* @internal
|
|
7604
|
+
*/
|
|
7605
|
+
export declare const GenerateQueryRequestFilterSensitiveLog: (obj: GenerateQueryRequest) => any;
|
|
7606
|
+
/**
|
|
7607
|
+
* @internal
|
|
7608
|
+
*/
|
|
7609
|
+
export declare const GeneratedQueryFilterSensitiveLog: (obj: GeneratedQuery) => any;
|
|
7610
|
+
/**
|
|
7611
|
+
* @internal
|
|
7612
|
+
*/
|
|
7613
|
+
export declare const GenerateQueryResponseFilterSensitiveLog: (obj: GenerateQueryResponse) => any;
|
|
7355
7614
|
/**
|
|
7356
7615
|
* @internal
|
|
7357
7616
|
*/
|
|
@@ -7408,6 +7667,10 @@ export declare const TextResponsePartFilterSensitiveLog: (obj: TextResponsePart)
|
|
|
7408
7667
|
* @internal
|
|
7409
7668
|
*/
|
|
7410
7669
|
export declare const GeneratedResponsePartFilterSensitiveLog: (obj: GeneratedResponsePart) => any;
|
|
7670
|
+
/**
|
|
7671
|
+
* @internal
|
|
7672
|
+
*/
|
|
7673
|
+
export declare const RetrievalResultContentColumnFilterSensitiveLog: (obj: RetrievalResultContentColumn) => any;
|
|
7411
7674
|
/**
|
|
7412
7675
|
* @internal
|
|
7413
7676
|
*/
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
|
|
2
2
|
import { EventStreamSerdeContext as __EventStreamSerdeContext, SerdeContext as __SerdeContext } from "@smithy/types";
|
|
3
3
|
import { DeleteAgentMemoryCommandInput, DeleteAgentMemoryCommandOutput } from "../commands/DeleteAgentMemoryCommand";
|
|
4
|
+
import { GenerateQueryCommandInput, GenerateQueryCommandOutput } from "../commands/GenerateQueryCommand";
|
|
4
5
|
import { GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput } from "../commands/GetAgentMemoryCommand";
|
|
5
6
|
import { InvokeAgentCommandInput, InvokeAgentCommandOutput } from "../commands/InvokeAgentCommand";
|
|
6
7
|
import { InvokeFlowCommandInput, InvokeFlowCommandOutput } from "../commands/InvokeFlowCommand";
|
|
@@ -14,6 +15,10 @@ import { RetrieveCommandInput, RetrieveCommandOutput } from "../commands/Retriev
|
|
|
14
15
|
* serializeAws_restJson1DeleteAgentMemoryCommand
|
|
15
16
|
*/
|
|
16
17
|
export declare const se_DeleteAgentMemoryCommand: (input: DeleteAgentMemoryCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
18
|
+
/**
|
|
19
|
+
* serializeAws_restJson1GenerateQueryCommand
|
|
20
|
+
*/
|
|
21
|
+
export declare const se_GenerateQueryCommand: (input: GenerateQueryCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
17
22
|
/**
|
|
18
23
|
* serializeAws_restJson1GetAgentMemoryCommand
|
|
19
24
|
*/
|
|
@@ -54,6 +59,10 @@ export declare const se_RetrieveAndGenerateStreamCommand: (input: RetrieveAndGen
|
|
|
54
59
|
* deserializeAws_restJson1DeleteAgentMemoryCommand
|
|
55
60
|
*/
|
|
56
61
|
export declare const de_DeleteAgentMemoryCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteAgentMemoryCommandOutput>;
|
|
62
|
+
/**
|
|
63
|
+
* deserializeAws_restJson1GenerateQueryCommand
|
|
64
|
+
*/
|
|
65
|
+
export declare const de_GenerateQueryCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GenerateQueryCommandOutput>;
|
|
57
66
|
/**
|
|
58
67
|
* deserializeAws_restJson1GetAgentMemoryCommand
|
|
59
68
|
*/
|
|
@@ -4,6 +4,10 @@ import {
|
|
|
4
4
|
DeleteAgentMemoryCommandInput,
|
|
5
5
|
DeleteAgentMemoryCommandOutput,
|
|
6
6
|
} from "./commands/DeleteAgentMemoryCommand";
|
|
7
|
+
import {
|
|
8
|
+
GenerateQueryCommandInput,
|
|
9
|
+
GenerateQueryCommandOutput,
|
|
10
|
+
} from "./commands/GenerateQueryCommand";
|
|
7
11
|
import {
|
|
8
12
|
GetAgentMemoryCommandInput,
|
|
9
13
|
GetAgentMemoryCommandOutput,
|
|
@@ -54,6 +58,19 @@ export interface BedrockAgentRuntime {
|
|
|
54
58
|
options: __HttpHandlerOptions,
|
|
55
59
|
cb: (err: any, data?: DeleteAgentMemoryCommandOutput) => void
|
|
56
60
|
): void;
|
|
61
|
+
generateQuery(
|
|
62
|
+
args: GenerateQueryCommandInput,
|
|
63
|
+
options?: __HttpHandlerOptions
|
|
64
|
+
): Promise<GenerateQueryCommandOutput>;
|
|
65
|
+
generateQuery(
|
|
66
|
+
args: GenerateQueryCommandInput,
|
|
67
|
+
cb: (err: any, data?: GenerateQueryCommandOutput) => void
|
|
68
|
+
): void;
|
|
69
|
+
generateQuery(
|
|
70
|
+
args: GenerateQueryCommandInput,
|
|
71
|
+
options: __HttpHandlerOptions,
|
|
72
|
+
cb: (err: any, data?: GenerateQueryCommandOutput) => void
|
|
73
|
+
): void;
|
|
57
74
|
getAgentMemory(
|
|
58
75
|
args: GetAgentMemoryCommandInput,
|
|
59
76
|
options?: __HttpHandlerOptions
|
|
@@ -54,6 +54,10 @@ import {
|
|
|
54
54
|
DeleteAgentMemoryCommandInput,
|
|
55
55
|
DeleteAgentMemoryCommandOutput,
|
|
56
56
|
} from "./commands/DeleteAgentMemoryCommand";
|
|
57
|
+
import {
|
|
58
|
+
GenerateQueryCommandInput,
|
|
59
|
+
GenerateQueryCommandOutput,
|
|
60
|
+
} from "./commands/GenerateQueryCommand";
|
|
57
61
|
import {
|
|
58
62
|
GetAgentMemoryCommandInput,
|
|
59
63
|
GetAgentMemoryCommandOutput,
|
|
@@ -99,6 +103,7 @@ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
|
99
103
|
export { __Client };
|
|
100
104
|
export type ServiceInputTypes =
|
|
101
105
|
| DeleteAgentMemoryCommandInput
|
|
106
|
+
| GenerateQueryCommandInput
|
|
102
107
|
| GetAgentMemoryCommandInput
|
|
103
108
|
| InvokeAgentCommandInput
|
|
104
109
|
| InvokeFlowCommandInput
|
|
@@ -110,6 +115,7 @@ export type ServiceInputTypes =
|
|
|
110
115
|
| RetrieveCommandInput;
|
|
111
116
|
export type ServiceOutputTypes =
|
|
112
117
|
| DeleteAgentMemoryCommandOutput
|
|
118
|
+
| GenerateQueryCommandOutput
|
|
113
119
|
| GetAgentMemoryCommandOutput
|
|
114
120
|
| InvokeAgentCommandOutput
|
|
115
121
|
| InvokeFlowCommandOutput
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import {
|
|
4
|
+
BedrockAgentRuntimeClientResolvedConfig,
|
|
5
|
+
ServiceInputTypes,
|
|
6
|
+
ServiceOutputTypes,
|
|
7
|
+
} from "../BedrockAgentRuntimeClient";
|
|
8
|
+
import {
|
|
9
|
+
GenerateQueryRequest,
|
|
10
|
+
GenerateQueryResponse,
|
|
11
|
+
} from "../models/models_0";
|
|
12
|
+
export { __MetadataBearer };
|
|
13
|
+
export { $Command };
|
|
14
|
+
export interface GenerateQueryCommandInput extends GenerateQueryRequest {}
|
|
15
|
+
export interface GenerateQueryCommandOutput
|
|
16
|
+
extends GenerateQueryResponse,
|
|
17
|
+
__MetadataBearer {}
|
|
18
|
+
declare const GenerateQueryCommand_base: {
|
|
19
|
+
new (
|
|
20
|
+
input: GenerateQueryCommandInput
|
|
21
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
22
|
+
GenerateQueryCommandInput,
|
|
23
|
+
GenerateQueryCommandOutput,
|
|
24
|
+
BedrockAgentRuntimeClientResolvedConfig,
|
|
25
|
+
ServiceInputTypes,
|
|
26
|
+
ServiceOutputTypes
|
|
27
|
+
>;
|
|
28
|
+
new (
|
|
29
|
+
__0_0: GenerateQueryCommandInput
|
|
30
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
31
|
+
GenerateQueryCommandInput,
|
|
32
|
+
GenerateQueryCommandOutput,
|
|
33
|
+
BedrockAgentRuntimeClientResolvedConfig,
|
|
34
|
+
ServiceInputTypes,
|
|
35
|
+
ServiceOutputTypes
|
|
36
|
+
>;
|
|
37
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
38
|
+
};
|
|
39
|
+
export declare class GenerateQueryCommand extends GenerateQueryCommand_base {
|
|
40
|
+
protected static __types: {
|
|
41
|
+
api: {
|
|
42
|
+
input: GenerateQueryRequest;
|
|
43
|
+
output: GenerateQueryResponse;
|
|
44
|
+
};
|
|
45
|
+
sdk: {
|
|
46
|
+
input: GenerateQueryCommandInput;
|
|
47
|
+
output: GenerateQueryCommandOutput;
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
}
|
|
@@ -773,6 +773,52 @@ export declare namespace FlowResponseStream {
|
|
|
773
773
|
export interface InvokeFlowResponse {
|
|
774
774
|
responseStream: AsyncIterable<FlowResponseStream> | undefined;
|
|
775
775
|
}
|
|
776
|
+
export declare const InputQueryType: {
|
|
777
|
+
readonly TEXT: "TEXT";
|
|
778
|
+
};
|
|
779
|
+
export type InputQueryType =
|
|
780
|
+
(typeof InputQueryType)[keyof typeof InputQueryType];
|
|
781
|
+
export interface QueryGenerationInput {
|
|
782
|
+
type: InputQueryType | undefined;
|
|
783
|
+
text: string | undefined;
|
|
784
|
+
}
|
|
785
|
+
export declare const QueryTransformationMode: {
|
|
786
|
+
readonly TEXT_TO_SQL: "TEXT_TO_SQL";
|
|
787
|
+
};
|
|
788
|
+
export type QueryTransformationMode =
|
|
789
|
+
(typeof QueryTransformationMode)[keyof typeof QueryTransformationMode];
|
|
790
|
+
export interface TextToSqlKnowledgeBaseConfiguration {
|
|
791
|
+
knowledgeBaseArn: string | undefined;
|
|
792
|
+
}
|
|
793
|
+
export declare const TextToSqlConfigurationType: {
|
|
794
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
795
|
+
};
|
|
796
|
+
export type TextToSqlConfigurationType =
|
|
797
|
+
(typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType];
|
|
798
|
+
export interface TextToSqlConfiguration {
|
|
799
|
+
type: TextToSqlConfigurationType | undefined;
|
|
800
|
+
knowledgeBaseConfiguration?: TextToSqlKnowledgeBaseConfiguration | undefined;
|
|
801
|
+
}
|
|
802
|
+
export interface TransformationConfiguration {
|
|
803
|
+
mode: QueryTransformationMode | undefined;
|
|
804
|
+
textToSqlConfiguration?: TextToSqlConfiguration | undefined;
|
|
805
|
+
}
|
|
806
|
+
export interface GenerateQueryRequest {
|
|
807
|
+
queryGenerationInput: QueryGenerationInput | undefined;
|
|
808
|
+
transformationConfiguration: TransformationConfiguration | undefined;
|
|
809
|
+
}
|
|
810
|
+
export declare const GeneratedQueryType: {
|
|
811
|
+
readonly REDSHIFT_SQL: "REDSHIFT_SQL";
|
|
812
|
+
};
|
|
813
|
+
export type GeneratedQueryType =
|
|
814
|
+
(typeof GeneratedQueryType)[keyof typeof GeneratedQueryType];
|
|
815
|
+
export interface GeneratedQuery {
|
|
816
|
+
type?: GeneratedQueryType | undefined;
|
|
817
|
+
sql?: string | undefined;
|
|
818
|
+
}
|
|
819
|
+
export interface GenerateQueryResponse {
|
|
820
|
+
queries?: GeneratedQuery[] | undefined;
|
|
821
|
+
}
|
|
776
822
|
export type ContentBlock =
|
|
777
823
|
| ContentBlock.TextMember
|
|
778
824
|
| ContentBlock.$UnknownMember;
|
|
@@ -939,8 +985,33 @@ export interface TextResponsePart {
|
|
|
939
985
|
export interface GeneratedResponsePart {
|
|
940
986
|
textResponsePart?: TextResponsePart | undefined;
|
|
941
987
|
}
|
|
988
|
+
export declare const RetrievalResultContentColumnType: {
|
|
989
|
+
readonly BLOB: "BLOB";
|
|
990
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
991
|
+
readonly DOUBLE: "DOUBLE";
|
|
992
|
+
readonly LONG: "LONG";
|
|
993
|
+
readonly NULL: "NULL";
|
|
994
|
+
readonly STRING: "STRING";
|
|
995
|
+
};
|
|
996
|
+
export type RetrievalResultContentColumnType =
|
|
997
|
+
(typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType];
|
|
998
|
+
export interface RetrievalResultContentColumn {
|
|
999
|
+
columnName?: string | undefined;
|
|
1000
|
+
columnValue?: string | undefined;
|
|
1001
|
+
type?: RetrievalResultContentColumnType | undefined;
|
|
1002
|
+
}
|
|
1003
|
+
export declare const RetrievalResultContentType: {
|
|
1004
|
+
readonly IMAGE: "IMAGE";
|
|
1005
|
+
readonly ROW: "ROW";
|
|
1006
|
+
readonly TEXT: "TEXT";
|
|
1007
|
+
};
|
|
1008
|
+
export type RetrievalResultContentType =
|
|
1009
|
+
(typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType];
|
|
942
1010
|
export interface RetrievalResultContent {
|
|
943
|
-
|
|
1011
|
+
type?: RetrievalResultContentType | undefined;
|
|
1012
|
+
text?: string | undefined;
|
|
1013
|
+
byteContent?: string | undefined;
|
|
1014
|
+
row?: RetrievalResultContentColumn[] | undefined;
|
|
944
1015
|
}
|
|
945
1016
|
export interface RetrievalResultConfluenceLocation {
|
|
946
1017
|
url?: string | undefined;
|
|
@@ -948,6 +1019,9 @@ export interface RetrievalResultConfluenceLocation {
|
|
|
948
1019
|
export interface RetrievalResultCustomDocumentLocation {
|
|
949
1020
|
id?: string | undefined;
|
|
950
1021
|
}
|
|
1022
|
+
export interface RetrievalResultKendraDocumentLocation {
|
|
1023
|
+
uri?: string | undefined;
|
|
1024
|
+
}
|
|
951
1025
|
export interface RetrievalResultS3Location {
|
|
952
1026
|
uri?: string | undefined;
|
|
953
1027
|
}
|
|
@@ -957,12 +1031,17 @@ export interface RetrievalResultSalesforceLocation {
|
|
|
957
1031
|
export interface RetrievalResultSharePointLocation {
|
|
958
1032
|
url?: string | undefined;
|
|
959
1033
|
}
|
|
1034
|
+
export interface RetrievalResultSqlLocation {
|
|
1035
|
+
query?: string | undefined;
|
|
1036
|
+
}
|
|
960
1037
|
export declare const RetrievalResultLocationType: {
|
|
961
1038
|
readonly CONFLUENCE: "CONFLUENCE";
|
|
962
1039
|
readonly CUSTOM: "CUSTOM";
|
|
1040
|
+
readonly KENDRA: "KENDRA";
|
|
963
1041
|
readonly S3: "S3";
|
|
964
1042
|
readonly SALESFORCE: "SALESFORCE";
|
|
965
1043
|
readonly SHAREPOINT: "SHAREPOINT";
|
|
1044
|
+
readonly SQL: "SQL";
|
|
966
1045
|
readonly WEB: "WEB";
|
|
967
1046
|
};
|
|
968
1047
|
export type RetrievalResultLocationType =
|
|
@@ -978,6 +1057,8 @@ export interface RetrievalResultLocation {
|
|
|
978
1057
|
salesforceLocation?: RetrievalResultSalesforceLocation | undefined;
|
|
979
1058
|
sharePointLocation?: RetrievalResultSharePointLocation | undefined;
|
|
980
1059
|
customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined;
|
|
1060
|
+
kendraDocumentLocation?: RetrievalResultKendraDocumentLocation | undefined;
|
|
1061
|
+
sqlLocation?: RetrievalResultSqlLocation | undefined;
|
|
981
1062
|
}
|
|
982
1063
|
export interface RetrievedReference {
|
|
983
1064
|
content?: RetrievalResultContent | undefined;
|
|
@@ -3252,6 +3333,18 @@ export declare const FlowResponseStreamFilterSensitiveLog: (
|
|
|
3252
3333
|
export declare const InvokeFlowResponseFilterSensitiveLog: (
|
|
3253
3334
|
obj: InvokeFlowResponse
|
|
3254
3335
|
) => any;
|
|
3336
|
+
export declare const QueryGenerationInputFilterSensitiveLog: (
|
|
3337
|
+
obj: QueryGenerationInput
|
|
3338
|
+
) => any;
|
|
3339
|
+
export declare const GenerateQueryRequestFilterSensitiveLog: (
|
|
3340
|
+
obj: GenerateQueryRequest
|
|
3341
|
+
) => any;
|
|
3342
|
+
export declare const GeneratedQueryFilterSensitiveLog: (
|
|
3343
|
+
obj: GeneratedQuery
|
|
3344
|
+
) => any;
|
|
3345
|
+
export declare const GenerateQueryResponseFilterSensitiveLog: (
|
|
3346
|
+
obj: GenerateQueryResponse
|
|
3347
|
+
) => any;
|
|
3255
3348
|
export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any;
|
|
3256
3349
|
export declare const MessageFilterSensitiveLog: (obj: Message) => any;
|
|
3257
3350
|
export declare const ConversationHistoryFilterSensitiveLog: (
|
|
@@ -3286,6 +3379,9 @@ export declare const TextResponsePartFilterSensitiveLog: (
|
|
|
3286
3379
|
export declare const GeneratedResponsePartFilterSensitiveLog: (
|
|
3287
3380
|
obj: GeneratedResponsePart
|
|
3288
3381
|
) => any;
|
|
3382
|
+
export declare const RetrievalResultContentColumnFilterSensitiveLog: (
|
|
3383
|
+
obj: RetrievalResultContentColumn
|
|
3384
|
+
) => any;
|
|
3289
3385
|
export declare const RetrievalResultContentFilterSensitiveLog: (
|
|
3290
3386
|
obj: RetrievalResultContent
|
|
3291
3387
|
) => any;
|
|
@@ -10,6 +10,10 @@ import {
|
|
|
10
10
|
DeleteAgentMemoryCommandInput,
|
|
11
11
|
DeleteAgentMemoryCommandOutput,
|
|
12
12
|
} from "../commands/DeleteAgentMemoryCommand";
|
|
13
|
+
import {
|
|
14
|
+
GenerateQueryCommandInput,
|
|
15
|
+
GenerateQueryCommandOutput,
|
|
16
|
+
} from "../commands/GenerateQueryCommand";
|
|
13
17
|
import {
|
|
14
18
|
GetAgentMemoryCommandInput,
|
|
15
19
|
GetAgentMemoryCommandOutput,
|
|
@@ -50,6 +54,10 @@ export declare const se_DeleteAgentMemoryCommand: (
|
|
|
50
54
|
input: DeleteAgentMemoryCommandInput,
|
|
51
55
|
context: __SerdeContext
|
|
52
56
|
) => Promise<__HttpRequest>;
|
|
57
|
+
export declare const se_GenerateQueryCommand: (
|
|
58
|
+
input: GenerateQueryCommandInput,
|
|
59
|
+
context: __SerdeContext
|
|
60
|
+
) => Promise<__HttpRequest>;
|
|
53
61
|
export declare const se_GetAgentMemoryCommand: (
|
|
54
62
|
input: GetAgentMemoryCommandInput,
|
|
55
63
|
context: __SerdeContext
|
|
@@ -90,6 +98,10 @@ export declare const de_DeleteAgentMemoryCommand: (
|
|
|
90
98
|
output: __HttpResponse,
|
|
91
99
|
context: __SerdeContext
|
|
92
100
|
) => Promise<DeleteAgentMemoryCommandOutput>;
|
|
101
|
+
export declare const de_GenerateQueryCommand: (
|
|
102
|
+
output: __HttpResponse,
|
|
103
|
+
context: __SerdeContext
|
|
104
|
+
) => Promise<GenerateQueryCommandOutput>;
|
|
93
105
|
export declare const de_GetAgentMemoryCommand: (
|
|
94
106
|
output: __HttpResponse,
|
|
95
107
|
context: __SerdeContext
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-bedrock-agent-runtime",
|
|
3
3
|
"description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.706.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime",
|