Skip to content

Type definitions#

Index > AgentsforBedrockRuntime > Type definitions

Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AccessDeniedExceptionTypeDef#

# AccessDeniedExceptionTypeDef definition

class AccessDeniedExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ParameterTypeDef#

# ParameterTypeDef definition

class ParameterTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],

ActionGroupInvocationOutputTypeDef#

# ActionGroupInvocationOutputTypeDef definition

class ActionGroupInvocationOutputTypeDef(TypedDict):
    text: NotRequired[str],

ApiParameterTypeDef#

# ApiParameterTypeDef definition

class ApiParameterTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],

ContentBodyTypeDef#

# ContentBodyTypeDef definition

class ContentBodyTypeDef(TypedDict):
    body: NotRequired[str],

BadGatewayExceptionTypeDef#

# BadGatewayExceptionTypeDef definition

class BadGatewayExceptionTypeDef(TypedDict):
    message: NotRequired[str],
    resourceName: NotRequired[str],

ConflictExceptionTypeDef#

# ConflictExceptionTypeDef definition

class ConflictExceptionTypeDef(TypedDict):
    message: NotRequired[str],

DependencyFailedExceptionTypeDef#

# DependencyFailedExceptionTypeDef definition

class DependencyFailedExceptionTypeDef(TypedDict):
    message: NotRequired[str],
    resourceName: NotRequired[str],

S3ObjectDocTypeDef#

# S3ObjectDocTypeDef definition

class S3ObjectDocTypeDef(TypedDict):
    uri: str,

GuardrailConfigurationTypeDef#

# GuardrailConfigurationTypeDef definition

class GuardrailConfigurationTypeDef(TypedDict):
    guardrailId: str,
    guardrailVersion: str,

PromptTemplateTypeDef#

# PromptTemplateTypeDef definition

class PromptTemplateTypeDef(TypedDict):
    textPromptTemplate: NotRequired[str],

FailureTraceTypeDef#

# FailureTraceTypeDef definition

class FailureTraceTypeDef(TypedDict):
    failureReason: NotRequired[str],
    traceId: NotRequired[str],

FilterAttributeTypeDef#

# FilterAttributeTypeDef definition

class FilterAttributeTypeDef(TypedDict):
    key: str,
    value: Mapping[str, Any],

FinalResponseTypeDef#

# FinalResponseTypeDef definition

class FinalResponseTypeDef(TypedDict):
    text: NotRequired[str],

FunctionParameterTypeDef#

# FunctionParameterTypeDef definition

class FunctionParameterTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],

GuardrailContentFilterTypeDef#

# GuardrailContentFilterTypeDef definition

class GuardrailContentFilterTypeDef(TypedDict):
    action: NotRequired[GuardrailContentPolicyActionType],  # (1)
    confidence: NotRequired[GuardrailContentFilterConfidenceType],  # (2)
    type: NotRequired[GuardrailContentFilterTypeType],  # (3)
  1. See GuardrailContentPolicyActionType
  2. See GuardrailContentFilterConfidenceType
  3. See GuardrailContentFilterTypeType

GuardrailCustomWordTypeDef#

# GuardrailCustomWordTypeDef definition

class GuardrailCustomWordTypeDef(TypedDict):
    action: NotRequired[GuardrailWordPolicyActionType],  # (1)
    match: NotRequired[str],
  1. See GuardrailWordPolicyActionType

GuardrailManagedWordTypeDef#

# GuardrailManagedWordTypeDef definition

class GuardrailManagedWordTypeDef(TypedDict):
    action: NotRequired[GuardrailWordPolicyActionType],  # (1)
    match: NotRequired[str],
    type: NotRequired[GuardrailManagedWordTypeType],  # (2)
  1. See GuardrailWordPolicyActionType
  2. See GuardrailManagedWordTypeType

GuardrailPiiEntityFilterTypeDef#

# GuardrailPiiEntityFilterTypeDef definition

class GuardrailPiiEntityFilterTypeDef(TypedDict):
    action: NotRequired[GuardrailSensitiveInformationPolicyActionType],  # (1)
    match: NotRequired[str],
    type: NotRequired[GuardrailPiiEntityTypeType],  # (2)
  1. See GuardrailSensitiveInformationPolicyActionType
  2. See GuardrailPiiEntityTypeType

