Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/bedrockagent.ts?docs=full";

§Classes

BedrockAgent

§Interfaces

ActionGroupExecutor

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

ActionGroupSummary

Contains details about an action group.

Agent

Contains details about an agent.

AgentActionGroup

Contains details about an action group.

AgentAlias

Contains details about an alias of an agent.

AgentAliasHistoryEvent

Contains details about the history of the alias.

AgentAliasRoutingConfigurationListItem

Contains details about the routing configuration of the alias.

AgentAliasSummary

Contains details about an alias of an agent.

AgentFlowNodeConfiguration

Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

AgentKnowledgeBase

Contains details about a knowledge base that is associated with an agent.

AgentKnowledgeBaseSummary

Contains details about a knowledge base associated with an agent.

AgentSummary

Contains details about an agent.

AgentVersion

Contains details about a version of an agent.

AgentVersionSummary

Contains details about a version of an agent.

APISchema

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

AssociateAgentKnowledgeBaseRequest
AssociateAgentKnowledgeBaseResponse
BedrockEmbeddingModelConfiguration

The vector configuration details for the Bedrock embeddings model.

BedrockFoundationModelConfiguration

Settings for a foundation model used to parse documents for a data source.

ChunkingConfiguration

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

CollectorFlowNodeConfiguration

Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

ConditionFlowNodeConfiguration

Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

ConfluenceCrawlerConfiguration

The configuration of the Confluence content. For example, configuring specific types of Confluence content.

ConfluenceDataSourceConfiguration

The configuration information to connect to Confluence as your data source.

ConfluenceSourceConfiguration

The endpoint information to connect to your Confluence data source.

CrawlFilterConfiguration

The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.

CreateAgentActionGroupRequest
CreateAgentActionGroupResponse
CreateAgentAliasRequest
CreateAgentAliasResponse
CreateAgentRequest
CreateAgentResponse
CreateDataSourceRequest
CreateDataSourceResponse
CreateFlowAliasRequest
CreateFlowAliasResponse
CreateFlowRequest
CreateFlowResponse
CreateFlowVersionRequest
CreateFlowVersionResponse
CreateKnowledgeBaseRequest
CreateKnowledgeBaseResponse
CreatePromptRequest
CreatePromptResponse
CreatePromptVersionRequest
CreatePromptVersionResponse
CustomTransformationConfiguration

Settings for customizing steps in the data source content ingestion pipeline.

DataSource

Contains details about a data source.

DataSourceConfiguration

The connection configuration for the data source.

DataSourceSummary

Contains details about a data source.

DeleteAgentActionGroupRequest
DeleteAgentAliasRequest
DeleteAgentAliasResponse
DeleteAgentRequest
DeleteAgentResponse
DeleteAgentVersionRequest
DeleteAgentVersionResponse
DeleteDataSourceRequest
DeleteDataSourceResponse
DeleteFlowAliasRequest
DeleteFlowAliasResponse
DeleteFlowRequest
DeleteFlowResponse
DeleteFlowVersionRequest
DeleteFlowVersionResponse
DeleteKnowledgeBaseRequest
DeleteKnowledgeBaseResponse
DeletePromptRequest
DeletePromptResponse
DisassociateAgentKnowledgeBaseRequest
EmbeddingModelConfiguration

The configuration details for the embeddings model.

FixedSizeChunkingConfiguration

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

FlowAliasRoutingConfigurationListItem

Contains information about a version that the alias maps to.

FlowAliasSummary

Contains information about an alias of a flow.

FlowCondition

Defines a condition in the condition node.

FlowConditionalConnectionConfiguration

The configuration of a connection between a condition node and another node.

FlowConnection

Contains information about a connection between two nodes in the flow.

FlowConnectionConfiguration

The configuration of the connection.

FlowDataConnectionConfiguration

The configuration of a connection originating from a node that isn't a Condition node.

FlowDefinition

The definition of the nodes and connections between nodes in the flow.

FlowNode

Contains configurations about a node in the flow.

FlowNodeConfiguration

Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

FlowNodeInput

Contains configurations for an input to a node.

FlowNodeOutput

Contains configurations for an output from a node.

FlowSummary

