Package bedrockagentruntimeiface provides an interface to enable mocking the Agents for Amazon Bedrock Runtime service client for testing your code.

CreationMode_Values returns all elements of the CreationMode enum.

ExecutionType_Values returns all elements of the ExecutionType enum.

ExternalSourceType_Values returns all elements of the ExternalSourceType enum.

FileSourceType_Values returns all elements of the FileSourceType enum.

FileUseCase_Values returns all elements of the FileUseCase enum.

FlowCompletionReason_Values returns all elements of the FlowCompletionReason enum.

GuadrailAction_Values returns all elements of the GuadrailAction enum.

GuardrailAction_Values returns all elements of the GuardrailAction enum.

GuardrailContentFilterConfidence_Values returns all elements of the GuardrailContentFilterConfidence enum.

GuardrailContentFilterType_Values returns all elements of the GuardrailContentFilterType enum.

GuardrailContentPolicyAction_Values returns all elements of the GuardrailContentPolicyAction enum.

GuardrailManagedWordType_Values returns all elements of the GuardrailManagedWordType enum.

GuardrailPiiEntityType_Values returns all elements of the GuardrailPiiEntityType enum.

GuardrailSensitiveInformationPolicyAction_Values returns all elements of the GuardrailSensitiveInformationPolicyAction enum.

GuardrailTopicPolicyAction_Values returns all elements of the GuardrailTopicPolicyAction enum.

GuardrailTopicType_Values returns all elements of the GuardrailTopicType enum.

GuardrailWordPolicyAction_Values returns all elements of the GuardrailWordPolicyAction enum.

InvocationType_Values returns all elements of the InvocationType enum.

MemoryType_Values returns all elements of the MemoryType enum.

New creates a new instance of the BedrockAgentRuntime client with a session.

NewInvokeAgentEventStream initializes an InvokeAgentEventStream.

NewInvokeFlowEventStream initializes an InvokeFlowEventStream.

NodeType_Values returns all elements of the NodeType enum.

PromptType_Values returns all elements of the PromptType enum.

QueryTransformationType_Values returns all elements of the QueryTransformationType enum.

ResponseState_Values returns all elements of the ResponseState enum.

RetrievalResultLocationType_Values returns all elements of the RetrievalResultLocationType enum.

RetrieveAndGenerateType_Values returns all elements of the RetrieveAndGenerateType enum.

SearchType_Values returns all elements of the SearchType enum.

Source_Values returns all elements of the Source enum.

Type_Values returns all elements of the Type enum.

CreationModeDefault is a CreationMode enum value.

CreationModeOverridden is a CreationMode enum value.

ID to lookup a service endpoint with.

ErrCodeAccessDeniedException for service response error code "AccessDeniedException".

ErrCodeBadGatewayException for service response error code "BadGatewayException".

ErrCodeConflictException for service response error code "ConflictException".

ErrCodeDependencyFailedException for service response error code "DependencyFailedException".

ErrCodeInternalServerException for service response error code "InternalServerException".

ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".

ErrCodeServiceQuotaExceededException for service response error code "ServiceQuotaExceededException".

ErrCodeThrottlingException for service response error code "ThrottlingException".

ErrCodeValidationException for service response error code "ValidationException".

ExecutionTypeLambda is a ExecutionType enum value.

ExecutionTypeReturnControl is a ExecutionType enum value.

ExternalSourceTypeByteContent is a ExternalSourceType enum value.

ExternalSourceTypeS3 is a ExternalSourceType enum value.

FileSourceTypeByteContent is a FileSourceType enum value.

FileSourceTypeS3 is a FileSourceType enum value.

FileUseCaseChat is a FileUseCase enum value.

FileUseCaseCodeInterpreter is a FileUseCase enum value.

FlowCompletionReasonSuccess is a FlowCompletionReason enum value.

GuadrailActionIntervened is a GuadrailAction enum value.

GuadrailActionNone is a GuadrailAction enum value.

GuardrailActionIntervened is a GuardrailAction enum value.

GuardrailActionNone is a GuardrailAction enum value.

GuardrailContentFilterConfidenceHigh is a GuardrailContentFilterConfidence enum value.

GuardrailContentFilterConfidenceLow is a GuardrailContentFilterConfidence enum value.

GuardrailContentFilterConfidenceMedium is a GuardrailContentFilterConfidence enum value.

GuardrailContentFilterConfidenceNone is a GuardrailContentFilterConfidence enum value.

GuardrailContentFilterTypeHate is a GuardrailContentFilterType enum value.

GuardrailContentFilterTypeInsults is a GuardrailContentFilterType enum value.

GuardrailContentFilterTypeMisconduct is a GuardrailContentFilterType enum value.