GuardrailRegexFilterTypeDef#

# GuardrailRegexFilterTypeDef definition

class GuardrailRegexFilterTypeDef(TypedDict):
    action: NotRequired[GuardrailSensitiveInformationPolicyActionType],  # (1)
    match: NotRequired[str],
    name: NotRequired[str],
    regex: NotRequired[str],
  1. See GuardrailSensitiveInformationPolicyActionType

GuardrailTopicTypeDef#

# GuardrailTopicTypeDef definition

class GuardrailTopicTypeDef(TypedDict):
    action: NotRequired[GuardrailTopicPolicyActionType],  # (1)
    name: NotRequired[str],
    type: NotRequired[GuardrailTopicTypeType],  # (2)
  1. See GuardrailTopicPolicyActionType
  2. See GuardrailTopicTypeType

TextInferenceConfigTypeDef#

# TextInferenceConfigTypeDef definition

class TextInferenceConfigTypeDef(TypedDict):
    maxTokens: NotRequired[int],
    stopSequences: NotRequired[Sequence[str]],
    temperature: NotRequired[float],
    topP: NotRequired[float],

InferenceConfigurationTypeDef#

# InferenceConfigurationTypeDef definition

class InferenceConfigurationTypeDef(TypedDict):
    maximumLength: NotRequired[int],
    stopSequences: NotRequired[List[str]],
    temperature: NotRequired[float],
    topK: NotRequired[int],
    topP: NotRequired[float],

InternalServerExceptionTypeDef#

# InternalServerExceptionTypeDef definition

class InternalServerExceptionTypeDef(TypedDict):
    message: NotRequired[str],

KnowledgeBaseLookupInputTypeDef#

# KnowledgeBaseLookupInputTypeDef definition

class KnowledgeBaseLookupInputTypeDef(TypedDict):
    knowledgeBaseId: NotRequired[str],
    text: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

KnowledgeBaseQueryTypeDef#

# KnowledgeBaseQueryTypeDef definition

class KnowledgeBaseQueryTypeDef(TypedDict):
    text: str,

KnowledgeBaseVectorSearchConfigurationTypeDef#

# KnowledgeBaseVectorSearchConfigurationTypeDef definition

class KnowledgeBaseVectorSearchConfigurationTypeDef(TypedDict):
    filter: NotRequired[RetrievalFilterTypeDef],  # (1)
    numberOfResults: NotRequired[int],
    overrideSearchType: NotRequired[SearchTypeType],  # (2)
  1. See RetrievalFilterTypeDef
  2. See SearchTypeType

RetrievalResultContentTypeDef#

# RetrievalResultContentTypeDef definition

class RetrievalResultContentTypeDef(TypedDict):
    text: str,

RepromptResponseTypeDef#

# RepromptResponseTypeDef definition

class RepromptResponseTypeDef(TypedDict):
    source: NotRequired[SourceType],  # (1)
    text: NotRequired[str],
  1. See SourceType

RationaleTypeDef#

# RationaleTypeDef definition

class RationaleTypeDef(TypedDict):
    text: NotRequired[str],
    traceId: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PostProcessingParsedResponseTypeDef#

# PostProcessingParsedResponseTypeDef definition

class PostProcessingParsedResponseTypeDef(TypedDict):
    text: NotRequired[str],

PreProcessingParsedResponseTypeDef#

# PreProcessingParsedResponseTypeDef definition

class PreProcessingParsedResponseTypeDef(TypedDict):
    isValid: NotRequired[bool],
    rationale: NotRequired[str],

ResourceNotFoundExceptionTypeDef#

# ResourceNotFoundExceptionTypeDef definition

class ResourceNotFoundExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ServiceQuotaExceededExceptionTypeDef#

# ServiceQuotaExceededExceptionTypeDef definition

class ServiceQuotaExceededExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ThrottlingExceptionTypeDef#

# ThrottlingExceptionTypeDef definition

class ThrottlingExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ValidationExceptionTypeDef#

# ValidationExceptionTypeDef definition

class ValidationExceptionTypeDef(TypedDict):
    message: NotRequired[str],