Contains the definition of a flow.

FlowValidation

Contains information about validation of the flow.

FlowVersionSummary

Contains information about a version of a flow.

Function

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

FunctionSchema

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

GetAgentActionGroupRequest
GetAgentActionGroupResponse
GetAgentAliasRequest
GetAgentAliasResponse
GetAgentKnowledgeBaseRequest
GetAgentKnowledgeBaseResponse
GetAgentRequest
GetAgentResponse
GetAgentVersionRequest
GetAgentVersionResponse
GetDataSourceRequest
GetDataSourceResponse
GetFlowAliasRequest
GetFlowAliasResponse
GetFlowRequest
GetFlowResponse
GetFlowVersionRequest
GetFlowVersionResponse
GetIngestionJobRequest
GetIngestionJobResponse
GetKnowledgeBaseRequest
GetKnowledgeBaseResponse
GetPromptRequest
GetPromptResponse
GuardrailConfiguration

Details about the guardrail associated with an agent.

HierarchicalChunkingConfiguration

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

HierarchicalChunkingLevelConfiguration

Token settings for a layer in a hierarchical chunking configuration.

InferenceConfiguration

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

IngestionJob

Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

IngestionJobFilter

Defines a filter by which to filter the results.

IngestionJobSortBy

Parameters by which to sort the results.

IngestionJobStatistics

Contains the statistics for the ingestion job.

IngestionJobSummary

Contains details about an ingestion job.

InputFlowNodeConfiguration

Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.

IntermediateStorage

A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.

IteratorFlowNodeConfiguration

Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

KnowledgeBase

Contains information about a knowledge base.

KnowledgeBaseConfiguration

Contains details about the embeddings configuration of the knowledge base.

KnowledgeBaseFlowNodeConfiguration

Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

KnowledgeBaseSummary

Contains details about a knowledge base.

LambdaFunctionFlowNodeConfiguration

Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

LexFlowNodeConfiguration

Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

ListAgentActionGroupsRequest
ListAgentActionGroupsResponse
ListAgentAliasesRequest
ListAgentAliasesResponse
ListAgentKnowledgeBasesRequest
ListAgentKnowledgeBasesResponse
ListAgentsRequest
ListAgentsResponse
ListAgentVersionsRequest
ListAgentVersionsResponse
ListDataSourcesRequest
ListDataSourcesResponse
ListFlowAliasesRequest
ListFlowAliasesResponse
ListFlowsRequest
ListFlowsResponse
ListFlowVersionsRequest
ListFlowVersionsResponse
ListIngestionJobsRequest
ListIngestionJobsResponse
ListKnowledgeBasesRequest
ListKnowledgeBasesResponse
ListPromptsRequest
ListPromptsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
MemoryConfiguration

Details of the memory configuration.

MongoDbAtlasConfiguration

Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

MongoDbAtlasFieldMapping

Contains the names of the fields to which to map information about the vector store.

OpenSearchServerlessConfiguration

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

OpenSearchServerlessFieldMapping

Contains the names of the fields to which to map information about the vector store.

OutputFlowNodeConfiguration

Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.

ParameterDetail

Contains details about a parameter in a function for an action group.

ParsingConfiguration

Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.

ParsingPrompt

Instructions for interpreting the contents of a document.

PatternObjectFilter

The specific filters applied to your data source content. You can filter out or include certain content.

PatternObjectFilterConfiguration

The configuration of filtering certain objects or content types of the data source.

PineconeConfiguration

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

PineconeFieldMapping

Contains the names of the fields to which to map information about the vector store.

PrepareAgentRequest
PrepareAgentResponse
PrepareFlowRequest
PrepareFlowResponse
PromptConfiguration

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

PromptFlowNodeConfiguration

Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

PromptFlowNodeInlineConfiguration

Contains configurations for a prompt defined inline in the node.

PromptFlowNodeResourceConfiguration

Contains configurations for a prompt from Prompt management to use in a node.

PromptFlowNodeSourceConfiguration

Contains configurations for a prompt and whether it is from Prompt management or defined inline.

PromptInferenceConfiguration

Contains inference configurations for the prompt.

PromptInputVariable

Contains information about a variable in the prompt.