GuardrailContentFilterTypePromptAttack is a GuardrailContentFilterType enum value.

GuardrailContentFilterTypeSexual is a GuardrailContentFilterType enum value.

GuardrailContentFilterTypeViolence is a GuardrailContentFilterType enum value.

GuardrailContentPolicyActionBlocked is a GuardrailContentPolicyAction enum value.

GuardrailManagedWordTypeProfanity is a GuardrailManagedWordType enum value.

GuardrailPiiEntityTypeAddress is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeAge is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeAwsAccessKey is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeAwsSecretKey is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeCaHealthNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeCaSocialInsuranceNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeCreditDebitCardCvv is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeCreditDebitCardExpiry is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeCreditDebitCardNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeDriverId is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeEmail is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeInternationalBankAccountNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeIpAddress is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeLicensePlate is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeMacAddress is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeName is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypePassword is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypePhone is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypePin is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeSwiftCode is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUkNationalHealthServiceNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUkNationalInsuranceNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUrl is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUsBankAccountNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUsBankRoutingNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUsername is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUsPassportNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeUsSocialSecurityNumber is a GuardrailPiiEntityType enum value.

GuardrailPiiEntityTypeVehicleIdentificationNumber is a GuardrailPiiEntityType enum value.

GuardrailSensitiveInformationPolicyActionAnonymized is a GuardrailSensitiveInformationPolicyAction enum value.

GuardrailSensitiveInformationPolicyActionBlocked is a GuardrailSensitiveInformationPolicyAction enum value.

GuardrailTopicPolicyActionBlocked is a GuardrailTopicPolicyAction enum value.

GuardrailTopicTypeDeny is a GuardrailTopicType enum value.

GuardrailWordPolicyActionBlocked is a GuardrailWordPolicyAction enum value.

InvocationTypeActionGroup is a InvocationType enum value.

InvocationTypeActionGroupCodeInterpreter is a InvocationType enum value.

InvocationTypeFinish is a InvocationType enum value.

InvocationTypeKnowledgeBase is a InvocationType enum value.

MemoryTypeSessionSummary is a MemoryType enum value.

NodeTypeConditionNode is a NodeType enum value.

NodeTypeFlowInputNode is a NodeType enum value.

NodeTypeFlowOutputNode is a NodeType enum value.

NodeTypeKnowledgeBaseNode is a NodeType enum value.

NodeTypeLambdaFunctionNode is a NodeType enum value.

NodeTypeLexNode is a NodeType enum value.

NodeTypePromptNode is a NodeType enum value.

PromptTypeKnowledgeBaseResponseGeneration is a PromptType enum value.

PromptTypeOrchestration is a PromptType enum value.

PromptTypePostProcessing is a PromptType enum value.

PromptTypePreProcessing is a PromptType enum value.

QueryTransformationTypeQueryDecomposition is a QueryTransformationType enum value.

ResponseStateFailure is a ResponseState enum value.

ResponseStateReprompt is a ResponseState enum value.

RetrievalResultLocationTypeConfluence is a RetrievalResultLocationType enum value.

RetrievalResultLocationTypeS3 is a RetrievalResultLocationType enum value.

RetrievalResultLocationTypeSalesforce is a RetrievalResultLocationType enum value.

RetrievalResultLocationTypeSharepoint is a RetrievalResultLocationType enum value.

RetrievalResultLocationTypeWeb is a RetrievalResultLocationType enum value.

RetrieveAndGenerateTypeExternalSources is a RetrieveAndGenerateType enum value.

RetrieveAndGenerateTypeKnowledgeBase is a RetrieveAndGenerateType enum value.

SearchTypeHybrid is a SearchType enum value.

SearchTypeSemantic is a SearchType enum value.

ServiceID is a unique identifier of a specific service.

Name of service.

SourceActionGroup is a Source enum value.

SourceKnowledgeBase is a Source enum value.

SourceParser is a Source enum value.

TypeActionGroup is a Type enum value.

TypeAskUser is a Type enum value.

TypeFinish is a Type enum value.

TypeKnowledgeBase is a Type enum value.

TypeReprompt is a Type enum value.

The request is denied because of missing access permissions.

Contains information about the action group being invoked.

Contains the JSON-formatted string returned by the API invoked by the action group.

Contains information about the API operation that the agent predicts should be called.

Information about a parameter to provide to the API request.

The request body to provide for the API request, as the agent elicited from the user.

Contains information about the API operation that was called from the action group and the response body that was returned.

Contains citations for a part of an agent response.

There was an issue with a dependency due to a server issue.

BedrockAgentRuntime provides the API operation methods for making requests to Agents for Amazon Bedrock Runtime.