RetrievalResultS3LocationTypeDef#

# RetrievalResultS3LocationTypeDef definition

class RetrievalResultS3LocationTypeDef(TypedDict):
    uri: NotRequired[str],

RetrieveAndGenerateInputTypeDef#

# RetrieveAndGenerateInputTypeDef definition

class RetrieveAndGenerateInputTypeDef(TypedDict):
    text: str,

RetrieveAndGenerateOutputTypeDef#

# RetrieveAndGenerateOutputTypeDef definition

class RetrieveAndGenerateOutputTypeDef(TypedDict):
    text: str,

RetrieveAndGenerateSessionConfigurationTypeDef#

# RetrieveAndGenerateSessionConfigurationTypeDef definition

class RetrieveAndGenerateSessionConfigurationTypeDef(TypedDict):
    kmsKeyArn: str,

SpanTypeDef#

# SpanTypeDef definition

class SpanTypeDef(TypedDict):
    end: NotRequired[int],
    start: NotRequired[int],

PropertyParametersTypeDef#

# PropertyParametersTypeDef definition

class PropertyParametersTypeDef(TypedDict):
    properties: NotRequired[List[ParameterTypeDef]],  # (1)
  1. See ParameterTypeDef

RequestBodyTypeDef#

# RequestBodyTypeDef definition

class RequestBodyTypeDef(TypedDict):
    content: NotRequired[Dict[str, List[ParameterTypeDef]]],  # (1)
  1. See ParameterTypeDef

ApiResultTypeDef#

# ApiResultTypeDef definition

class ApiResultTypeDef(TypedDict):
    actionGroup: str,
    apiPath: NotRequired[str],
    httpMethod: NotRequired[str],
    httpStatusCode: NotRequired[int],
    responseBody: NotRequired[Mapping[str, ContentBodyTypeDef]],  # (1)
    responseState: NotRequired[ResponseStateType],  # (2)
  1. See ContentBodyTypeDef
  2. See ResponseStateType

FunctionResultTypeDef#

# FunctionResultTypeDef definition

class FunctionResultTypeDef(TypedDict):
    actionGroup: str,
    function: NotRequired[str],
    responseBody: NotRequired[Mapping[str, ContentBodyTypeDef]],  # (1)
    responseState: NotRequired[ResponseStateType],  # (2)
  1. See ContentBodyTypeDef
  2. See ResponseStateType

ByteContentDocTypeDef#

# ByteContentDocTypeDef definition

class ByteContentDocTypeDef(TypedDict):
    contentType: str,
    data: Union[str, bytes, IO[Any], StreamingBody],
    identifier: str,

RetrievalFilterTypeDef#

# RetrievalFilterTypeDef definition

class RetrievalFilterTypeDef(TypedDict):
    andAll: NotRequired[Sequence[Dict[str, Any]]],
    equals: NotRequired[FilterAttributeTypeDef],  # (1)
    greaterThan: NotRequired[FilterAttributeTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[FilterAttributeTypeDef],  # (1)
    in: NotRequired[FilterAttributeTypeDef],  # (1)
    lessThan: NotRequired[FilterAttributeTypeDef],  # (1)
    lessThanOrEquals: NotRequired[FilterAttributeTypeDef],  # (1)
    listContains: NotRequired[FilterAttributeTypeDef],  # (1)
    notEquals: NotRequired[FilterAttributeTypeDef],  # (1)
    notIn: NotRequired[FilterAttributeTypeDef],  # (1)
    orAll: NotRequired[Sequence[Dict[str, Any]]],
    startsWith: NotRequired[FilterAttributeTypeDef],  # (1)
    stringContains: NotRequired[FilterAttributeTypeDef],  # (1)
  1. See FilterAttributeTypeDef
  2. See FilterAttributeTypeDef
  3. See FilterAttributeTypeDef
  4. See FilterAttributeTypeDef
  5. See FilterAttributeTypeDef
  6. See FilterAttributeTypeDef
  7. See FilterAttributeTypeDef
  8. See FilterAttributeTypeDef
  9. See FilterAttributeTypeDef
  10. See FilterAttributeTypeDef
  11. See FilterAttributeTypeDef
<