Skip to content

Latest commit

 

History

History
186 lines (146 loc) · 8.4 KB

bedrockagent.md

File metadata and controls

186 lines (146 loc) · 8.4 KB

BedrockAgent

AWS's bedrockagent service · portable interface driver.BedrockAgent · AWS index

Operations (32)

Operation Description
CreateAgent
CreateAgentAlias
CreateDataSource
CreateFlow
CreateKnowledgeBase
CreatePrompt
DeleteAgent
DeleteDataSource
DeleteFlow
DeleteKnowledgeBase
DeletePrompt
GetAgent
GetDataSource
GetFlow
GetKnowledgeBase
GetPrompt
ListAgents
ListDataSources
ListFlows
ListKnowledgeBases
ListPrompts
ListTagsForResource
PrepareAgent
PrepareFlow
StartIngestionJob
TagResource
UntagResource
UpdateAgent
UpdateDataSource
UpdateFlow
UpdateKnowledgeBase
UpdatePrompt

Optional capabilities

Discovered by type assertion; only some providers implement these.

ActionGroups

ActionGroups manages the action groups (tools) of an agent version.

Operation Description
CreateAgentActionGroup
DeleteAgentActionGroup
GetAgentActionGroup
ListAgentActionGroups
UpdateAgentActionGroup

AgentCollaborators

AgentCollaborators manages the collaborator agents of a supervisor agent.

Operation Description
AssociateAgentCollaborator
DisassociateAgentCollaborator
GetAgentCollaborator
ListAgentCollaborators
UpdateAgentCollaborator

AgentInUseDeleter

AgentInUseDeleter deletes an agent the way DeleteAgent's

Operation Description
DeleteAgentChecked

AgentKnowledgeBases

AgentKnowledgeBases associates knowledge bases with an agent version.

Operation Description
AssociateAgentKnowledgeBase
DisassociateAgentKnowledgeBase
GetAgentKnowledgeBase
ListAgentKnowledgeBases
UpdateAgentKnowledgeBase

AgentVersions

AgentVersions manages agent versions and the rest of the alias lifecycle.

Operation Description
DeleteAgentAlias
DeleteAgentVersion
GetAgentAlias
GetAgentVersion
ListAgentAliases
ListAgentVersions
UpdateAgentAlias

FlowValidator

FlowValidator checks a flow definition without storing it.

Operation Description
ValidateFlowDefinition

FlowVersions

FlowVersions publishes flow versions and manages the aliases routing to them.

Operation Description
CreateFlowAlias
CreateFlowVersion
DeleteFlowAlias
DeleteFlowVersion
GetFlowAlias
GetFlowVersion
ListFlowAliases
ListFlowVersions
UpdateFlowAlias

IngestionJobs

IngestionJobs reads, lists and stops data-source ingestion jobs.

Operation Description
GetIngestionJob
ListIngestionJobs
StopIngestionJob

KnowledgeBaseDocuments

KnowledgeBaseDocuments manages the documents of a data source directly.

Operation Description
DeleteKnowledgeBaseDocuments
GetKnowledgeBaseDocuments
IngestKnowledgeBaseDocuments
ListKnowledgeBaseDocuments

PromptVersions

PromptVersions publishes immutable numbered versions of a prompt's DRAFT.

Operation Description
CreatePromptVersion
DeletePromptVersion
GetPromptVersion
ListPromptVersions

ResourcePolicies

ResourcePolicies attaches resource-based policies to knowledge bases.

Operation Description
DeleteResourcePolicy
GetResourcePolicy
PutResourcePolicy

Not in scope

  • Aliases, versions, knowledge bases and data sources are created directly in their final state (PREPARED, ACTIVE, AVAILABLE). Agents and flows start NOT_PREPARED / NotPrepared; PrepareAgent and PrepareFlow prepare them at once, any change to the draft makes it unprepared again, and cutting an agent version (an alias created or updated without routingConfiguration) prepares the draft too. Ingestion jobs complete at once; with --async-settle they report IN_PROGRESS for two seconds first, which is the only window in which StopIngestionJob succeeds. A stop of a finished job is a ConflictException.
  • PrepareAgent does not cut a version, as in AWS. A version is cut when CreateAgentAlias or UpdateAgentAlias is called without routingConfiguration; it copies DRAFT with its action groups, knowledge-base associations and collaborators. Agent and flow versions report PREPARED / Prepared whatever DRAFT's status was.
  • Every agent has the TSTALIASID test alias routed to DRAFT; it is listed and readable and can't be updated or deleted. Flows have no synthesized test alias.
  • promptOverrideConfiguration returns what the caller set. AWS's default prompt templates are not reproduced, so an agent created without overrides reports an empty promptConfigurations list.
  • guardrailConfiguration, memoryConfiguration, customOrchestration, action-group executors and schemas, flow definitions and document content are stored and returned as sent; nothing runs them. Knowledge-base documents are tracked by identifier and reported INDEXED; their text is kept whole (no chunking or embedding) for the agent runtime's word-overlap search. An ingestion job over an S3 data source syncs the bucket from cloudemu S3: text objects (.txt, .md, .html, .csv, .json or a text/* content type) under the inclusion prefixes are indexed with their <key>.metadata.json attributes, changed and removed objects are re-indexed or dropped, and other formats count as failed. The sync runs when the job starts (under --async-settle the documents are searchable while the job still reports IN_PROGRESS); a bucket that can't be listed makes the job FAILED with a failureReasons entry and leaves the index unchanged. Under --enforce-auth the job reads S3 as the knowledge base's service role: a role that does not exist or lacks s3:ListBucket fails the job, and objects it lacks s3:GetObject on count as failed. Other data-source types (web, Confluence, SharePoint, Salesforce) are not crawled; their ingestion statistics count the documents ingested into them directly.
  • ValidateFlowDefinition checks structure only: a missing Input or Output node, connections to unknown nodes, duplicate connections, and nodes not reachable from an Input node. Node configurations, expressions, data types, conditions and loops are not checked, and the messages are the emulator's own wording.
  • skipResourceInUseCheck matters for DeleteAgentVersion and DeleteFlowVersion (a version an alias routes to is in use) and for DeleteAgent (an agent whose alias another agent's collaborator uses is in use). Deleting a flow, prompt or knowledge base cascades to its children without an in-use check, and DeleteAgentActionGroup does not require the action group to be disabled.
  • Deleting a knowledge base leaves agent associations to it in place. Deleting an alias, or an agent with skipResourceInUseCheck, leaves other agents' collaborators that point at that alias in place.
  • Document metadata (inline attributes, or an S3_LOCATION metadata file read from cloudemu S3) is stored and used by the runtime's retrieval filters, but not returned by GetKnowledgeBaseDocuments or ListKnowledgeBaseDocuments.
  • Where AWS does not document the exact message (for example a missing VECTOR storageConfiguration, a bad nextToken, an alias name in use, a version in use, a non-supervisor agent given a collaborator), the emulator returns the documented exception with its own wording.
  • clientToken is validated but does not make a create idempotent.
  • The operations served are the 75 of the pinned SDK (aws-sdk-go-v2/service/bedrockagent v1.58.0). Newer API operations, such as Create/Get/List/DeleteVpcConfiguration, are not served.
  • The Go library's plain DeleteAgent deletes without the in-use check; the wire handler and DeleteAgentChecked apply it. An alias of a regular (non-test) agent may route to DRAFT, which the API's routing pattern allows.
  • StartIngestionJob is refused (ConflictException) while another job of the same data source is still running.