PromptMetadataEntry

Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.

PromptModelInferenceConfiguration

Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.

PromptOverrideConfiguration

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

PromptSummary

Contains information about a prompt in your Prompt management tool.

PromptTemplateConfiguration

Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.

PromptVariant

Contains details about a variant of the prompt.

RdsConfiguration

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

RdsFieldMapping

Contains the names of the fields to which to map information about the vector store.

RedisEnterpriseCloudConfiguration

Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.

RedisEnterpriseCloudFieldMapping

Contains the names of the fields to which to map information about the vector store.

RetrievalFlowNodeConfiguration

Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.

RetrievalFlowNodeS3Configuration

Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

RetrievalFlowNodeServiceConfiguration

Contains configurations for the service to use for retrieving data to return as the output from the node.

S3DataSourceConfiguration

The configuration information to connect to Amazon S3 as your data source.

S3Identifier

The identifier information for an Amazon S3 bucket.

S3Location

An Amazon S3 location.

SalesforceCrawlerConfiguration

The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.

SalesforceDataSourceConfiguration

The configuration information to connect to Salesforce as your data source.

SalesforceSourceConfiguration

The endpoint information to connect to your Salesforce data source.

SeedUrl

The seed or starting point URL. You should be authorized to crawl the URL.

SemanticChunkingConfiguration

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

ServerSideEncryptionConfiguration

Contains the configuration for server-side encryption.

SharePointCrawlerConfiguration

The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

SharePointDataSourceConfiguration

The configuration information to connect to SharePoint as your data source.

SharePointSourceConfiguration

The endpoint information to connect to your SharePoint data source.

StartIngestionJobRequest
StartIngestionJobResponse
StorageConfiguration

Contains the storage configuration of the knowledge base.

StorageFlowNodeConfiguration

Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.

StorageFlowNodeS3Configuration

Contains configurations for the Amazon S3 location in which to store the input into the node.

StorageFlowNodeServiceConfiguration

Contains configurations for the service to use for storing the input into the node.

TagResourceRequest
TextPromptTemplateConfiguration

Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.

Transformation

A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to POST_CHUNKING.

TransformationFunction

A Lambda function that processes documents.

TransformationLambdaConfiguration

A Lambda function that processes documents.

UntagResourceRequest
UpdateAgentActionGroupRequest
UpdateAgentActionGroupResponse
UpdateAgentAliasRequest
UpdateAgentAliasResponse
UpdateAgentKnowledgeBaseRequest
UpdateAgentKnowledgeBaseResponse
UpdateAgentRequest
UpdateAgentResponse
UpdateDataSourceRequest
UpdateDataSourceResponse
UpdateFlowAliasRequest
UpdateFlowAliasResponse
UpdateFlowRequest
UpdateFlowResponse
UpdateKnowledgeBaseRequest
UpdateKnowledgeBaseResponse
UpdatePromptRequest
UpdatePromptResponse
UrlConfiguration

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

VectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

VectorKnowledgeBaseConfiguration

Contains details about the model used to create vector embeddings for the knowledge base.

WebCrawlerConfiguration

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

WebCrawlerLimits

The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.

WebDataSourceConfiguration

The configuration details for the web data source.

WebSourceConfiguration

The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.

§Type Aliases

ActionGroupSignature
ActionGroupState
AgentAliasStatus
AgentStatus
ChunkingStrategy
ConfluenceAuthType
ConfluenceHostType
CrawlFilterConfigurationType
CreationMode
CustomControlMethod
DataDeletionPolicy
DataSourceStatus
DataSourceType
FlowConnectionType
FlowNodeIODataType
FlowNodeType
FlowStatus
FlowValidationSeverity
IngestionJobFilterAttribute
IngestionJobFilterOperator
IngestionJobSortByAttribute
IngestionJobStatus
KnowledgeBaseState
KnowledgeBaseStatus
KnowledgeBaseStorageType
KnowledgeBaseType
MemoryType
ParsingStrategy
PromptState
PromptTemplateType
PromptType
RequireConfirmation

ENUM to check if action requires user confirmation

SalesforceAuthType
SharePointAuthType
SharePointHostType
SortOrder
StepType
Type
WebScopeType