@aws-sdk/client-bedrock 3.995.0 → 3.997.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/dist-cjs/index.js +21 -18
- package/dist-cjs/schemas/schemas_0.js +220 -49
- package/dist-es/models/enums.js +4 -0
- package/dist-es/schemas/schemas_0.js +209 -38
- package/dist-types/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/GetAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +1 -1
- package/dist-types/commands/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsCommand.d.ts +85 -1
- package/dist-types/commands/GetGuardrailCommand.d.ts +2 -1
- package/dist-types/commands/ListAutomatedReasoningPolicyBuildWorkflowsCommand.d.ts +1 -1
- package/dist-types/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/commands/StartAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +11 -1
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/models/enums.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +447 -533
- package/dist-types/models/models_1.d.ts +506 -2
- package/dist-types/schemas/schemas_0.d.ts +14 -0
- package/dist-types/ts3.4/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/enums.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +178 -131
- package/dist-types/ts3.4/models/models_1.d.ts +147 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
- package/package.json +38 -38
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import { AgreementStatus, ApplicationType, AttributeType, AutomatedReasoningCheckLogicWarningType, AutomatedReasoningCheckResult, AutomatedReasoningPolicyAnnotationStatus, AutomatedReasoningPolicyBuildDocumentContentType, AutomatedReasoningPolicyBuildMessageType, AutomatedReasoningPolicyBuildResultAssetType, AutomatedReasoningPolicyBuildWorkflowStatus, AutomatedReasoningPolicyBuildWorkflowType, AutomatedReasoningPolicyTestRunResult, AutomatedReasoningPolicyTestRunStatus, ConfigurationOwner, CustomizationType, CustomModelDeploymentStatus, CustomModelDeploymentUpdateStatus, EvaluationJobStatus, EvaluationJobType, EvaluationTaskType, ExternalSourceType, GuardrailContentFilterAction, GuardrailContentFiltersTierName, GuardrailContentFilterType, GuardrailContextualGroundingAction, GuardrailContextualGroundingFilterType, GuardrailFilterStrength, GuardrailManagedWordsType, GuardrailModality, GuardrailPiiEntityType, GuardrailSensitiveInformationAction,
|
|
2
|
+
import { AgreementStatus, ApplicationType, AttributeType, AutomatedReasoningCheckLogicWarningType, AutomatedReasoningCheckResult, AutomatedReasoningPolicyAnnotationStatus, AutomatedReasoningPolicyBuildDocumentContentType, AutomatedReasoningPolicyBuildMessageType, AutomatedReasoningPolicyBuildResultAssetType, AutomatedReasoningPolicyBuildWorkflowStatus, AutomatedReasoningPolicyBuildWorkflowType, AutomatedReasoningPolicyTestRunResult, AutomatedReasoningPolicyTestRunStatus, ConfigurationOwner, CustomizationType, CustomModelDeploymentStatus, CustomModelDeploymentUpdateStatus, EvaluationJobStatus, EvaluationJobType, EvaluationTaskType, ExternalSourceType, GuardrailContentFilterAction, GuardrailContentFiltersTierName, GuardrailContentFilterType, GuardrailContextualGroundingAction, GuardrailContextualGroundingFilterType, GuardrailFilterStrength, GuardrailManagedWordsType, GuardrailModality, GuardrailPiiEntityType, GuardrailSensitiveInformationAction, GuardrailTopicAction, GuardrailTopicsTierName, GuardrailTopicType, GuardrailWordAction, InputTags, ModelStatus, PerformanceConfigLatency, QueryTransformationType, ReasoningEffort, RerankingMetadataSelectionMode, SortJobsBy, SortModelsBy, SortOrder, Status, VectorSearchRerankingConfigurationType } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* <p>Account-level enforced guardrail input configuration.</p>
|
|
5
5
|
* @public
|
|
@@ -1353,10 +1353,47 @@ export interface GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest {
|
|
|
1353
1353
|
*/
|
|
1354
1354
|
buildWorkflowId: string | undefined;
|
|
1355
1355
|
/**
|
|
1356
|
-
* <p>The type of asset to retrieve (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION).</p>
|
|
1356
|
+
* <p>The type of asset to retrieve (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION, GENERATED_TEST_CASES, POLICY_SCENARIOS, FIDELITY_REPORT, ASSET_MANIFEST, SOURCE_DOCUMENT).</p>
|
|
1357
1357
|
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
assetType: AutomatedReasoningPolicyBuildResultAssetType | undefined;
|
|
1360
|
+
/**
|
|
1361
|
+
* <p>The unique identifier of the specific asset to retrieve when multiple assets of the same type exist. This is required when retrieving SOURCE_DOCUMENT assets, as multiple source documents may have been used in the workflow. The asset ID can be obtained from the asset manifest.</p>
|
|
1362
|
+
* @public
|
|
1363
|
+
*/
|
|
1364
|
+
assetId?: string | undefined;
|
|
1365
|
+
}
|
|
1366
|
+
/**
|
|
1367
|
+
* <p>Represents a single entry in the asset manifest, describing one artifact produced by the build workflow.</p>
|
|
1368
|
+
* @public
|
|
1369
|
+
*/
|
|
1370
|
+
export interface AutomatedReasoningPolicyBuildResultAssetManifestEntry {
|
|
1371
|
+
/**
|
|
1372
|
+
* <p>The type of asset (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION, GENERATED_TEST_CASES, POLICY_SCENARIOS, FIDELITY_REPORT, ASSET_MANIFEST, SOURCE_DOCUMENT).</p>
|
|
1373
|
+
* @public
|
|
1374
|
+
*/
|
|
1375
|
+
assetType: AutomatedReasoningPolicyBuildResultAssetType | undefined;
|
|
1376
|
+
/**
|
|
1377
|
+
* <p>A human-readable name for the asset, if applicable. This helps identify specific documents or reports within the workflow results.</p>
|
|
1378
|
+
* @public
|
|
1379
|
+
*/
|
|
1380
|
+
assetName?: string | undefined;
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>A unique identifier for the asset, if applicable. Use this ID when requesting specific assets through the API.</p>
|
|
1383
|
+
* @public
|
|
1384
|
+
*/
|
|
1385
|
+
assetId?: string | undefined;
|
|
1386
|
+
}
|
|
1387
|
+
/**
|
|
1388
|
+
* <p>A catalog of all artifacts produced by a build workflow, providing a comprehensive list of available assets including their types and identifiers.</p>
|
|
1389
|
+
* @public
|
|
1390
|
+
*/
|
|
1391
|
+
export interface AutomatedReasoningPolicyBuildResultAssetManifest {
|
|
1392
|
+
/**
|
|
1393
|
+
* <p>The list of asset entries in the manifest, each describing an available artifact that can be retrieved.</p>
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1396
|
+
entries: AutomatedReasoningPolicyBuildResultAssetManifestEntry[] | undefined;
|
|
1360
1397
|
}
|
|
1361
1398
|
/**
|
|
1362
1399
|
* <p>A mutation operation that adds a new rule to the policy definition during the build process.</p>
|
|
@@ -1821,6 +1858,274 @@ export interface AutomatedReasoningPolicyBuildLog {
|
|
|
1821
1858
|
*/
|
|
1822
1859
|
entries: AutomatedReasoningPolicyBuildLogEntry[] | undefined;
|
|
1823
1860
|
}
|
|
1861
|
+
/**
|
|
1862
|
+
* <p>Represents a source document that was processed during a build workflow. Contains the document content, metadata, and a hash for verification.</p>
|
|
1863
|
+
* @public
|
|
1864
|
+
*/
|
|
1865
|
+
export interface AutomatedReasoningPolicySourceDocument {
|
|
1866
|
+
/**
|
|
1867
|
+
* <p>The raw content of the source document as a binary blob.</p>
|
|
1868
|
+
* @public
|
|
1869
|
+
*/
|
|
1870
|
+
document: Uint8Array | undefined;
|
|
1871
|
+
/**
|
|
1872
|
+
* <p>The MIME type of the document (e.g., application/pdf, text/plain).</p>
|
|
1873
|
+
* @public
|
|
1874
|
+
*/
|
|
1875
|
+
documentContentType: AutomatedReasoningPolicyBuildDocumentContentType | undefined;
|
|
1876
|
+
/**
|
|
1877
|
+
* <p>The name of the source document for identification purposes.</p>
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1880
|
+
documentName: string | undefined;
|
|
1881
|
+
/**
|
|
1882
|
+
* <p>An optional description providing context about the document's content and purpose.</p>
|
|
1883
|
+
* @public
|
|
1884
|
+
*/
|
|
1885
|
+
documentDescription?: string | undefined;
|
|
1886
|
+
/**
|
|
1887
|
+
* <p>A SHA-256 hash of the document content, used for verification and integrity checking.</p>
|
|
1888
|
+
* @public
|
|
1889
|
+
*/
|
|
1890
|
+
documentHash: string | undefined;
|
|
1891
|
+
}
|
|
1892
|
+
/**
|
|
1893
|
+
* <p>Describes the location of a statement within a source document using line numbers.</p>
|
|
1894
|
+
* @public
|
|
1895
|
+
*/
|
|
1896
|
+
export interface AutomatedReasoningPolicyStatementLocation {
|
|
1897
|
+
/**
|
|
1898
|
+
* <p>The line numbers in the source document where this statement appears.</p>
|
|
1899
|
+
* @public
|
|
1900
|
+
*/
|
|
1901
|
+
lines: number[] | undefined;
|
|
1902
|
+
}
|
|
1903
|
+
/**
|
|
1904
|
+
* <p>Represents a single, indivisible statement extracted from a source document. Atomic statements are the fundamental units used to ground policy rules and variables to their source material.</p>
|
|
1905
|
+
* @public
|
|
1906
|
+
*/
|
|
1907
|
+
export interface AutomatedReasoningPolicyAtomicStatement {
|
|
1908
|
+
/**
|
|
1909
|
+
* <p>A unique identifier for this atomic statement within the fidelity report.</p>
|
|
1910
|
+
* @public
|
|
1911
|
+
*/
|
|
1912
|
+
id: string | undefined;
|
|
1913
|
+
/**
|
|
1914
|
+
* <p>The actual text content of the atomic statement as extracted from the source document.</p>
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
text: string | undefined;
|
|
1918
|
+
/**
|
|
1919
|
+
* <p>Information about where this statement appears in the source document, including line numbers.</p>
|
|
1920
|
+
* @public
|
|
1921
|
+
*/
|
|
1922
|
+
location: AutomatedReasoningPolicyStatementLocation | undefined;
|
|
1923
|
+
}
|
|
1924
|
+
/**
|
|
1925
|
+
* <p>Represents a single line of text from a source document, annotated with its line number for precise referencing.</p>
|
|
1926
|
+
* @public
|
|
1927
|
+
*/
|
|
1928
|
+
export interface AutomatedReasoningPolicyAnnotatedLine {
|
|
1929
|
+
/**
|
|
1930
|
+
* <p>The line number of this text within the source document.</p>
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
lineNumber?: number | undefined;
|
|
1934
|
+
/**
|
|
1935
|
+
* <p>The actual text content of this line from the source document.</p>
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
lineText?: string | undefined;
|
|
1939
|
+
}
|
|
1940
|
+
/**
|
|
1941
|
+
* <p>Represents a content element within an annotated chunk. This union type allows for different types of content elements to be included in document chunks, such as individual lines of text with their line numbers.</p>
|
|
1942
|
+
* @public
|
|
1943
|
+
*/
|
|
1944
|
+
export type AutomatedReasoningPolicyAnnotatedContent = AutomatedReasoningPolicyAnnotatedContent.LineMember | AutomatedReasoningPolicyAnnotatedContent.$UnknownMember;
|
|
1945
|
+
/**
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
export declare namespace AutomatedReasoningPolicyAnnotatedContent {
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>An annotated line of text from the source document, including both the line number and the text content.</p>
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
interface LineMember {
|
|
1954
|
+
line: AutomatedReasoningPolicyAnnotatedLine;
|
|
1955
|
+
$unknown?: never;
|
|
1956
|
+
}
|
|
1957
|
+
/**
|
|
1958
|
+
* @public
|
|
1959
|
+
*/
|
|
1960
|
+
interface $UnknownMember {
|
|
1961
|
+
line?: never;
|
|
1962
|
+
$unknown: [string, any];
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* @deprecated unused in schema-serde mode.
|
|
1966
|
+
*
|
|
1967
|
+
*/
|
|
1968
|
+
interface Visitor<T> {
|
|
1969
|
+
line: (value: AutomatedReasoningPolicyAnnotatedLine) => T;
|
|
1970
|
+
_: (name: string, value: any) => T;
|
|
1971
|
+
}
|
|
1972
|
+
}
|
|
1973
|
+
/**
|
|
1974
|
+
* <p>Represents a portion of a source document with line number annotations. Chunks help organize document content for easier navigation and reference.</p>
|
|
1975
|
+
* @public
|
|
1976
|
+
*/
|
|
1977
|
+
export interface AutomatedReasoningPolicyAnnotatedChunk {
|
|
1978
|
+
/**
|
|
1979
|
+
* <p>The page number where this chunk begins, if the document is divided into pages.</p>
|
|
1980
|
+
* @public
|
|
1981
|
+
*/
|
|
1982
|
+
pageNumber?: number | undefined;
|
|
1983
|
+
/**
|
|
1984
|
+
* <p>The lines of text contained within this chunk, each annotated with its line number.</p>
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1987
|
+
content: AutomatedReasoningPolicyAnnotatedContent[] | undefined;
|
|
1988
|
+
}
|
|
1989
|
+
/**
|
|
1990
|
+
* <p>Represents a source document that was analyzed during fidelity report generation, including the document's metadata and its content broken down into atomic statements.</p>
|
|
1991
|
+
* @public
|
|
1992
|
+
*/
|
|
1993
|
+
export interface AutomatedReasoningPolicyReportSourceDocument {
|
|
1994
|
+
/**
|
|
1995
|
+
* <p>The name of the source document that was analyzed.</p>
|
|
1996
|
+
* @public
|
|
1997
|
+
*/
|
|
1998
|
+
documentName: string | undefined;
|
|
1999
|
+
/**
|
|
2000
|
+
* <p>A SHA-256 hash of the document content, used for verification and ensuring the document hasn't changed since analysis.</p>
|
|
2001
|
+
* @public
|
|
2002
|
+
*/
|
|
2003
|
+
documentHash: string | undefined;
|
|
2004
|
+
/**
|
|
2005
|
+
* <p>A unique identifier for this document within the fidelity report.</p>
|
|
2006
|
+
* @public
|
|
2007
|
+
*/
|
|
2008
|
+
documentId: string | undefined;
|
|
2009
|
+
/**
|
|
2010
|
+
* <p>The list of atomic statements extracted from this document, representing the fundamental units of meaning used for grounding.</p>
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
atomicStatements: AutomatedReasoningPolicyAtomicStatement[] | undefined;
|
|
2014
|
+
/**
|
|
2015
|
+
* <p>The document's content organized into annotated chunks with line number information for precise referencing.</p>
|
|
2016
|
+
* @public
|
|
2017
|
+
*/
|
|
2018
|
+
documentContent: AutomatedReasoningPolicyAnnotatedChunk[] | undefined;
|
|
2019
|
+
}
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>References a specific atomic statement within a source document, used to link policy elements back to their source material.</p>
|
|
2022
|
+
* @public
|
|
2023
|
+
*/
|
|
2024
|
+
export interface AutomatedReasoningPolicyStatementReference {
|
|
2025
|
+
/**
|
|
2026
|
+
* <p>The unique identifier of the document containing the referenced statement.</p>
|
|
2027
|
+
* @public
|
|
2028
|
+
*/
|
|
2029
|
+
documentId: string | undefined;
|
|
2030
|
+
/**
|
|
2031
|
+
* <p>The unique identifier of the specific atomic statement being referenced.</p>
|
|
2032
|
+
* @public
|
|
2033
|
+
*/
|
|
2034
|
+
statementId: string | undefined;
|
|
2035
|
+
}
|
|
2036
|
+
/**
|
|
2037
|
+
* <p>Provides detailed fidelity analysis for a specific policy rule, including which source document statements support it and how accurate the rule is.</p>
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
export interface AutomatedReasoningPolicyRuleReport {
|
|
2041
|
+
/**
|
|
2042
|
+
* <p>The identifier of the policy rule being analyzed in this report.</p>
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
rule: string | undefined;
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>References to statements from the source documents that provide the basis or justification for this rule.</p>
|
|
2048
|
+
* @public
|
|
2049
|
+
*/
|
|
2050
|
+
groundingStatements?: AutomatedReasoningPolicyStatementReference[] | undefined;
|
|
2051
|
+
/**
|
|
2052
|
+
* <p>Explanations describing how the source statements support and justify this specific rule.</p>
|
|
2053
|
+
* @public
|
|
2054
|
+
*/
|
|
2055
|
+
groundingJustifications?: string[] | undefined;
|
|
2056
|
+
/**
|
|
2057
|
+
* <p>A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.</p>
|
|
2058
|
+
* @public
|
|
2059
|
+
*/
|
|
2060
|
+
accuracyScore?: number | undefined;
|
|
2061
|
+
/**
|
|
2062
|
+
* <p>A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.</p>
|
|
2063
|
+
* @public
|
|
2064
|
+
*/
|
|
2065
|
+
accuracyJustification?: string | undefined;
|
|
2066
|
+
}
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>Provides detailed fidelity analysis for a specific policy variable, including which source document statements support it and how accurate the variable definition is.</p>
|
|
2069
|
+
* @public
|
|
2070
|
+
*/
|
|
2071
|
+
export interface AutomatedReasoningPolicyVariableReport {
|
|
2072
|
+
/**
|
|
2073
|
+
* <p>The name of the policy variable being analyzed in this report.</p>
|
|
2074
|
+
* @public
|
|
2075
|
+
*/
|
|
2076
|
+
policyVariable: string | undefined;
|
|
2077
|
+
/**
|
|
2078
|
+
* <p>References to statements from the source documents that provide the basis or justification for this variable.</p>
|
|
2079
|
+
* @public
|
|
2080
|
+
*/
|
|
2081
|
+
groundingStatements?: AutomatedReasoningPolicyStatementReference[] | undefined;
|
|
2082
|
+
/**
|
|
2083
|
+
* <p>Explanations describing how the source statements support and justify this specific variable definition.</p>
|
|
2084
|
+
* @public
|
|
2085
|
+
*/
|
|
2086
|
+
groundingJustifications?: string[] | undefined;
|
|
2087
|
+
/**
|
|
2088
|
+
* <p>A score from 0.0 to 1.0 indicating how accurately this variable represents concepts from the source material.</p>
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
2091
|
+
accuracyScore?: number | undefined;
|
|
2092
|
+
/**
|
|
2093
|
+
* <p>A textual explanation of the accuracy score, describing why the variable received this particular accuracy rating.</p>
|
|
2094
|
+
* @public
|
|
2095
|
+
*/
|
|
2096
|
+
accuracyJustification?: string | undefined;
|
|
2097
|
+
}
|
|
2098
|
+
/**
|
|
2099
|
+
* <p>A comprehensive analysis report that measures how accurately a generated policy represents the source documents. The report includes coverage and accuracy scores, detailed grounding information linking policy elements to source statements, and annotated document content.</p>
|
|
2100
|
+
* @public
|
|
2101
|
+
*/
|
|
2102
|
+
export interface AutomatedReasoningPolicyFidelityReport {
|
|
2103
|
+
/**
|
|
2104
|
+
* <p>A score from 0.0 to 1.0 indicating how well the policy covers the statements in the source documents. A higher score means more of the source content is represented in the policy.</p>
|
|
2105
|
+
* @public
|
|
2106
|
+
*/
|
|
2107
|
+
coverageScore: number | undefined;
|
|
2108
|
+
/**
|
|
2109
|
+
* <p>A score from 0.0 to 1.0 indicating how accurate the policy rules are relative to the source documents. A higher score means the policy rules more faithfully represent the source material.</p>
|
|
2110
|
+
* @public
|
|
2111
|
+
*/
|
|
2112
|
+
accuracyScore: number | undefined;
|
|
2113
|
+
/**
|
|
2114
|
+
* <p>A mapping from rule identifiers to detailed fidelity reports for each rule, showing which source statements ground each rule and how accurate it is.</p>
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
ruleReports: Record<string, AutomatedReasoningPolicyRuleReport> | undefined;
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>A mapping from variable names to detailed fidelity reports for each variable, showing which source statements ground each variable and how accurate it is.</p>
|
|
2120
|
+
* @public
|
|
2121
|
+
*/
|
|
2122
|
+
variableReports: Record<string, AutomatedReasoningPolicyVariableReport> | undefined;
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>A list of source documents with their content broken down into atomic statements and annotated with line numbers for precise referencing.</p>
|
|
2125
|
+
* @public
|
|
2126
|
+
*/
|
|
2127
|
+
documentSources: AutomatedReasoningPolicyReportSourceDocument[] | undefined;
|
|
2128
|
+
}
|
|
1824
2129
|
/**
|
|
1825
2130
|
* <p>Represents a generated test case, consisting of query content, guard content, and expected results.</p>
|
|
1826
2131
|
* @public
|
|
@@ -1972,7 +2277,7 @@ export interface AutomatedReasoningPolicyDefinitionQualityReport {
|
|
|
1972
2277
|
* <p>Contains the various assets generated during a policy build workflow, including logs, quality reports, test cases, and the final policy definition.</p>
|
|
1973
2278
|
* @public
|
|
1974
2279
|
*/
|
|
1975
|
-
export type AutomatedReasoningPolicyBuildResultAssets = AutomatedReasoningPolicyBuildResultAssets.BuildLogMember | AutomatedReasoningPolicyBuildResultAssets.GeneratedTestCasesMember | AutomatedReasoningPolicyBuildResultAssets.PolicyDefinitionMember | AutomatedReasoningPolicyBuildResultAssets.PolicyScenariosMember | AutomatedReasoningPolicyBuildResultAssets.QualityReportMember | AutomatedReasoningPolicyBuildResultAssets.$UnknownMember;
|
|
2280
|
+
export type AutomatedReasoningPolicyBuildResultAssets = AutomatedReasoningPolicyBuildResultAssets.AssetManifestMember | AutomatedReasoningPolicyBuildResultAssets.BuildLogMember | AutomatedReasoningPolicyBuildResultAssets.DocumentMember | AutomatedReasoningPolicyBuildResultAssets.FidelityReportMember | AutomatedReasoningPolicyBuildResultAssets.GeneratedTestCasesMember | AutomatedReasoningPolicyBuildResultAssets.PolicyDefinitionMember | AutomatedReasoningPolicyBuildResultAssets.PolicyScenariosMember | AutomatedReasoningPolicyBuildResultAssets.QualityReportMember | AutomatedReasoningPolicyBuildResultAssets.$UnknownMember;
|
|
1976
2281
|
/**
|
|
1977
2282
|
* @public
|
|
1978
2283
|
*/
|
|
@@ -1987,6 +2292,9 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
1987
2292
|
buildLog?: never;
|
|
1988
2293
|
generatedTestCases?: never;
|
|
1989
2294
|
policyScenarios?: never;
|
|
2295
|
+
assetManifest?: never;
|
|
2296
|
+
document?: never;
|
|
2297
|
+
fidelityReport?: never;
|
|
1990
2298
|
$unknown?: never;
|
|
1991
2299
|
}
|
|
1992
2300
|
/**
|
|
@@ -1999,6 +2307,9 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
1999
2307
|
buildLog?: never;
|
|
2000
2308
|
generatedTestCases?: never;
|
|
2001
2309
|
policyScenarios?: never;
|
|
2310
|
+
assetManifest?: never;
|
|
2311
|
+
document?: never;
|
|
2312
|
+
fidelityReport?: never;
|
|
2002
2313
|
$unknown?: never;
|
|
2003
2314
|
}
|
|
2004
2315
|
/**
|
|
@@ -2011,6 +2322,9 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
2011
2322
|
buildLog: AutomatedReasoningPolicyBuildLog;
|
|
2012
2323
|
generatedTestCases?: never;
|
|
2013
2324
|
policyScenarios?: never;
|
|
2325
|
+
assetManifest?: never;
|
|
2326
|
+
document?: never;
|
|
2327
|
+
fidelityReport?: never;
|
|
2014
2328
|
$unknown?: never;
|
|
2015
2329
|
}
|
|
2016
2330
|
/**
|
|
@@ -2023,6 +2337,9 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
2023
2337
|
buildLog?: never;
|
|
2024
2338
|
generatedTestCases: AutomatedReasoningPolicyGeneratedTestCases;
|
|
2025
2339
|
policyScenarios?: never;
|
|
2340
|
+
assetManifest?: never;
|
|
2341
|
+
document?: never;
|
|
2342
|
+
fidelityReport?: never;
|
|
2026
2343
|
$unknown?: never;
|
|
2027
2344
|
}
|
|
2028
2345
|
/**
|
|
@@ -2035,6 +2352,54 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
2035
2352
|
buildLog?: never;
|
|
2036
2353
|
generatedTestCases?: never;
|
|
2037
2354
|
policyScenarios: AutomatedReasoningPolicyScenarios;
|
|
2355
|
+
assetManifest?: never;
|
|
2356
|
+
document?: never;
|
|
2357
|
+
fidelityReport?: never;
|
|
2358
|
+
$unknown?: never;
|
|
2359
|
+
}
|
|
2360
|
+
/**
|
|
2361
|
+
* <p>A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.</p>
|
|
2362
|
+
* @public
|
|
2363
|
+
*/
|
|
2364
|
+
interface AssetManifestMember {
|
|
2365
|
+
policyDefinition?: never;
|
|
2366
|
+
qualityReport?: never;
|
|
2367
|
+
buildLog?: never;
|
|
2368
|
+
generatedTestCases?: never;
|
|
2369
|
+
policyScenarios?: never;
|
|
2370
|
+
assetManifest: AutomatedReasoningPolicyBuildResultAssetManifest;
|
|
2371
|
+
document?: never;
|
|
2372
|
+
fidelityReport?: never;
|
|
2373
|
+
$unknown?: never;
|
|
2374
|
+
}
|
|
2375
|
+
/**
|
|
2376
|
+
* <p>A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.</p>
|
|
2377
|
+
* @public
|
|
2378
|
+
*/
|
|
2379
|
+
interface DocumentMember {
|
|
2380
|
+
policyDefinition?: never;
|
|
2381
|
+
qualityReport?: never;
|
|
2382
|
+
buildLog?: never;
|
|
2383
|
+
generatedTestCases?: never;
|
|
2384
|
+
policyScenarios?: never;
|
|
2385
|
+
assetManifest?: never;
|
|
2386
|
+
document: AutomatedReasoningPolicySourceDocument;
|
|
2387
|
+
fidelityReport?: never;
|
|
2388
|
+
$unknown?: never;
|
|
2389
|
+
}
|
|
2390
|
+
/**
|
|
2391
|
+
* <p>A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.</p>
|
|
2392
|
+
* @public
|
|
2393
|
+
*/
|
|
2394
|
+
interface FidelityReportMember {
|
|
2395
|
+
policyDefinition?: never;
|
|
2396
|
+
qualityReport?: never;
|
|
2397
|
+
buildLog?: never;
|
|
2398
|
+
generatedTestCases?: never;
|
|
2399
|
+
policyScenarios?: never;
|
|
2400
|
+
assetManifest?: never;
|
|
2401
|
+
document?: never;
|
|
2402
|
+
fidelityReport: AutomatedReasoningPolicyFidelityReport;
|
|
2038
2403
|
$unknown?: never;
|
|
2039
2404
|
}
|
|
2040
2405
|
/**
|
|
@@ -2046,6 +2411,9 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
2046
2411
|
buildLog?: never;
|
|
2047
2412
|
generatedTestCases?: never;
|
|
2048
2413
|
policyScenarios?: never;
|
|
2414
|
+
assetManifest?: never;
|
|
2415
|
+
document?: never;
|
|
2416
|
+
fidelityReport?: never;
|
|
2049
2417
|
$unknown: [string, any];
|
|
2050
2418
|
}
|
|
2051
2419
|
/**
|
|
@@ -2058,6 +2426,9 @@ export declare namespace AutomatedReasoningPolicyBuildResultAssets {
|
|
|
2058
2426
|
buildLog: (value: AutomatedReasoningPolicyBuildLog) => T;
|
|
2059
2427
|
generatedTestCases: (value: AutomatedReasoningPolicyGeneratedTestCases) => T;
|
|
2060
2428
|
policyScenarios: (value: AutomatedReasoningPolicyScenarios) => T;
|
|
2429
|
+
assetManifest: (value: AutomatedReasoningPolicyBuildResultAssetManifest) => T;
|
|
2430
|
+
document: (value: AutomatedReasoningPolicySourceDocument) => T;
|
|
2431
|
+
fidelityReport: (value: AutomatedReasoningPolicyFidelityReport) => T;
|
|
2061
2432
|
_: (name: string, value: any) => T;
|
|
2062
2433
|
}
|
|
2063
2434
|
}
|
|
@@ -2876,41 +3247,20 @@ export interface AutomatedReasoningPolicyBuildWorkflowDocument {
|
|
|
2876
3247
|
documentDescription?: string | undefined;
|
|
2877
3248
|
}
|
|
2878
3249
|
/**
|
|
2879
|
-
* <p>
|
|
2880
|
-
* @public
|
|
2881
|
-
*/
|
|
2882
|
-
export interface AutomatedReasoningPolicyBuildWorkflowRepairContent {
|
|
2883
|
-
/**
|
|
2884
|
-
* <p>Specific annotations or modifications to apply during the policy repair process, such as rule corrections or variable updates.</p>
|
|
2885
|
-
* @public
|
|
2886
|
-
*/
|
|
2887
|
-
annotations: AutomatedReasoningPolicyAnnotation[] | undefined;
|
|
2888
|
-
}
|
|
2889
|
-
/**
|
|
2890
|
-
* <p>Defines the content and configuration for different types of policy build workflows.</p>
|
|
3250
|
+
* <p>Configuration for generating a fidelity report, which can either analyze new documents or update an existing fidelity report with a new policy definition.</p>
|
|
2891
3251
|
* @public
|
|
2892
3252
|
*/
|
|
2893
|
-
export type
|
|
3253
|
+
export type AutomatedReasoningPolicyGenerateFidelityReportContent = AutomatedReasoningPolicyGenerateFidelityReportContent.DocumentsMember | AutomatedReasoningPolicyGenerateFidelityReportContent.$UnknownMember;
|
|
2894
3254
|
/**
|
|
2895
3255
|
* @public
|
|
2896
3256
|
*/
|
|
2897
|
-
export declare namespace
|
|
3257
|
+
export declare namespace AutomatedReasoningPolicyGenerateFidelityReportContent {
|
|
2898
3258
|
/**
|
|
2899
|
-
* <p>
|
|
3259
|
+
* <p>Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.</p>
|
|
2900
3260
|
* @public
|
|
2901
3261
|
*/
|
|
2902
3262
|
interface DocumentsMember {
|
|
2903
3263
|
documents: AutomatedReasoningPolicyBuildWorkflowDocument[];
|
|
2904
|
-
policyRepairAssets?: never;
|
|
2905
|
-
$unknown?: never;
|
|
2906
|
-
}
|
|
2907
|
-
/**
|
|
2908
|
-
* <p>The assets and instructions needed for a policy repair workflow, including repair annotations and guidance.</p>
|
|
2909
|
-
* @public
|
|
2910
|
-
*/
|
|
2911
|
-
interface PolicyRepairAssetsMember {
|
|
2912
|
-
documents?: never;
|
|
2913
|
-
policyRepairAssets: AutomatedReasoningPolicyBuildWorkflowRepairContent;
|
|
2914
3264
|
$unknown?: never;
|
|
2915
3265
|
}
|
|
2916
3266
|
/**
|
|
@@ -2918,7 +3268,74 @@ export declare namespace AutomatedReasoningPolicyWorkflowTypeContent {
|
|
|
2918
3268
|
*/
|
|
2919
3269
|
interface $UnknownMember {
|
|
2920
3270
|
documents?: never;
|
|
2921
|
-
|
|
3271
|
+
$unknown: [string, any];
|
|
3272
|
+
}
|
|
3273
|
+
/**
|
|
3274
|
+
* @deprecated unused in schema-serde mode.
|
|
3275
|
+
*
|
|
3276
|
+
*/
|
|
3277
|
+
interface Visitor<T> {
|
|
3278
|
+
documents: (value: AutomatedReasoningPolicyBuildWorkflowDocument[]) => T;
|
|
3279
|
+
_: (name: string, value: any) => T;
|
|
3280
|
+
}
|
|
3281
|
+
}
|
|
3282
|
+
/**
|
|
3283
|
+
* <p>Contains content and instructions for repairing or improving an existing Automated Reasoning policy.</p>
|
|
3284
|
+
* @public
|
|
3285
|
+
*/
|
|
3286
|
+
export interface AutomatedReasoningPolicyBuildWorkflowRepairContent {
|
|
3287
|
+
/**
|
|
3288
|
+
* <p>Specific annotations or modifications to apply during the policy repair process, such as rule corrections or variable updates.</p>
|
|
3289
|
+
* @public
|
|
3290
|
+
*/
|
|
3291
|
+
annotations: AutomatedReasoningPolicyAnnotation[] | undefined;
|
|
3292
|
+
}
|
|
3293
|
+
/**
|
|
3294
|
+
* <p>Defines the content and configuration for different types of policy build workflows.</p>
|
|
3295
|
+
* @public
|
|
3296
|
+
*/
|
|
3297
|
+
export type AutomatedReasoningPolicyWorkflowTypeContent = AutomatedReasoningPolicyWorkflowTypeContent.DocumentsMember | AutomatedReasoningPolicyWorkflowTypeContent.GenerateFidelityReportContentMember | AutomatedReasoningPolicyWorkflowTypeContent.PolicyRepairAssetsMember | AutomatedReasoningPolicyWorkflowTypeContent.$UnknownMember;
|
|
3298
|
+
/**
|
|
3299
|
+
* @public
|
|
3300
|
+
*/
|
|
3301
|
+
export declare namespace AutomatedReasoningPolicyWorkflowTypeContent {
|
|
3302
|
+
/**
|
|
3303
|
+
* <p>The list of documents to be processed in a document ingestion workflow.</p>
|
|
3304
|
+
* @public
|
|
3305
|
+
*/
|
|
3306
|
+
interface DocumentsMember {
|
|
3307
|
+
documents: AutomatedReasoningPolicyBuildWorkflowDocument[];
|
|
3308
|
+
policyRepairAssets?: never;
|
|
3309
|
+
generateFidelityReportContent?: never;
|
|
3310
|
+
$unknown?: never;
|
|
3311
|
+
}
|
|
3312
|
+
/**
|
|
3313
|
+
* <p>The assets and instructions needed for a policy repair workflow, including repair annotations and guidance.</p>
|
|
3314
|
+
* @public
|
|
3315
|
+
*/
|
|
3316
|
+
interface PolicyRepairAssetsMember {
|
|
3317
|
+
documents?: never;
|
|
3318
|
+
policyRepairAssets: AutomatedReasoningPolicyBuildWorkflowRepairContent;
|
|
3319
|
+
generateFidelityReportContent?: never;
|
|
3320
|
+
$unknown?: never;
|
|
3321
|
+
}
|
|
3322
|
+
/**
|
|
3323
|
+
* <p>The content configuration for generating a fidelity report workflow. This can include source documents to analyze or an existing fidelity report to update with a new policy definition.</p>
|
|
3324
|
+
* @public
|
|
3325
|
+
*/
|
|
3326
|
+
interface GenerateFidelityReportContentMember {
|
|
3327
|
+
documents?: never;
|
|
3328
|
+
policyRepairAssets?: never;
|
|
3329
|
+
generateFidelityReportContent: AutomatedReasoningPolicyGenerateFidelityReportContent;
|
|
3330
|
+
$unknown?: never;
|
|
3331
|
+
}
|
|
3332
|
+
/**
|
|
3333
|
+
* @public
|
|
3334
|
+
*/
|
|
3335
|
+
interface $UnknownMember {
|
|
3336
|
+
documents?: never;
|
|
3337
|
+
policyRepairAssets?: never;
|
|
3338
|
+
generateFidelityReportContent?: never;
|
|
2922
3339
|
$unknown: [string, any];
|
|
2923
3340
|
}
|
|
2924
3341
|
/**
|
|
@@ -2928,6 +3345,7 @@ export declare namespace AutomatedReasoningPolicyWorkflowTypeContent {
|
|
|
2928
3345
|
interface Visitor<T> {
|
|
2929
3346
|
documents: (value: AutomatedReasoningPolicyBuildWorkflowDocument[]) => T;
|
|
2930
3347
|
policyRepairAssets: (value: AutomatedReasoningPolicyBuildWorkflowRepairContent) => T;
|
|
3348
|
+
generateFidelityReportContent: (value: AutomatedReasoningPolicyGenerateFidelityReportContent) => T;
|
|
2931
3349
|
_: (name: string, value: any) => T;
|
|
2932
3350
|
}
|
|
2933
3351
|
}
|
|
@@ -6634,507 +7052,3 @@ export interface GuardrailTopicsTier {
|
|
|
6634
7052
|
*/
|
|
6635
7053
|
tierName: GuardrailTopicsTierName | undefined;
|
|
6636
7054
|
}
|
|
6637
|
-
/**
|
|
6638
|
-
* <p>Details about topics for the guardrail to identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
6639
|
-
* @public
|
|
6640
|
-
*/
|
|
6641
|
-
export interface GuardrailTopic {
|
|
6642
|
-
/**
|
|
6643
|
-
* <p>The name of the topic to deny.</p>
|
|
6644
|
-
* @public
|
|
6645
|
-
*/
|
|
6646
|
-
name: string | undefined;
|
|
6647
|
-
/**
|
|
6648
|
-
* <p>A definition of the topic to deny.</p>
|
|
6649
|
-
* @public
|
|
6650
|
-
*/
|
|
6651
|
-
definition: string | undefined;
|
|
6652
|
-
/**
|
|
6653
|
-
* <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
|
|
6654
|
-
* @public
|
|
6655
|
-
*/
|
|
6656
|
-
examples?: string[] | undefined;
|
|
6657
|
-
/**
|
|
6658
|
-
* <p>Specifies to deny the topic.</p>
|
|
6659
|
-
* @public
|
|
6660
|
-
*/
|
|
6661
|
-
type?: GuardrailTopicType | undefined;
|
|
6662
|
-
/**
|
|
6663
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6664
|
-
* @public
|
|
6665
|
-
*/
|
|
6666
|
-
inputAction?: GuardrailTopicAction | undefined;
|
|
6667
|
-
/**
|
|
6668
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6669
|
-
* @public
|
|
6670
|
-
*/
|
|
6671
|
-
outputAction?: GuardrailTopicAction | undefined;
|
|
6672
|
-
/**
|
|
6673
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6674
|
-
* @public
|
|
6675
|
-
*/
|
|
6676
|
-
inputEnabled?: boolean | undefined;
|
|
6677
|
-
/**
|
|
6678
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6679
|
-
* @public
|
|
6680
|
-
*/
|
|
6681
|
-
outputEnabled?: boolean | undefined;
|
|
6682
|
-
}
|
|
6683
|
-
/**
|
|
6684
|
-
* <p>Contains details about topics that the guardrail should identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
6685
|
-
* @public
|
|
6686
|
-
*/
|
|
6687
|
-
export interface GuardrailTopicPolicy {
|
|
6688
|
-
/**
|
|
6689
|
-
* <p>A list of policies related to topics that the guardrail should deny.</p>
|
|
6690
|
-
* @public
|
|
6691
|
-
*/
|
|
6692
|
-
topics: GuardrailTopic[] | undefined;
|
|
6693
|
-
/**
|
|
6694
|
-
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
6695
|
-
* @public
|
|
6696
|
-
*/
|
|
6697
|
-
tier?: GuardrailTopicsTier | undefined;
|
|
6698
|
-
}
|
|
6699
|
-
/**
|
|
6700
|
-
* <p>The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)</p>
|
|
6701
|
-
* @public
|
|
6702
|
-
*/
|
|
6703
|
-
export interface GuardrailManagedWords {
|
|
6704
|
-
/**
|
|
6705
|
-
* <p>ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)</p>
|
|
6706
|
-
* @public
|
|
6707
|
-
*/
|
|
6708
|
-
type: GuardrailManagedWordsType | undefined;
|
|
6709
|
-
/**
|
|
6710
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6711
|
-
* @public
|
|
6712
|
-
*/
|
|
6713
|
-
inputAction?: GuardrailWordAction | undefined;
|
|
6714
|
-
/**
|
|
6715
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6716
|
-
* @public
|
|
6717
|
-
*/
|
|
6718
|
-
outputAction?: GuardrailWordAction | undefined;
|
|
6719
|
-
/**
|
|
6720
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6721
|
-
* @public
|
|
6722
|
-
*/
|
|
6723
|
-
inputEnabled?: boolean | undefined;
|
|
6724
|
-
/**
|
|
6725
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6726
|
-
* @public
|
|
6727
|
-
*/
|
|
6728
|
-
outputEnabled?: boolean | undefined;
|
|
6729
|
-
}
|
|
6730
|
-
/**
|
|
6731
|
-
* <p>A word configured for the guardrail.</p>
|
|
6732
|
-
* @public
|
|
6733
|
-
*/
|
|
6734
|
-
export interface GuardrailWord {
|
|
6735
|
-
/**
|
|
6736
|
-
* <p>Text of the word configured for the guardrail to block.</p>
|
|
6737
|
-
* @public
|
|
6738
|
-
*/
|
|
6739
|
-
text: string | undefined;
|
|
6740
|
-
/**
|
|
6741
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6742
|
-
* @public
|
|
6743
|
-
*/
|
|
6744
|
-
inputAction?: GuardrailWordAction | undefined;
|
|
6745
|
-
/**
|
|
6746
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6747
|
-
* @public
|
|
6748
|
-
*/
|
|
6749
|
-
outputAction?: GuardrailWordAction | undefined;
|
|
6750
|
-
/**
|
|
6751
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6752
|
-
* @public
|
|
6753
|
-
*/
|
|
6754
|
-
inputEnabled?: boolean | undefined;
|
|
6755
|
-
/**
|
|
6756
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6757
|
-
* @public
|
|
6758
|
-
*/
|
|
6759
|
-
outputEnabled?: boolean | undefined;
|
|
6760
|
-
}
|
|
6761
|
-
/**
|
|
6762
|
-
* <p>Contains details about the word policy configured for the guardrail.</p>
|
|
6763
|
-
* @public
|
|
6764
|
-
*/
|
|
6765
|
-
export interface GuardrailWordPolicy {
|
|
6766
|
-
/**
|
|
6767
|
-
* <p>A list of words configured for the guardrail.</p>
|
|
6768
|
-
* @public
|
|
6769
|
-
*/
|
|
6770
|
-
words?: GuardrailWord[] | undefined;
|
|
6771
|
-
/**
|
|
6772
|
-
* <p>A list of managed words configured for the guardrail.</p>
|
|
6773
|
-
* @public
|
|
6774
|
-
*/
|
|
6775
|
-
managedWordLists?: GuardrailManagedWords[] | undefined;
|
|
6776
|
-
}
|
|
6777
|
-
/**
|
|
6778
|
-
* @public
|
|
6779
|
-
*/
|
|
6780
|
-
export interface GetGuardrailResponse {
|
|
6781
|
-
/**
|
|
6782
|
-
* <p>The name of the guardrail.</p>
|
|
6783
|
-
* @public
|
|
6784
|
-
*/
|
|
6785
|
-
name: string | undefined;
|
|
6786
|
-
/**
|
|
6787
|
-
* <p>The description of the guardrail.</p>
|
|
6788
|
-
* @public
|
|
6789
|
-
*/
|
|
6790
|
-
description?: string | undefined;
|
|
6791
|
-
/**
|
|
6792
|
-
* <p>The unique identifier of the guardrail.</p>
|
|
6793
|
-
* @public
|
|
6794
|
-
*/
|
|
6795
|
-
guardrailId: string | undefined;
|
|
6796
|
-
/**
|
|
6797
|
-
* <p>The ARN of the guardrail.</p>
|
|
6798
|
-
* @public
|
|
6799
|
-
*/
|
|
6800
|
-
guardrailArn: string | undefined;
|
|
6801
|
-
/**
|
|
6802
|
-
* <p>The version of the guardrail.</p>
|
|
6803
|
-
* @public
|
|
6804
|
-
*/
|
|
6805
|
-
version: string | undefined;
|
|
6806
|
-
/**
|
|
6807
|
-
* <p>The status of the guardrail.</p>
|
|
6808
|
-
* @public
|
|
6809
|
-
*/
|
|
6810
|
-
status: GuardrailStatus | undefined;
|
|
6811
|
-
/**
|
|
6812
|
-
* <p>The topic policy that was configured for the guardrail.</p>
|
|
6813
|
-
* @public
|
|
6814
|
-
*/
|
|
6815
|
-
topicPolicy?: GuardrailTopicPolicy | undefined;
|
|
6816
|
-
/**
|
|
6817
|
-
* <p>The content policy that was configured for the guardrail.</p>
|
|
6818
|
-
* @public
|
|
6819
|
-
*/
|
|
6820
|
-
contentPolicy?: GuardrailContentPolicy | undefined;
|
|
6821
|
-
/**
|
|
6822
|
-
* <p>The word policy that was configured for the guardrail.</p>
|
|
6823
|
-
* @public
|
|
6824
|
-
*/
|
|
6825
|
-
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
6826
|
-
/**
|
|
6827
|
-
* <p>The sensitive information policy that was configured for the guardrail.</p>
|
|
6828
|
-
* @public
|
|
6829
|
-
*/
|
|
6830
|
-
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy | undefined;
|
|
6831
|
-
/**
|
|
6832
|
-
* <p>The contextual grounding policy used in the guardrail.</p>
|
|
6833
|
-
* @public
|
|
6834
|
-
*/
|
|
6835
|
-
contextualGroundingPolicy?: GuardrailContextualGroundingPolicy | undefined;
|
|
6836
|
-
/**
|
|
6837
|
-
* <p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>
|
|
6838
|
-
* @public
|
|
6839
|
-
*/
|
|
6840
|
-
automatedReasoningPolicy?: GuardrailAutomatedReasoningPolicy | undefined;
|
|
6841
|
-
/**
|
|
6842
|
-
* <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
|
|
6843
|
-
* @public
|
|
6844
|
-
*/
|
|
6845
|
-
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
6846
|
-
/**
|
|
6847
|
-
* <p>The date and time at which the guardrail was created.</p>
|
|
6848
|
-
* @public
|
|
6849
|
-
*/
|
|
6850
|
-
createdAt: Date | undefined;
|
|
6851
|
-
/**
|
|
6852
|
-
* <p>The date and time at which the guardrail was updated.</p>
|
|
6853
|
-
* @public
|
|
6854
|
-
*/
|
|
6855
|
-
updatedAt: Date | undefined;
|
|
6856
|
-
/**
|
|
6857
|
-
* <p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>
|
|
6858
|
-
* @public
|
|
6859
|
-
*/
|
|
6860
|
-
statusReasons?: string[] | undefined;
|
|
6861
|
-
/**
|
|
6862
|
-
* <p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>
|
|
6863
|
-
* @public
|
|
6864
|
-
*/
|
|
6865
|
-
failureRecommendations?: string[] | undefined;
|
|
6866
|
-
/**
|
|
6867
|
-
* <p>The message that the guardrail returns when it blocks a prompt.</p>
|
|
6868
|
-
* @public
|
|
6869
|
-
*/
|
|
6870
|
-
blockedInputMessaging: string | undefined;
|
|
6871
|
-
/**
|
|
6872
|
-
* <p>The message that the guardrail returns when it blocks a model response.</p>
|
|
6873
|
-
* @public
|
|
6874
|
-
*/
|
|
6875
|
-
blockedOutputsMessaging: string | undefined;
|
|
6876
|
-
/**
|
|
6877
|
-
* <p>The ARN of the KMS key that encrypts the guardrail.</p>
|
|
6878
|
-
* @public
|
|
6879
|
-
*/
|
|
6880
|
-
kmsKeyArn?: string | undefined;
|
|
6881
|
-
}
|
|
6882
|
-
/**
|
|
6883
|
-
* @public
|
|
6884
|
-
*/
|
|
6885
|
-
export interface ListGuardrailsRequest {
|
|
6886
|
-
/**
|
|
6887
|
-
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
6888
|
-
* @public
|
|
6889
|
-
*/
|
|
6890
|
-
guardrailIdentifier?: string | undefined;
|
|
6891
|
-
/**
|
|
6892
|
-
* <p>The maximum number of results to return in the response.</p>
|
|
6893
|
-
* @public
|
|
6894
|
-
*/
|
|
6895
|
-
maxResults?: number | undefined;
|
|
6896
|
-
/**
|
|
6897
|
-
* <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
|
|
6898
|
-
* @public
|
|
6899
|
-
*/
|
|
6900
|
-
nextToken?: string | undefined;
|
|
6901
|
-
}
|
|
6902
|
-
/**
|
|
6903
|
-
* <p>Contains details about a guardrail.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax">ListGuardrails response body</a> </p> </li> </ul>
|
|
6904
|
-
* @public
|
|
6905
|
-
*/
|
|
6906
|
-
export interface GuardrailSummary {
|
|
6907
|
-
/**
|
|
6908
|
-
* <p>The unique identifier of the guardrail.</p>
|
|
6909
|
-
* @public
|
|
6910
|
-
*/
|
|
6911
|
-
id: string | undefined;
|
|
6912
|
-
/**
|
|
6913
|
-
* <p>The ARN of the guardrail.</p>
|
|
6914
|
-
* @public
|
|
6915
|
-
*/
|
|
6916
|
-
arn: string | undefined;
|
|
6917
|
-
/**
|
|
6918
|
-
* <p>The status of the guardrail.</p>
|
|
6919
|
-
* @public
|
|
6920
|
-
*/
|
|
6921
|
-
status: GuardrailStatus | undefined;
|
|
6922
|
-
/**
|
|
6923
|
-
* <p>The name of the guardrail.</p>
|
|
6924
|
-
* @public
|
|
6925
|
-
*/
|
|
6926
|
-
name: string | undefined;
|
|
6927
|
-
/**
|
|
6928
|
-
* <p>A description of the guardrail.</p>
|
|
6929
|
-
* @public
|
|
6930
|
-
*/
|
|
6931
|
-
description?: string | undefined;
|
|
6932
|
-
/**
|
|
6933
|
-
* <p>The version of the guardrail.</p>
|
|
6934
|
-
* @public
|
|
6935
|
-
*/
|
|
6936
|
-
version: string | undefined;
|
|
6937
|
-
/**
|
|
6938
|
-
* <p>The date and time at which the guardrail was created.</p>
|
|
6939
|
-
* @public
|
|
6940
|
-
*/
|
|
6941
|
-
createdAt: Date | undefined;
|
|
6942
|
-
/**
|
|
6943
|
-
* <p>The date and time at which the guardrail was last updated.</p>
|
|
6944
|
-
* @public
|
|
6945
|
-
*/
|
|
6946
|
-
updatedAt: Date | undefined;
|
|
6947
|
-
/**
|
|
6948
|
-
* <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
|
|
6949
|
-
* @public
|
|
6950
|
-
*/
|
|
6951
|
-
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
6952
|
-
}
|
|
6953
|
-
/**
|
|
6954
|
-
* @public
|
|
6955
|
-
*/
|
|
6956
|
-
export interface ListGuardrailsResponse {
|
|
6957
|
-
/**
|
|
6958
|
-
* <p>A list of objects, each of which contains details about a guardrail.</p>
|
|
6959
|
-
* @public
|
|
6960
|
-
*/
|
|
6961
|
-
guardrails: GuardrailSummary[] | undefined;
|
|
6962
|
-
/**
|
|
6963
|
-
* <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
|
|
6964
|
-
* @public
|
|
6965
|
-
*/
|
|
6966
|
-
nextToken?: string | undefined;
|
|
6967
|
-
}
|
|
6968
|
-
/**
|
|
6969
|
-
* @public
|
|
6970
|
-
*/
|
|
6971
|
-
export interface UpdateGuardrailRequest {
|
|
6972
|
-
/**
|
|
6973
|
-
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
6974
|
-
* @public
|
|
6975
|
-
*/
|
|
6976
|
-
guardrailIdentifier: string | undefined;
|
|
6977
|
-
/**
|
|
6978
|
-
* <p>A name for the guardrail.</p>
|
|
6979
|
-
* @public
|
|
6980
|
-
*/
|
|
6981
|
-
name: string | undefined;
|
|
6982
|
-
/**
|
|
6983
|
-
* <p>A description of the guardrail.</p>
|
|
6984
|
-
* @public
|
|
6985
|
-
*/
|
|
6986
|
-
description?: string | undefined;
|
|
6987
|
-
/**
|
|
6988
|
-
* <p>The topic policy to configure for the guardrail.</p>
|
|
6989
|
-
* @public
|
|
6990
|
-
*/
|
|
6991
|
-
topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
|
|
6992
|
-
/**
|
|
6993
|
-
* <p>The content policy to configure for the guardrail.</p>
|
|
6994
|
-
* @public
|
|
6995
|
-
*/
|
|
6996
|
-
contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
|
|
6997
|
-
/**
|
|
6998
|
-
* <p>The word policy to configure for the guardrail.</p>
|
|
6999
|
-
* @public
|
|
7000
|
-
*/
|
|
7001
|
-
wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
|
|
7002
|
-
/**
|
|
7003
|
-
* <p>The sensitive information policy to configure for the guardrail.</p>
|
|
7004
|
-
* @public
|
|
7005
|
-
*/
|
|
7006
|
-
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
|
|
7007
|
-
/**
|
|
7008
|
-
* <p>The contextual grounding policy configuration used to update a guardrail.</p>
|
|
7009
|
-
* @public
|
|
7010
|
-
*/
|
|
7011
|
-
contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
|
|
7012
|
-
/**
|
|
7013
|
-
* <p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p>
|
|
7014
|
-
* @public
|
|
7015
|
-
*/
|
|
7016
|
-
automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
|
|
7017
|
-
/**
|
|
7018
|
-
* <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
7019
|
-
* @public
|
|
7020
|
-
*/
|
|
7021
|
-
crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
|
|
7022
|
-
/**
|
|
7023
|
-
* <p>The message to return when the guardrail blocks a prompt.</p>
|
|
7024
|
-
* @public
|
|
7025
|
-
*/
|
|
7026
|
-
blockedInputMessaging: string | undefined;
|
|
7027
|
-
/**
|
|
7028
|
-
* <p>The message to return when the guardrail blocks a model response.</p>
|
|
7029
|
-
* @public
|
|
7030
|
-
*/
|
|
7031
|
-
blockedOutputsMessaging: string | undefined;
|
|
7032
|
-
/**
|
|
7033
|
-
* <p>The ARN of the KMS key with which to encrypt the guardrail.</p>
|
|
7034
|
-
* @public
|
|
7035
|
-
*/
|
|
7036
|
-
kmsKeyId?: string | undefined;
|
|
7037
|
-
}
|
|
7038
|
-
/**
|
|
7039
|
-
* @public
|
|
7040
|
-
*/
|
|
7041
|
-
export interface UpdateGuardrailResponse {
|
|
7042
|
-
/**
|
|
7043
|
-
* <p>The unique identifier of the guardrail</p>
|
|
7044
|
-
* @public
|
|
7045
|
-
*/
|
|
7046
|
-
guardrailId: string | undefined;
|
|
7047
|
-
/**
|
|
7048
|
-
* <p>The ARN of the guardrail.</p>
|
|
7049
|
-
* @public
|
|
7050
|
-
*/
|
|
7051
|
-
guardrailArn: string | undefined;
|
|
7052
|
-
/**
|
|
7053
|
-
* <p>The version of the guardrail.</p>
|
|
7054
|
-
* @public
|
|
7055
|
-
*/
|
|
7056
|
-
version: string | undefined;
|
|
7057
|
-
/**
|
|
7058
|
-
* <p>The date and time at which the guardrail was updated.</p>
|
|
7059
|
-
* @public
|
|
7060
|
-
*/
|
|
7061
|
-
updatedAt: Date | undefined;
|
|
7062
|
-
}
|
|
7063
|
-
/**
|
|
7064
|
-
* <p>Contains information about the model or system-defined inference profile that is the source for an inference profile..</p>
|
|
7065
|
-
* @public
|
|
7066
|
-
*/
|
|
7067
|
-
export type InferenceProfileModelSource = InferenceProfileModelSource.CopyFromMember | InferenceProfileModelSource.$UnknownMember;
|
|
7068
|
-
/**
|
|
7069
|
-
* @public
|
|
7070
|
-
*/
|
|
7071
|
-
export declare namespace InferenceProfileModelSource {
|
|
7072
|
-
/**
|
|
7073
|
-
* <p>The ARN of the model or system-defined inference profile that is the source for the inference profile.</p>
|
|
7074
|
-
* @public
|
|
7075
|
-
*/
|
|
7076
|
-
interface CopyFromMember {
|
|
7077
|
-
copyFrom: string;
|
|
7078
|
-
$unknown?: never;
|
|
7079
|
-
}
|
|
7080
|
-
/**
|
|
7081
|
-
* @public
|
|
7082
|
-
*/
|
|
7083
|
-
interface $UnknownMember {
|
|
7084
|
-
copyFrom?: never;
|
|
7085
|
-
$unknown: [string, any];
|
|
7086
|
-
}
|
|
7087
|
-
/**
|
|
7088
|
-
* @deprecated unused in schema-serde mode.
|
|
7089
|
-
*
|
|
7090
|
-
*/
|
|
7091
|
-
interface Visitor<T> {
|
|
7092
|
-
copyFrom: (value: string) => T;
|
|
7093
|
-
_: (name: string, value: any) => T;
|
|
7094
|
-
}
|
|
7095
|
-
}
|
|
7096
|
-
/**
|
|
7097
|
-
* @public
|
|
7098
|
-
*/
|
|
7099
|
-
export interface CreateInferenceProfileRequest {
|
|
7100
|
-
/**
|
|
7101
|
-
* <p>A name for the inference profile.</p>
|
|
7102
|
-
* @public
|
|
7103
|
-
*/
|
|
7104
|
-
inferenceProfileName: string | undefined;
|
|
7105
|
-
/**
|
|
7106
|
-
* <p>A description for the inference profile.</p>
|
|
7107
|
-
* @public
|
|
7108
|
-
*/
|
|
7109
|
-
description?: string | undefined;
|
|
7110
|
-
/**
|
|
7111
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7112
|
-
* @public
|
|
7113
|
-
*/
|
|
7114
|
-
clientRequestToken?: string | undefined;
|
|
7115
|
-
/**
|
|
7116
|
-
* <p>The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.</p>
|
|
7117
|
-
* @public
|
|
7118
|
-
*/
|
|
7119
|
-
modelSource: InferenceProfileModelSource | undefined;
|
|
7120
|
-
/**
|
|
7121
|
-
* <p>An array of objects, each of which contains a tag and its value. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
|
|
7122
|
-
* @public
|
|
7123
|
-
*/
|
|
7124
|
-
tags?: Tag[] | undefined;
|
|
7125
|
-
}
|
|
7126
|
-
/**
|
|
7127
|
-
* @public
|
|
7128
|
-
*/
|
|
7129
|
-
export interface CreateInferenceProfileResponse {
|
|
7130
|
-
/**
|
|
7131
|
-
* <p>The ARN of the inference profile that you created.</p>
|
|
7132
|
-
* @public
|
|
7133
|
-
*/
|
|
7134
|
-
inferenceProfileArn: string | undefined;
|
|
7135
|
-
/**
|
|
7136
|
-
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
7137
|
-
* @public
|
|
7138
|
-
*/
|
|
7139
|
-
status?: InferenceProfileStatus | undefined;
|
|
7140
|
-
}
|