This property contains the document to chat with, along with its attributes.

The property contains the file to chat with, along with its attributes.

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

Contains information about the code interpreter being invoked.

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

There was a conflict performing an operation.

Contains the body of the API response.

There was an issue with a dependency.

The unique external source of the content contained in the wrapper object.

Contains the generation configuration of the external source wrapper object.

The configurations of the external source wrapper object in the retrieveAndGenerate function.

Contains information about the failure of the interaction.

Contains intermediate response for code interpreter if any files have been generated.

The source file of the content contained in the wrapper object.

Contains details about the response to the user.

Contains information about why a flow completed.

Contains information about an input into the flow and what to do with it.

Contains information about an input into the flow.

Contains information about the output node.

Contains information about an output from flow invoction.

FlowResponseStreamUnknownEvent provides a failsafe event for the FlowResponseStream group of events when an unknown event is received.

Contains information about the function that the agent predicts should be called.

Contains information about a parameter of the function.

Contains information about the function that was called from the action group and the response that was returned.

Contains metadata about a part of the generated response that is accompanied by a citation.

Contains configurations for response generation based on the knowledge base query results.

Assessment details of the content analyzed by Guardrails.

The configuration details for the guardrail.

Details of the content filter used in the Guardrail.

The details of the policy assessment in the Guardrails filter.

The custom word details for the filter in the Guardrail.

The managed word details for the filter in the Guardrail.

The Guardrail filter to identify and remove personally identifiable information (PII).

The details for the regex filter used in the Guardrail.

The details of the sensitive policy assessment used in the Guardrail.

The details for a specific topic defined in the Guardrail.

The details of the policy assessment used in the Guardrail.

The trace details used in the Guardrail.

The assessment details for words defined in the Guardrail filter.

The configuration for inference settings when generating responses using RetrieveAndGenerate.

Specifications about the inference parameters that were provided alongside the prompt.

Contains details of the source files.

An internal server error occurred.

Contains information pertaining to the action group or knowledge base that is being invoked.

Contains details about the API operation or function that the agent predicts should be called.

A result from the invocation of an action.

InvokeAgentEventStream provides the event stream handling for the InvokeAgent.

InvokeFlowEventStream provides the event stream handling for the InvokeFlow.

Configurations to apply to a knowledge base attached to the agent during query.

Contains details about the knowledge base to look up and the query to be made.

Contains details about the results from looking up the knowledge base.

Contains the query made to the knowledge base.

Contains configurations for knowledge base query.

Details about a result from querying the knowledge base.

Contains details about the resource being queried.

Configurations for how to perform the search query and return results.

Contains sessions summaries.

Contains details of a session summary.

The input for the pre-processing step.

Contains the result or output of an action group or knowledge base, or the response to the user.

Settings for how the model processes the prompt prior to retrieval and generation.

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

Contains details of the response from code interpreter.

A parameter for the API request or function.

Contains a part of an agent response and citations for it.

The foundation model output from the post-processing step.

Details about the response from the Lambda parsing of the output from the post-processing step.

Details about the post-processing step, in which the agent shapes the response.

The foundation model output from the pre-processing step.

Details about the response from the Lambda parsing of the output from the pre-processing step.

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

Contains the template for the prompt that's sent to the model for response generation.

Contains the parameters in the request body.

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

Contains details about the agent's response to reprompt the input.

The parameters in the API request body.

The specified resource Amazon Resource Name (ARN) was not found.

ResponseStreamUnknownEvent provides a failsafe event for the ResponseStream group of events when an unknown event is received.

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results.

The Confluence data source location.

Contains the cited text from the data source.

Contains information about the data source location.

The S3 data source location.

The Salesforce data source location.

The SharePoint data source location.

The web URL/URLs data source location.

Contains details about the resource being queried.

Contains the query made to the knowledge base.

Contains the response generated from querying the knowledge base.

Contains configuration about the session with the knowledge base.

Contains metadata about a source cited for the generated response.

Contains information to return from the action group that the agent has predicted to invoke.

The unique wrapper object of the document from the S3 location.

Contains details of the s3 object where the source file is located.

The number of requests exceeds the service quota.

Contains parameters that specify various attributes that persist across a session or prompt.

Contains information about where the text with a citation begins and ends in the generated output.

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation.

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

The number of requests exceeds the limit.

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases.

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace.

Input validation failed.

FlowResponseStreamEvent groups together all EventStream events writes for FlowResponseStream.

FlowResponseStreamReader provides the interface for reading to the stream.

ResponseStreamEvent groups together all EventStream events writes for ResponseStream.

ResponseStreamReader provides the interface for reading to the stream.