DeleteAgentMemory

$result = $client->deleteAgentMemory([/* ... */]);
$promise = $client->deleteAgentMemoryAsync([/* ... */]);

Deletes memory from the specified memory identifier.

Parameter Syntax

$result = $client->deleteAgentMemory([
    'agentAliasId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'memoryId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

GenerateQuery

$result = $client->generateQuery([/* ... */]);
$promise = $client->generateQueryAsync([/* ... */]);

Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->generateQuery([
    'queryGenerationInput' => [ // REQUIRED
        'text' => '<string>', // REQUIRED
        'type' => 'TEXT', // REQUIRED
    ],
    'transformationConfiguration' => [ // REQUIRED
        'mode' => 'TEXT_TO_SQL', // REQUIRED
        'textToSqlConfiguration' => [
            'knowledgeBaseConfiguration' => [
                'knowledgeBaseArn' => '<string>', // REQUIRED
            ],
            'type' => 'KNOWLEDGE_BASE', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'queries' => [
        [
            'sql' => '<string>',
            'type' => 'REDSHIFT_SQL',
        ],
        // ...
    ],
]

Result Details

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

GetAgentMemory

$result = $client->getAgentMemory([/* ... */]);
$promise = $client->getAgentMemoryAsync([/* ... */]);

Gets the sessions stored in the memory of the agent.

Parameter Syntax

$result = $client->getAgentMemory([
    'agentAliasId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'maxItems' => <integer>,
    'memoryId' => '<string>', // REQUIRED
    'memoryType' => 'SESSION_SUMMARY', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'memoryContents' => [
        [
            'sessionSummary' => [
                'memoryId' => '<string>',
                'sessionExpiryTime' => <DateTime>,
                'sessionId' => '<string>',
                'sessionStartTime' => <DateTime>,
                'summaryText' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

InvokeAgent

$result = $client->invokeAgent([/* ... */]);
$promise = $client->invokeAgentAsync([/* ... */]);

The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeAgent.

Sends a prompt for the agent to process and respond to. Note the following fields for the request:

• To continue the same conversation with an agent, use the same sessionId value in the request.

• To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.

• End a conversation by setting endSession to true.

• In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.

The response is returned in the bytes field of the chunk object.

• The attribution object contains citations for parts of the response.

• If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.

• If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.

• Errors are also surfaced in the response.

Parameter Syntax

$result = $client->invokeAgent([
    'agentAliasId' => '<string>', // REQUIRED
    'agentId' => '<string>', // REQUIRED
    'enableTrace' => true || false,
    'endSession' => true || false,
    'inputText' => '<string>',
    'memoryId' => '<string>',
    'sessionId' => '<string>', // REQUIRED
    'sessionState' => [
        'conversationHistory' => [
            'messages' => [
                [
                    'content' => [ // REQUIRED
                        [
                            'text' => '<string>',
                        ],
                        // ...
                    ],
                    'role' => 'user|assistant', // REQUIRED
                ],
                // ...
            ],
        ],
        'files' => [
            [
                'name' => '<string>', // REQUIRED
                'source' => [ // REQUIRED
                    'byteContent' => [
                        'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                        'mediaType' => '<string>', // REQUIRED
                    ],
                    's3Location' => [
                        'uri' => '<string>', // REQUIRED
                    ],
                    'sourceType' => 'S3|BYTE_CONTENT', // REQUIRED
                ],
                'useCase' => 'CODE_INTERPRETER|CHAT', // REQUIRED
            ],
            // ...
        ],
        'invocationId' => '<string>',
        'knowledgeBaseConfigurations' => [
            [
                'knowledgeBaseId' => '<string>', // REQUIRED
                'retrievalConfiguration' => [ // REQUIRED
                    'vectorSearchConfiguration' => [ // REQUIRED
                        'filter' => [
                            'andAll' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'equals' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'greaterThan' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'greaterThanOrEquals' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'in' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'lessThan' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'lessThanOrEquals' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'listContains' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'notEquals' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'notIn' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'orAll' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'startsWith' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                            'stringContains' => [
                                'key' => '<string>', // REQUIRED
                                'value' => [ // REQUIRED
                                ],
                            ],
                        ],
                        'implicitFilterConfiguration' => [
                            'metadataAttributes' => [ // REQUIRED
                                [
                                    'description' => '<string>', // REQUIRED
                                    'key' => '<string>', // REQUIRED
                                    'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                                ],
                                // ...
                            ],
                            'modelArn' => '<string>', // REQUIRED
                        ],
                        'numberOfResults' => <integer>,
                        'overrideSearchType' => 'HYBRID|SEMANTIC',
                        'rerankingConfiguration' => [
                            'bedrockRerankingConfiguration' => [
                                'metadataConfiguration' => [
                                    'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                                    'selectiveModeConfiguration' => [
                                        'fieldsToExclude' => [
                                            [
                                                'fieldName' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'fieldsToInclude' => [
                                            [
                                                'fieldName' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'modelConfiguration' => [ // REQUIRED
                                    'additionalModelRequestFields' => [
                                        '<AdditionalModelRequestFieldsKey>' => [
                                        ],
                                        // ...
                                    ],
                                    'modelArn' => '<string>', // REQUIRED
                                ],
                                'numberOfRerankedResults' => <integer>,
                            ],
                            'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
                        ],
                    ],
                ],
            ],
            // ...
        ],
        'promptSessionAttributes' => ['<string>', ...],
        'returnControlInvocationResults' => [
            [
                'apiResult' => [
                    'actionGroup' => '<string>', // REQUIRED
                    'agentId' => '<string>',
                    'apiPath' => '<string>',
                    'confirmationState' => 'CONFIRM|DENY',
                    'httpMethod' => '<string>',
                    'httpStatusCode' => <integer>,
                    'responseBody' => [
                        '<String>' => [
                            'body' => '<string>',
                        ],
                        // ...
                    ],
                    'responseState' => 'FAILURE|REPROMPT',
                ],
                'functionResult' => [
                    'actionGroup' => '<string>', // REQUIRED
                    'agentId' => '<string>',
                    'confirmationState' => 'CONFIRM|DENY',
                    'function' => '<string>',
                    'responseBody' => [
                        '<String>' => [
                            'body' => '<string>',
                        ],
                        // ...
                    ],
                    'responseState' => 'FAILURE|REPROMPT',
                ],
            ],
            // ...
        ],
        'sessionAttributes' => ['<string>', ...],
    ],
    'sourceArn' => '<string>',
    'streamingConfigurations' => [
        'applyGuardrailInterval' => <integer>,
        'streamFinalResponse' => true || false,
    ],
]);

Parameter Details

Result Syntax

[
    'completion' => [ // EventParsingIterator
        'accessDeniedException' => [
            'message' => '<string>',
        ],
        'badGatewayException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'chunk' => [
            'attribution' => [
                'citations' => [
                    [
                        'generatedResponsePart' => [
                            'textResponsePart' => [
                                'span' => [
                                    'end' => <integer>,
                                    'start' => <integer>,
                                ],
                                'text' => '<string>',
                            ],
                        ],
                        'retrievedReferences' => [
                            [
                                'content' => [
                                    'byteContent' => '<string>',
                                    'row' => [
                                        [
                                            'columnName' => '<string>',
                                            'columnValue' => '<string>',
                                            'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                        ],
                                        // ...
                                    ],
                                    'text' => '<string>',
                                    'type' => 'TEXT|IMAGE|ROW',
                                ],
                                'location' => [
                                    'confluenceLocation' => [
                                        'url' => '<string>',
                                    ],
                                    'customDocumentLocation' => [
                                        'id' => '<string>',
                                    ],
                                    'kendraDocumentLocation' => [
                                        'uri' => '<string>',
                                    ],
                                    's3Location' => [
                                        'uri' => '<string>',
                                    ],
                                    'salesforceLocation' => [
                                        'url' => '<string>',
                                    ],
                                    'sharePointLocation' => [
                                        'url' => '<string>',
                                    ],
                                    'sqlLocation' => [
                                        'query' => '<string>',
                                    ],
                                    'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                                    'webLocation' => [
                                        'url' => '<string>',
                                    ],
                                ],
                                'metadata' => [
                                    '<RetrievalResultMetadataKey>' => [
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        ],
        'conflictException' => [
            'message' => '<string>',
        ],
        'dependencyFailedException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'files' => [
            'files' => [
                [
                    'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'name' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'resourceNotFoundException' => [
            'message' => '<string>',
        ],
        'returnControl' => [
            'invocationId' => '<string>',
            'invocationInputs' => [
                [
                    'apiInvocationInput' => [
                        'actionGroup' => '<string>',
                        'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                        'agentId' => '<string>',
                        'apiPath' => '<string>',
                        'collaboratorName' => '<string>',
                        'httpMethod' => '<string>',
                        'parameters' => [
                            [
                                'name' => '<string>',
                                'type' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'requestBody' => [
                            'content' => [
                                '<String>' => [
                                    'properties' => [
                                        [
                                            'name' => '<string>',
                                            'type' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'functionInvocationInput' => [
                        'actionGroup' => '<string>',
                        'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                        'agentId' => '<string>',
                        'collaboratorName' => '<string>',
                        'function' => '<string>',
                        'parameters' => [
                            [
                                'name' => '<string>',
                                'type' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
        ],
        'serviceQuotaExceededException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'trace' => [
            'agentAliasId' => '<string>',
            'agentId' => '<string>',
            'agentVersion' => '<string>',
            'callerChain' => [
                [
                    'agentAliasArn' => '<string>',
                ],
                // ...
            ],
            'collaboratorName' => '<string>',
            'sessionId' => '<string>',
            'trace' => [
                'customOrchestrationTrace' => [
                    'event' => [
                        'text' => '<string>',
                    ],
                    'traceId' => '<string>',
                ],
                'failureTrace' => [
                    'failureReason' => '<string>',
                    'traceId' => '<string>',
                ],
                'guardrailTrace' => [
                    'action' => 'INTERVENED|NONE',
                    'inputAssessments' => [
                        [
                            'contentPolicy' => [
                                'filters' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                        'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                    ],
                                    // ...
                                ],
                            ],
                            'sensitiveInformationPolicy' => [
                                'piiEntities' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                    ],
                                    // ...
                                ],
                                'regexes' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'name' => '<string>',
                                        'regex' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'topicPolicy' => [
                                'topics' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'name' => '<string>',
                                        'type' => 'DENY',
                                    ],
                                    // ...
                                ],
                            ],
                            'wordPolicy' => [
                                'customWords' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                    ],
                                    // ...
                                ],
                                'managedWordLists' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                        'type' => 'PROFANITY',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'outputAssessments' => [
                        [
                            'contentPolicy' => [
                                'filters' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                        'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                    ],
                                    // ...
                                ],
                            ],
                            'sensitiveInformationPolicy' => [
                                'piiEntities' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                    ],
                                    // ...
                                ],
                                'regexes' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'name' => '<string>',
                                        'regex' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'topicPolicy' => [
                                'topics' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'name' => '<string>',
                                        'type' => 'DENY',
                                    ],
                                    // ...
                                ],
                            ],
                            'wordPolicy' => [
                                'customWords' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                    ],
                                    // ...
                                ],
                                'managedWordLists' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                        'type' => 'PROFANITY',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'traceId' => '<string>',
                ],
                'orchestrationTrace' => [
                    'invocationInput' => [
                        'actionGroupInvocationInput' => [
                            'actionGroupName' => '<string>',
                            'apiPath' => '<string>',
                            'executionType' => 'LAMBDA|RETURN_CONTROL',
                            'function' => '<string>',
                            'invocationId' => '<string>',
                            'parameters' => [
                                [
                                    'name' => '<string>',
                                    'type' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'requestBody' => [
                                'content' => [
                                    '<String>' => [
                                        [
                                            'name' => '<string>',
                                            'type' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    // ...
                                ],
                            ],
                            'verb' => '<string>',
                        ],
                        'agentCollaboratorInvocationInput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'input' => [
                                'returnControlResults' => [
                                    'invocationId' => '<string>',
                                    'returnControlInvocationResults' => [
                                        [
                                            'apiResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'httpMethod' => '<string>',
                                                'httpStatusCode' => <integer>,
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                            'functionResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'function' => '<string>',
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationInput' => [
                            'code' => '<string>',
                            'files' => ['<string>', ...],
                        ],
                        'invocationType' => 'ACTION_GROUP|KNOWLEDGE_BASE|FINISH|ACTION_GROUP_CODE_INTERPRETER|AGENT_COLLABORATOR',
                        'knowledgeBaseLookupInput' => [
                            'knowledgeBaseId' => '<string>',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'observation' => [
                        'actionGroupInvocationOutput' => [
                            'text' => '<string>',
                        ],
                        'agentCollaboratorInvocationOutput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'output' => [
                                'returnControlPayload' => [
                                    'invocationId' => '<string>',
                                    'invocationInputs' => [
                                        [
                                            'apiInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'httpMethod' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'requestBody' => [
                                                    'content' => [
                                                        '<String>' => [
                                                            'properties' => [
                                                                [
                                                                    'name' => '<string>',
                                                                    'type' => '<string>',
                                                                    'value' => '<string>',
                                                                ],
                                                                // ...
                                                            ],
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'functionInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'function' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationOutput' => [
                            'executionError' => '<string>',
                            'executionOutput' => '<string>',
                            'executionTimeout' => true || false,
                            'files' => ['<string>', ...],
                        ],
                        'finalResponse' => [
                            'text' => '<string>',
                        ],
                        'knowledgeBaseLookupOutput' => [
                            'retrievedReferences' => [
                                [
                                    'content' => [
                                        'byteContent' => '<string>',
                                        'row' => [
                                            [
                                                'columnName' => '<string>',
                                                'columnValue' => '<string>',
                                                'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                        'type' => 'TEXT|IMAGE|ROW',
                                    ],
                                    'location' => [
                                        'confluenceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'customDocumentLocation' => [
                                            'id' => '<string>',
                                        ],
                                        'kendraDocumentLocation' => [
                                            'uri' => '<string>',
                                        ],
                                        's3Location' => [
                                            'uri' => '<string>',
                                        ],
                                        'salesforceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sharePointLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sqlLocation' => [
                                            'query' => '<string>',
                                        ],
                                        'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                                        'webLocation' => [
                                            'url' => '<string>',
                                        ],
                                    ],
                                    'metadata' => [
                                        '<RetrievalResultMetadataKey>' => [
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'repromptResponse' => [
                            'source' => 'ACTION_GROUP|KNOWLEDGE_BASE|PARSER',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                        'type' => 'ACTION_GROUP|AGENT_COLLABORATOR|KNOWLEDGE_BASE|FINISH|ASK_USER|REPROMPT',
                    ],
                    'rationale' => [
                        'text' => '<string>',
                        'traceId' => '<string>',
                    ],
                ],
                'postProcessingTrace' => [
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'parsedResponse' => [
                            'text' => '<string>',
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                ],
                'preProcessingTrace' => [
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'parsedResponse' => [
                            'isValid' => true || false,
                            'rationale' => '<string>',
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                ],
                'routingClassifierTrace' => [
                    'invocationInput' => [
                        'actionGroupInvocationInput' => [
                            'actionGroupName' => '<string>',
                            'apiPath' => '<string>',
                            'executionType' => 'LAMBDA|RETURN_CONTROL',
                            'function' => '<string>',
                            'invocationId' => '<string>',
                            'parameters' => [
                                [
                                    'name' => '<string>',
                                    'type' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'requestBody' => [
                                'content' => [
                                    '<String>' => [
                                        [
                                            'name' => '<string>',
                                            'type' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    // ...
                                ],
                            ],
                            'verb' => '<string>',
                        ],
                        'agentCollaboratorInvocationInput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'input' => [
                                'returnControlResults' => [
                                    'invocationId' => '<string>',
                                    'returnControlInvocationResults' => [
                                        [
                                            'apiResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'httpMethod' => '<string>',
                                                'httpStatusCode' => <integer>,
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                            'functionResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'function' => '<string>',
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationInput' => [
                            'code' => '<string>',
                            'files' => ['<string>', ...],
                        ],
                        'invocationType' => 'ACTION_GROUP|KNOWLEDGE_BASE|FINISH|ACTION_GROUP_CODE_INTERPRETER|AGENT_COLLABORATOR',
                        'knowledgeBaseLookupInput' => [
                            'knowledgeBaseId' => '<string>',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'observation' => [
                        'actionGroupInvocationOutput' => [
                            'text' => '<string>',
                        ],
                        'agentCollaboratorInvocationOutput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'output' => [
                                'returnControlPayload' => [
                                    'invocationId' => '<string>',
                                    'invocationInputs' => [
                                        [
                                            'apiInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'httpMethod' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'requestBody' => [
                                                    'content' => [
                                                        '<String>' => [
                                                            'properties' => [
                                                                [
                                                                    'name' => '<string>',
                                                                    'type' => '<string>',
                                                                    'value' => '<string>',
                                                                ],
                                                                // ...
                                                            ],
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'functionInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'function' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationOutput' => [
                            'executionError' => '<string>',
                            'executionOutput' => '<string>',
                            'executionTimeout' => true || false,
                            'files' => ['<string>', ...],
                        ],
                        'finalResponse' => [
                            'text' => '<string>',
                        ],
                        'knowledgeBaseLookupOutput' => [
                            'retrievedReferences' => [
                                [
                                    'content' => [
                                        'byteContent' => '<string>',
                                        'row' => [
                                            [
                                                'columnName' => '<string>',
                                                'columnValue' => '<string>',
                                                'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                        'type' => 'TEXT|IMAGE|ROW',
                                    ],
                                    'location' => [
                                        'confluenceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'customDocumentLocation' => [
                                            'id' => '<string>',
                                        ],
                                        'kendraDocumentLocation' => [
                                            'uri' => '<string>',
                                        ],
                                        's3Location' => [
                                            'uri' => '<string>',
                                        ],
                                        'salesforceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sharePointLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sqlLocation' => [
                                            'query' => '<string>',
                                        ],
                                        'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                                        'webLocation' => [
                                            'url' => '<string>',
                                        ],
                                    ],
                                    'metadata' => [
                                        '<RetrievalResultMetadataKey>' => [
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'repromptResponse' => [
                            'source' => 'ACTION_GROUP|KNOWLEDGE_BASE|PARSER',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                        'type' => 'ACTION_GROUP|AGENT_COLLABORATOR|KNOWLEDGE_BASE|FINISH|ASK_USER|REPROMPT',
                    ],
                ],
            ],
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
    'contentType' => '<string>',
    'memoryId' => '<string>',
    'sessionId' => '<string>',
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['completion'] as $event) {
    if (isset($event['accessDeniedException'])) {
        // Handle the 'accessDeniedException' event.
    } else if (isset($event['badGatewayException'])) {
        // Handle the 'badGatewayException' event.
    } else if (isset($event['chunk'])) {
        // Handle the 'chunk' event.
    } else if (isset($event['conflictException'])) {
        // Handle the 'conflictException' event.
    } else if (isset($event['dependencyFailedException'])) {
        // Handle the 'dependencyFailedException' event.
    } else if (isset($event['files'])) {
        // Handle the 'files' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['resourceNotFoundException'])) {
        // Handle the 'resourceNotFoundException' event.
    } else if (isset($event['returnControl'])) {
        // Handle the 'returnControl' event.
    } else if (isset($event['serviceQuotaExceededException'])) {
        // Handle the 'serviceQuotaExceededException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['trace'])) {
        // Handle the 'trace' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

InvokeFlow

$result = $client->invokeFlow([/* ... */]);
$promise = $client->invokeFlowAsync([/* ... */]);

Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->invokeFlow([
    'enableTrace' => true || false,
    'flowAliasIdentifier' => '<string>', // REQUIRED
    'flowIdentifier' => '<string>', // REQUIRED
    'inputs' => [ // REQUIRED
        [
            'content' => [ // REQUIRED
                'document' => [
                ],
            ],
            'nodeName' => '<string>', // REQUIRED
            'nodeOutputName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'responseStream' => [ // EventParsingIterator
        'accessDeniedException' => [
            'message' => '<string>',
        ],
        'badGatewayException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'conflictException' => [
            'message' => '<string>',
        ],
        'dependencyFailedException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'flowCompletionEvent' => [
            'completionReason' => 'SUCCESS',
        ],
        'flowOutputEvent' => [
            'content' => [
                'document' => [
                ],
            ],
            'nodeName' => '<string>',
            'nodeType' => 'FlowInputNode|FlowOutputNode|LambdaFunctionNode|KnowledgeBaseNode|PromptNode|ConditionNode|LexNode',
        ],
        'flowTraceEvent' => [
            'trace' => [
                'conditionNodeResultTrace' => [
                    'nodeName' => '<string>',
                    'satisfiedConditions' => [
                        [
                            'conditionName' => '<string>',
                        ],
                        // ...
                    ],
                    'timestamp' => <DateTime>,
                ],
                'nodeInputTrace' => [
                    'fields' => [
                        [
                            'content' => [
                                'document' => [
                                ],
                            ],
                            'nodeInputName' => '<string>',
                        ],
                        // ...
                    ],
                    'nodeName' => '<string>',
                    'timestamp' => <DateTime>,
                ],
                'nodeOutputTrace' => [
                    'fields' => [
                        [
                            'content' => [
                                'document' => [
                                ],
                            ],
                            'nodeOutputName' => '<string>',
                        ],
                        // ...
                    ],
                    'nodeName' => '<string>',
                    'timestamp' => <DateTime>,
                ],
            ],
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'resourceNotFoundException' => [
            'message' => '<string>',
        ],
        'serviceQuotaExceededException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['responseStream'] as $event) {
    if (isset($event['accessDeniedException'])) {
        // Handle the 'accessDeniedException' event.
    } else if (isset($event['badGatewayException'])) {
        // Handle the 'badGatewayException' event.
    } else if (isset($event['conflictException'])) {
        // Handle the 'conflictException' event.
    } else if (isset($event['dependencyFailedException'])) {
        // Handle the 'dependencyFailedException' event.
    } else if (isset($event['flowCompletionEvent'])) {
        // Handle the 'flowCompletionEvent' event.
    } else if (isset($event['flowOutputEvent'])) {
        // Handle the 'flowOutputEvent' event.
    } else if (isset($event['flowTraceEvent'])) {
        // Handle the 'flowTraceEvent' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['resourceNotFoundException'])) {
        // Handle the 'resourceNotFoundException' event.
    } else if (isset($event['serviceQuotaExceededException'])) {
        // Handle the 'serviceQuotaExceededException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

InvokeInlineAgent

$result = $client->invokeInlineAgent([/* ... */]);
$promise = $client->invokeInlineAgentAsync([/* ... */]);

Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.

• Specify the following fields for security purposes.

  • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

  • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.

• To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

• The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.

Parameter Syntax

$result = $client->invokeInlineAgent([
    'actionGroups' => [
        [
            'actionGroupExecutor' => [
                'customControl' => 'RETURN_CONTROL',
                'lambda' => '<string>',
            ],
            'actionGroupName' => '<string>', // REQUIRED
            'apiSchema' => [
                'payload' => '<string>',
                's3' => [
                    's3BucketName' => '<string>',
                    's3ObjectKey' => '<string>',
                ],
            ],
            'description' => '<string>',
            'functionSchema' => [
                'functions' => [
                    [
                        'description' => '<string>',
                        'name' => '<string>', // REQUIRED
                        'parameters' => [
                            '<ParameterName>' => [
                                'description' => '<string>',
                                'required' => true || false,
                                'type' => 'string|number|integer|boolean|array', // REQUIRED
                            ],
                            // ...
                        ],
                        'requireConfirmation' => 'ENABLED|DISABLED',
                    ],
                    // ...
                ],
            ],
            'parentActionGroupSignature' => 'AMAZON.UserInput|AMAZON.CodeInterpreter',
        ],
        // ...
    ],
    'customerEncryptionKeyArn' => '<string>',
    'enableTrace' => true || false,
    'endSession' => true || false,
    'foundationModel' => '<string>', // REQUIRED
    'guardrailConfiguration' => [
        'guardrailIdentifier' => '<string>', // REQUIRED
        'guardrailVersion' => '<string>', // REQUIRED
    ],
    'idleSessionTTLInSeconds' => <integer>,
    'inlineSessionState' => [
        'files' => [
            [
                'name' => '<string>', // REQUIRED
                'source' => [ // REQUIRED
                    'byteContent' => [
                        'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                        'mediaType' => '<string>', // REQUIRED
                    ],
                    's3Location' => [
                        'uri' => '<string>', // REQUIRED
                    ],
                    'sourceType' => 'S3|BYTE_CONTENT', // REQUIRED
                ],
                'useCase' => 'CODE_INTERPRETER|CHAT', // REQUIRED
            ],
            // ...
        ],
        'invocationId' => '<string>',
        'promptSessionAttributes' => ['<string>', ...],
        'returnControlInvocationResults' => [
            [
                'apiResult' => [
                    'actionGroup' => '<string>', // REQUIRED
                    'agentId' => '<string>',
                    'apiPath' => '<string>',
                    'confirmationState' => 'CONFIRM|DENY',
                    'httpMethod' => '<string>',
                    'httpStatusCode' => <integer>,
                    'responseBody' => [
                        '<String>' => [
                            'body' => '<string>',
                        ],
                        // ...
                    ],
                    'responseState' => 'FAILURE|REPROMPT',
                ],
                'functionResult' => [
                    'actionGroup' => '<string>', // REQUIRED
                    'agentId' => '<string>',
                    'confirmationState' => 'CONFIRM|DENY',
                    'function' => '<string>',
                    'responseBody' => [
                        '<String>' => [
                            'body' => '<string>',
                        ],
                        // ...
                    ],
                    'responseState' => 'FAILURE|REPROMPT',
                ],
            ],
            // ...
        ],
        'sessionAttributes' => ['<string>', ...],
    ],
    'inputText' => '<string>',
    'instruction' => '<string>', // REQUIRED
    'knowledgeBases' => [
        [
            'description' => '<string>', // REQUIRED
            'knowledgeBaseId' => '<string>', // REQUIRED
            'retrievalConfiguration' => [
                'vectorSearchConfiguration' => [ // REQUIRED
                    'filter' => [
                        'andAll' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'equals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'greaterThan' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'greaterThanOrEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'in' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'lessThan' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'lessThanOrEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'listContains' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'notEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'notIn' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'orAll' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'startsWith' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'stringContains' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                    ],
                    'implicitFilterConfiguration' => [
                        'metadataAttributes' => [ // REQUIRED
                            [
                                'description' => '<string>', // REQUIRED
                                'key' => '<string>', // REQUIRED
                                'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                            ],
                            // ...
                        ],
                        'modelArn' => '<string>', // REQUIRED
                    ],
                    'numberOfResults' => <integer>,
                    'overrideSearchType' => 'HYBRID|SEMANTIC',
                    'rerankingConfiguration' => [
                        'bedrockRerankingConfiguration' => [
                            'metadataConfiguration' => [
                                'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                                'selectiveModeConfiguration' => [
                                    'fieldsToExclude' => [
                                        [
                                            'fieldName' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'fieldsToInclude' => [
                                        [
                                            'fieldName' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            'modelConfiguration' => [ // REQUIRED
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'modelArn' => '<string>', // REQUIRED
                            ],
                            'numberOfRerankedResults' => <integer>,
                        ],
                        'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
                    ],
                ],
            ],
        ],
        // ...
    ],
    'promptOverrideConfiguration' => [
        'overrideLambda' => '<string>',
        'promptConfigurations' => [ // REQUIRED
            [
                'basePromptTemplate' => '<string>',
                'inferenceConfiguration' => [
                    'maximumLength' => <integer>,
                    'stopSequences' => ['<string>', ...],
                    'temperature' => <float>,
                    'topK' => <integer>,
                    'topP' => <float>,
                ],
                'parserMode' => 'DEFAULT|OVERRIDDEN',
                'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                'promptState' => 'ENABLED|DISABLED',
                'promptType' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
            ],
            // ...
        ],
    ],
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'completion' => [ // EventParsingIterator
        'accessDeniedException' => [
            'message' => '<string>',
        ],
        'badGatewayException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'chunk' => [
            'attribution' => [
                'citations' => [
                    [
                        'generatedResponsePart' => [
                            'textResponsePart' => [
                                'span' => [
                                    'end' => <integer>,
                                    'start' => <integer>,
                                ],
                                'text' => '<string>',
                            ],
                        ],
                        'retrievedReferences' => [
                            [
                                'content' => [
                                    'byteContent' => '<string>',
                                    'row' => [
                                        [
                                            'columnName' => '<string>',
                                            'columnValue' => '<string>',
                                            'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                        ],
                                        // ...
                                    ],
                                    'text' => '<string>',
                                    'type' => 'TEXT|IMAGE|ROW',
                                ],
                                'location' => [
                                    'confluenceLocation' => [
                                        'url' => '<string>',
                                    ],
                                    'customDocumentLocation' => [
                                        'id' => '<string>',
                                    ],
                                    'kendraDocumentLocation' => [
                                        'uri' => '<string>',
                                    ],
                                    's3Location' => [
                                        'uri' => '<string>',
                                    ],
                                    'salesforceLocation' => [
                                        'url' => '<string>',
                                    ],
                                    'sharePointLocation' => [
                                        'url' => '<string>',
                                    ],
                                    'sqlLocation' => [
                                        'query' => '<string>',
                                    ],
                                    'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                                    'webLocation' => [
                                        'url' => '<string>',
                                    ],
                                ],
                                'metadata' => [
                                    '<RetrievalResultMetadataKey>' => [
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
        ],
        'conflictException' => [
            'message' => '<string>',
        ],
        'dependencyFailedException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'files' => [
            'files' => [
                [
                    'bytes' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'name' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'resourceNotFoundException' => [
            'message' => '<string>',
        ],
        'returnControl' => [
            'invocationId' => '<string>',
            'invocationInputs' => [
                [
                    'apiInvocationInput' => [
                        'actionGroup' => '<string>',
                        'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                        'agentId' => '<string>',
                        'apiPath' => '<string>',
                        'collaboratorName' => '<string>',
                        'httpMethod' => '<string>',
                        'parameters' => [
                            [
                                'name' => '<string>',
                                'type' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'requestBody' => [
                            'content' => [
                                '<String>' => [
                                    'properties' => [
                                        [
                                            'name' => '<string>',
                                            'type' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'functionInvocationInput' => [
                        'actionGroup' => '<string>',
                        'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                        'agentId' => '<string>',
                        'collaboratorName' => '<string>',
                        'function' => '<string>',
                        'parameters' => [
                            [
                                'name' => '<string>',
                                'type' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
        ],
        'serviceQuotaExceededException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'trace' => [
            'sessionId' => '<string>',
            'trace' => [
                'customOrchestrationTrace' => [
                    'event' => [
                        'text' => '<string>',
                    ],
                    'traceId' => '<string>',
                ],
                'failureTrace' => [
                    'failureReason' => '<string>',
                    'traceId' => '<string>',
                ],
                'guardrailTrace' => [
                    'action' => 'INTERVENED|NONE',
                    'inputAssessments' => [
                        [
                            'contentPolicy' => [
                                'filters' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                        'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                    ],
                                    // ...
                                ],
                            ],
                            'sensitiveInformationPolicy' => [
                                'piiEntities' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                    ],
                                    // ...
                                ],
                                'regexes' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'name' => '<string>',
                                        'regex' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'topicPolicy' => [
                                'topics' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'name' => '<string>',
                                        'type' => 'DENY',
                                    ],
                                    // ...
                                ],
                            ],
                            'wordPolicy' => [
                                'customWords' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                    ],
                                    // ...
                                ],
                                'managedWordLists' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                        'type' => 'PROFANITY',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'outputAssessments' => [
                        [
                            'contentPolicy' => [
                                'filters' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'confidence' => 'NONE|LOW|MEDIUM|HIGH',
                                        'type' => 'INSULTS|HATE|SEXUAL|VIOLENCE|MISCONDUCT|PROMPT_ATTACK',
                                    ],
                                    // ...
                                ],
                            ],
                            'sensitiveInformationPolicy' => [
                                'piiEntities' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                                    ],
                                    // ...
                                ],
                                'regexes' => [
                                    [
                                        'action' => 'BLOCKED|ANONYMIZED',
                                        'match' => '<string>',
                                        'name' => '<string>',
                                        'regex' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'topicPolicy' => [
                                'topics' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'name' => '<string>',
                                        'type' => 'DENY',
                                    ],
                                    // ...
                                ],
                            ],
                            'wordPolicy' => [
                                'customWords' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                    ],
                                    // ...
                                ],
                                'managedWordLists' => [
                                    [
                                        'action' => 'BLOCKED',
                                        'match' => '<string>',
                                        'type' => 'PROFANITY',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'traceId' => '<string>',
                ],
                'orchestrationTrace' => [
                    'invocationInput' => [
                        'actionGroupInvocationInput' => [
                            'actionGroupName' => '<string>',
                            'apiPath' => '<string>',
                            'executionType' => 'LAMBDA|RETURN_CONTROL',
                            'function' => '<string>',
                            'invocationId' => '<string>',
                            'parameters' => [
                                [
                                    'name' => '<string>',
                                    'type' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'requestBody' => [
                                'content' => [
                                    '<String>' => [
                                        [
                                            'name' => '<string>',
                                            'type' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    // ...
                                ],
                            ],
                            'verb' => '<string>',
                        ],
                        'agentCollaboratorInvocationInput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'input' => [
                                'returnControlResults' => [
                                    'invocationId' => '<string>',
                                    'returnControlInvocationResults' => [
                                        [
                                            'apiResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'httpMethod' => '<string>',
                                                'httpStatusCode' => <integer>,
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                            'functionResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'function' => '<string>',
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationInput' => [
                            'code' => '<string>',
                            'files' => ['<string>', ...],
                        ],
                        'invocationType' => 'ACTION_GROUP|KNOWLEDGE_BASE|FINISH|ACTION_GROUP_CODE_INTERPRETER|AGENT_COLLABORATOR',
                        'knowledgeBaseLookupInput' => [
                            'knowledgeBaseId' => '<string>',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'observation' => [
                        'actionGroupInvocationOutput' => [
                            'text' => '<string>',
                        ],
                        'agentCollaboratorInvocationOutput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'output' => [
                                'returnControlPayload' => [
                                    'invocationId' => '<string>',
                                    'invocationInputs' => [
                                        [
                                            'apiInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'httpMethod' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'requestBody' => [
                                                    'content' => [
                                                        '<String>' => [
                                                            'properties' => [
                                                                [
                                                                    'name' => '<string>',
                                                                    'type' => '<string>',
                                                                    'value' => '<string>',
                                                                ],
                                                                // ...
                                                            ],
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'functionInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'function' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationOutput' => [
                            'executionError' => '<string>',
                            'executionOutput' => '<string>',
                            'executionTimeout' => true || false,
                            'files' => ['<string>', ...],
                        ],
                        'finalResponse' => [
                            'text' => '<string>',
                        ],
                        'knowledgeBaseLookupOutput' => [
                            'retrievedReferences' => [
                                [
                                    'content' => [
                                        'byteContent' => '<string>',
                                        'row' => [
                                            [
                                                'columnName' => '<string>',
                                                'columnValue' => '<string>',
                                                'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                        'type' => 'TEXT|IMAGE|ROW',
                                    ],
                                    'location' => [
                                        'confluenceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'customDocumentLocation' => [
                                            'id' => '<string>',
                                        ],
                                        'kendraDocumentLocation' => [
                                            'uri' => '<string>',
                                        ],
                                        's3Location' => [
                                            'uri' => '<string>',
                                        ],
                                        'salesforceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sharePointLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sqlLocation' => [
                                            'query' => '<string>',
                                        ],
                                        'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                                        'webLocation' => [
                                            'url' => '<string>',
                                        ],
                                    ],
                                    'metadata' => [
                                        '<RetrievalResultMetadataKey>' => [
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'repromptResponse' => [
                            'source' => 'ACTION_GROUP|KNOWLEDGE_BASE|PARSER',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                        'type' => 'ACTION_GROUP|AGENT_COLLABORATOR|KNOWLEDGE_BASE|FINISH|ASK_USER|REPROMPT',
                    ],
                    'rationale' => [
                        'text' => '<string>',
                        'traceId' => '<string>',
                    ],
                ],
                'postProcessingTrace' => [
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'parsedResponse' => [
                            'text' => '<string>',
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                ],
                'preProcessingTrace' => [
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'parsedResponse' => [
                            'isValid' => true || false,
                            'rationale' => '<string>',
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                ],
                'routingClassifierTrace' => [
                    'invocationInput' => [
                        'actionGroupInvocationInput' => [
                            'actionGroupName' => '<string>',
                            'apiPath' => '<string>',
                            'executionType' => 'LAMBDA|RETURN_CONTROL',
                            'function' => '<string>',
                            'invocationId' => '<string>',
                            'parameters' => [
                                [
                                    'name' => '<string>',
                                    'type' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'requestBody' => [
                                'content' => [
                                    '<String>' => [
                                        [
                                            'name' => '<string>',
                                            'type' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    // ...
                                ],
                            ],
                            'verb' => '<string>',
                        ],
                        'agentCollaboratorInvocationInput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'input' => [
                                'returnControlResults' => [
                                    'invocationId' => '<string>',
                                    'returnControlInvocationResults' => [
                                        [
                                            'apiResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'httpMethod' => '<string>',
                                                'httpStatusCode' => <integer>,
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                            'functionResult' => [
                                                'actionGroup' => '<string>',
                                                'agentId' => '<string>',
                                                'confirmationState' => 'CONFIRM|DENY',
                                                'function' => '<string>',
                                                'responseBody' => [
                                                    '<String>' => [
                                                        'body' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'responseState' => 'FAILURE|REPROMPT',
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationInput' => [
                            'code' => '<string>',
                            'files' => ['<string>', ...],
                        ],
                        'invocationType' => 'ACTION_GROUP|KNOWLEDGE_BASE|FINISH|ACTION_GROUP_CODE_INTERPRETER|AGENT_COLLABORATOR',
                        'knowledgeBaseLookupInput' => [
                            'knowledgeBaseId' => '<string>',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'modelInvocationInput' => [
                        'foundationModel' => '<string>',
                        'inferenceConfiguration' => [
                            'maximumLength' => <integer>,
                            'stopSequences' => ['<string>', ...],
                            'temperature' => <float>,
                            'topK' => <integer>,
                            'topP' => <float>,
                        ],
                        'overrideLambda' => '<string>',
                        'parserMode' => 'DEFAULT|OVERRIDDEN',
                        'promptCreationMode' => 'DEFAULT|OVERRIDDEN',
                        'text' => '<string>',
                        'traceId' => '<string>',
                        'type' => 'PRE_PROCESSING|ORCHESTRATION|KNOWLEDGE_BASE_RESPONSE_GENERATION|POST_PROCESSING|ROUTING_CLASSIFIER',
                    ],
                    'modelInvocationOutput' => [
                        'metadata' => [
                            'usage' => [
                                'inputTokens' => <integer>,
                                'outputTokens' => <integer>,
                            ],
                        ],
                        'rawResponse' => [
                            'content' => '<string>',
                        ],
                        'traceId' => '<string>',
                    ],
                    'observation' => [
                        'actionGroupInvocationOutput' => [
                            'text' => '<string>',
                        ],
                        'agentCollaboratorInvocationOutput' => [
                            'agentCollaboratorAliasArn' => '<string>',
                            'agentCollaboratorName' => '<string>',
                            'output' => [
                                'returnControlPayload' => [
                                    'invocationId' => '<string>',
                                    'invocationInputs' => [
                                        [
                                            'apiInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'apiPath' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'httpMethod' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'requestBody' => [
                                                    'content' => [
                                                        '<String>' => [
                                                            'properties' => [
                                                                [
                                                                    'name' => '<string>',
                                                                    'type' => '<string>',
                                                                    'value' => '<string>',
                                                                ],
                                                                // ...
                                                            ],
                                                        ],
                                                        // ...
                                                    ],
                                                ],
                                            ],
                                            'functionInvocationInput' => [
                                                'actionGroup' => '<string>',
                                                'actionInvocationType' => 'RESULT|USER_CONFIRMATION|USER_CONFIRMATION_AND_RESULT',
                                                'agentId' => '<string>',
                                                'collaboratorName' => '<string>',
                                                'function' => '<string>',
                                                'parameters' => [
                                                    [
                                                        'name' => '<string>',
                                                        'type' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        // ...
                                    ],
                                ],
                                'text' => '<string>',
                                'type' => 'TEXT|RETURN_CONTROL',
                            ],
                        ],
                        'codeInterpreterInvocationOutput' => [
                            'executionError' => '<string>',
                            'executionOutput' => '<string>',
                            'executionTimeout' => true || false,
                            'files' => ['<string>', ...],
                        ],
                        'finalResponse' => [
                            'text' => '<string>',
                        ],
                        'knowledgeBaseLookupOutput' => [
                            'retrievedReferences' => [
                                [
                                    'content' => [
                                        'byteContent' => '<string>',
                                        'row' => [
                                            [
                                                'columnName' => '<string>',
                                                'columnValue' => '<string>',
                                                'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                            ],
                                            // ...
                                        ],
                                        'text' => '<string>',
                                        'type' => 'TEXT|IMAGE|ROW',
                                    ],
                                    'location' => [
                                        'confluenceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'customDocumentLocation' => [
                                            'id' => '<string>',
                                        ],
                                        'kendraDocumentLocation' => [
                                            'uri' => '<string>',
                                        ],
                                        's3Location' => [
                                            'uri' => '<string>',
                                        ],
                                        'salesforceLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sharePointLocation' => [
                                            'url' => '<string>',
                                        ],
                                        'sqlLocation' => [
                                            'query' => '<string>',
                                        ],
                                        'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                                        'webLocation' => [
                                            'url' => '<string>',
                                        ],
                                    ],
                                    'metadata' => [
                                        '<RetrievalResultMetadataKey>' => [
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'repromptResponse' => [
                            'source' => 'ACTION_GROUP|KNOWLEDGE_BASE|PARSER',
                            'text' => '<string>',
                        ],
                        'traceId' => '<string>',
                        'type' => 'ACTION_GROUP|AGENT_COLLABORATOR|KNOWLEDGE_BASE|FINISH|ASK_USER|REPROMPT',
                    ],
                ],
            ],
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
    'contentType' => '<string>',
    'sessionId' => '<string>',
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['completion'] as $event) {
    if (isset($event['accessDeniedException'])) {
        // Handle the 'accessDeniedException' event.
    } else if (isset($event['badGatewayException'])) {
        // Handle the 'badGatewayException' event.
    } else if (isset($event['chunk'])) {
        // Handle the 'chunk' event.
    } else if (isset($event['conflictException'])) {
        // Handle the 'conflictException' event.
    } else if (isset($event['dependencyFailedException'])) {
        // Handle the 'dependencyFailedException' event.
    } else if (isset($event['files'])) {
        // Handle the 'files' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['resourceNotFoundException'])) {
        // Handle the 'resourceNotFoundException' event.
    } else if (isset($event['returnControl'])) {
        // Handle the 'returnControl' event.
    } else if (isset($event['serviceQuotaExceededException'])) {
        // Handle the 'serviceQuotaExceededException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['trace'])) {
        // Handle the 'trace' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

OptimizePrompt

$result = $client->optimizePrompt([/* ... */]);
$promise = $client->optimizePromptAsync([/* ... */]);

Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.

Parameter Syntax

$result = $client->optimizePrompt([
    'input' => [ // REQUIRED
        'textPrompt' => [
            'text' => '<string>', // REQUIRED
        ],
    ],
    'targetModelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'optimizedPrompt' => [ // EventParsingIterator
        'accessDeniedException' => [
            'message' => '<string>',
        ],
        'analyzePromptEvent' => [
            'message' => '<string>',
        ],
        'badGatewayException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'dependencyFailedException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'optimizedPromptEvent' => [
            'optimizedPrompt' => [
                'textPrompt' => [
                    'text' => '<string>',
                ],
            ],
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['optimizedPrompt'] as $event) {
    if (isset($event['accessDeniedException'])) {
        // Handle the 'accessDeniedException' event.
    } else if (isset($event['analyzePromptEvent'])) {
        // Handle the 'analyzePromptEvent' event.
    } else if (isset($event['badGatewayException'])) {
        // Handle the 'badGatewayException' event.
    } else if (isset($event['dependencyFailedException'])) {
        // Handle the 'dependencyFailedException' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['optimizedPromptEvent'])) {
        // Handle the 'optimizedPromptEvent' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

Rerank

$result = $client->rerank([/* ... */]);
$promise = $client->rerankAsync([/* ... */]);

Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.

Parameter Syntax

$result = $client->rerank([
    'nextToken' => '<string>',
    'queries' => [ // REQUIRED
        [
            'textQuery' => [ // REQUIRED
                'text' => '<string>',
            ],
            'type' => 'TEXT', // REQUIRED
        ],
        // ...
    ],
    'rerankingConfiguration' => [ // REQUIRED
        'bedrockRerankingConfiguration' => [ // REQUIRED
            'modelConfiguration' => [ // REQUIRED
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'modelArn' => '<string>', // REQUIRED
            ],
            'numberOfResults' => <integer>,
        ],
        'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
    ],
    'sources' => [ // REQUIRED
        [
            'inlineDocumentSource' => [ // REQUIRED
                'jsonDocument' => [
                ],
                'textDocument' => [
                    'text' => '<string>',
                ],
                'type' => 'TEXT|JSON', // REQUIRED
            ],
            'type' => 'INLINE', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'results' => [
        [
            'document' => [
                'jsonDocument' => [
                ],
                'textDocument' => [
                    'text' => '<string>',
                ],
                'type' => 'TEXT|JSON',
            ],
            'index' => <integer>,
            'relevanceScore' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

Retrieve

$result = $client->retrieve([/* ... */]);
$promise = $client->retrieveAsync([/* ... */]);

Queries a knowledge base and retrieves information from it.

Parameter Syntax

$result = $client->retrieve([
    'guardrailConfiguration' => [
        'guardrailId' => '<string>', // REQUIRED
        'guardrailVersion' => '<string>', // REQUIRED
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'retrievalConfiguration' => [
        'vectorSearchConfiguration' => [ // REQUIRED
            'filter' => [
                'andAll' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'equals' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'greaterThan' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'greaterThanOrEquals' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'in' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'lessThan' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'lessThanOrEquals' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'listContains' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'notEquals' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'notIn' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'orAll' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'startsWith' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
                'stringContains' => [
                    'key' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                    ],
                ],
            ],
            'implicitFilterConfiguration' => [
                'metadataAttributes' => [ // REQUIRED
                    [
                        'description' => '<string>', // REQUIRED
                        'key' => '<string>', // REQUIRED
                        'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                    ],
                    // ...
                ],
                'modelArn' => '<string>', // REQUIRED
            ],
            'numberOfResults' => <integer>,
            'overrideSearchType' => 'HYBRID|SEMANTIC',
            'rerankingConfiguration' => [
                'bedrockRerankingConfiguration' => [
                    'metadataConfiguration' => [
                        'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                        'selectiveModeConfiguration' => [
                            'fieldsToExclude' => [
                                [
                                    'fieldName' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'fieldsToInclude' => [
                                [
                                    'fieldName' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'modelConfiguration' => [ // REQUIRED
                        'additionalModelRequestFields' => [
                            '<AdditionalModelRequestFieldsKey>' => [
                            ],
                            // ...
                        ],
                        'modelArn' => '<string>', // REQUIRED
                    ],
                    'numberOfRerankedResults' => <integer>,
                ],
                'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
            ],
        ],
    ],
    'retrievalQuery' => [ // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'guardrailAction' => 'INTERVENED|NONE',
    'nextToken' => '<string>',
    'retrievalResults' => [
        [
            'content' => [
                'byteContent' => '<string>',
                'row' => [
                    [
                        'columnName' => '<string>',
                        'columnValue' => '<string>',
                        'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                    ],
                    // ...
                ],
                'text' => '<string>',
                'type' => 'TEXT|IMAGE|ROW',
            ],
            'location' => [
                'confluenceLocation' => [
                    'url' => '<string>',
                ],
                'customDocumentLocation' => [
                    'id' => '<string>',
                ],
                'kendraDocumentLocation' => [
                    'uri' => '<string>',
                ],
                's3Location' => [
                    'uri' => '<string>',
                ],
                'salesforceLocation' => [
                    'url' => '<string>',
                ],
                'sharePointLocation' => [
                    'url' => '<string>',
                ],
                'sqlLocation' => [
                    'query' => '<string>',
                ],
                'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                'webLocation' => [
                    'url' => '<string>',
                ],
            ],
            'metadata' => [
                '<RetrievalResultMetadataKey>' => [
                ],
                // ...
            ],
            'score' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

RetrieveAndGenerate

$result = $client->retrieveAndGenerate([/* ... */]);
$promise = $client->retrieveAndGenerateAsync([/* ... */]);

Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.

Parameter Syntax

$result = $client->retrieveAndGenerate([
    'input' => [ // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
    'retrieveAndGenerateConfiguration' => [
        'externalSourcesConfiguration' => [
            'generationConfiguration' => [
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'guardrailConfiguration' => [
                    'guardrailId' => '<string>', // REQUIRED
                    'guardrailVersion' => '<string>', // REQUIRED
                ],
                'inferenceConfig' => [
                    'textInferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                ],
                'promptTemplate' => [
                    'textPromptTemplate' => '<string>',
                ],
            ],
            'modelArn' => '<string>', // REQUIRED
            'sources' => [ // REQUIRED
                [
                    'byteContent' => [
                        'contentType' => '<string>', // REQUIRED
                        'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                        'identifier' => '<string>', // REQUIRED
                    ],
                    's3Location' => [
                        'uri' => '<string>', // REQUIRED
                    ],
                    'sourceType' => 'S3|BYTE_CONTENT', // REQUIRED
                ],
                // ...
            ],
        ],
        'knowledgeBaseConfiguration' => [
            'generationConfiguration' => [
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'guardrailConfiguration' => [
                    'guardrailId' => '<string>', // REQUIRED
                    'guardrailVersion' => '<string>', // REQUIRED
                ],
                'inferenceConfig' => [
                    'textInferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                ],
                'promptTemplate' => [
                    'textPromptTemplate' => '<string>',
                ],
            ],
            'knowledgeBaseId' => '<string>', // REQUIRED
            'modelArn' => '<string>', // REQUIRED
            'orchestrationConfiguration' => [
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'inferenceConfig' => [
                    'textInferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                ],
                'promptTemplate' => [
                    'textPromptTemplate' => '<string>',
                ],
                'queryTransformationConfiguration' => [
                    'type' => 'QUERY_DECOMPOSITION', // REQUIRED
                ],
            ],
            'retrievalConfiguration' => [
                'vectorSearchConfiguration' => [ // REQUIRED
                    'filter' => [
                        'andAll' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'equals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'greaterThan' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'greaterThanOrEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'in' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'lessThan' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'lessThanOrEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'listContains' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'notEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'notIn' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'orAll' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'startsWith' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'stringContains' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                    ],
                    'implicitFilterConfiguration' => [
                        'metadataAttributes' => [ // REQUIRED
                            [
                                'description' => '<string>', // REQUIRED
                                'key' => '<string>', // REQUIRED
                                'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                            ],
                            // ...
                        ],
                        'modelArn' => '<string>', // REQUIRED
                    ],
                    'numberOfResults' => <integer>,
                    'overrideSearchType' => 'HYBRID|SEMANTIC',
                    'rerankingConfiguration' => [
                        'bedrockRerankingConfiguration' => [
                            'metadataConfiguration' => [
                                'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                                'selectiveModeConfiguration' => [
                                    'fieldsToExclude' => [
                                        [
                                            'fieldName' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'fieldsToInclude' => [
                                        [
                                            'fieldName' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            'modelConfiguration' => [ // REQUIRED
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'modelArn' => '<string>', // REQUIRED
                            ],
                            'numberOfRerankedResults' => <integer>,
                        ],
                        'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
                    ],
                ],
            ],
        ],
        'type' => 'KNOWLEDGE_BASE|EXTERNAL_SOURCES', // REQUIRED
    ],
    'sessionConfiguration' => [
        'kmsKeyArn' => '<string>', // REQUIRED
    ],
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'citations' => [
        [
            'generatedResponsePart' => [
                'textResponsePart' => [
                    'span' => [
                        'end' => <integer>,
                        'start' => <integer>,
                    ],
                    'text' => '<string>',
                ],
            ],
            'retrievedReferences' => [
                [
                    'content' => [
                        'byteContent' => '<string>',
                        'row' => [
                            [
                                'columnName' => '<string>',
                                'columnValue' => '<string>',
                                'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                            ],
                            // ...
                        ],
                        'text' => '<string>',
                        'type' => 'TEXT|IMAGE|ROW',
                    ],
                    'location' => [
                        'confluenceLocation' => [
                            'url' => '<string>',
                        ],
                        'customDocumentLocation' => [
                            'id' => '<string>',
                        ],
                        'kendraDocumentLocation' => [
                            'uri' => '<string>',
                        ],
                        's3Location' => [
                            'uri' => '<string>',
                        ],
                        'salesforceLocation' => [
                            'url' => '<string>',
                        ],
                        'sharePointLocation' => [
                            'url' => '<string>',
                        ],
                        'sqlLocation' => [
                            'query' => '<string>',
                        ],
                        'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                        'webLocation' => [
                            'url' => '<string>',
                        ],
                    ],
                    'metadata' => [
                        '<RetrievalResultMetadataKey>' => [
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'guardrailAction' => 'INTERVENED|NONE',
    'output' => [
        'text' => '<string>',
    ],
    'sessionId' => '<string>',
]

Result Details

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.

RetrieveAndGenerateStream

$result = $client->retrieveAndGenerateStream([/* ... */]);
$promise = $client->retrieveAndGenerateStreamAsync([/* ... */]);

Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.

Parameter Syntax

$result = $client->retrieveAndGenerateStream([
    'input' => [ // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
    'retrieveAndGenerateConfiguration' => [
        'externalSourcesConfiguration' => [
            'generationConfiguration' => [
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'guardrailConfiguration' => [
                    'guardrailId' => '<string>', // REQUIRED
                    'guardrailVersion' => '<string>', // REQUIRED
                ],
                'inferenceConfig' => [
                    'textInferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                ],
                'promptTemplate' => [
                    'textPromptTemplate' => '<string>',
                ],
            ],
            'modelArn' => '<string>', // REQUIRED
            'sources' => [ // REQUIRED
                [
                    'byteContent' => [
                        'contentType' => '<string>', // REQUIRED
                        'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                        'identifier' => '<string>', // REQUIRED
                    ],
                    's3Location' => [
                        'uri' => '<string>', // REQUIRED
                    ],
                    'sourceType' => 'S3|BYTE_CONTENT', // REQUIRED
                ],
                // ...
            ],
        ],
        'knowledgeBaseConfiguration' => [
            'generationConfiguration' => [
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'guardrailConfiguration' => [
                    'guardrailId' => '<string>', // REQUIRED
                    'guardrailVersion' => '<string>', // REQUIRED
                ],
                'inferenceConfig' => [
                    'textInferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                ],
                'promptTemplate' => [
                    'textPromptTemplate' => '<string>',
                ],
            ],
            'knowledgeBaseId' => '<string>', // REQUIRED
            'modelArn' => '<string>', // REQUIRED
            'orchestrationConfiguration' => [
                'additionalModelRequestFields' => [
                    '<AdditionalModelRequestFieldsKey>' => [
                    ],
                    // ...
                ],
                'inferenceConfig' => [
                    'textInferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                ],
                'promptTemplate' => [
                    'textPromptTemplate' => '<string>',
                ],
                'queryTransformationConfiguration' => [
                    'type' => 'QUERY_DECOMPOSITION', // REQUIRED
                ],
            ],
            'retrievalConfiguration' => [
                'vectorSearchConfiguration' => [ // REQUIRED
                    'filter' => [
                        'andAll' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'equals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'greaterThan' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'greaterThanOrEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'in' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'lessThan' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'lessThanOrEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'listContains' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'notEquals' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'notIn' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'orAll' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'startsWith' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                        'stringContains' => [
                            'key' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                            ],
                        ],
                    ],
                    'implicitFilterConfiguration' => [
                        'metadataAttributes' => [ // REQUIRED
                            [
                                'description' => '<string>', // REQUIRED
                                'key' => '<string>', // REQUIRED
                                'type' => 'STRING|NUMBER|BOOLEAN|STRING_LIST', // REQUIRED
                            ],
                            // ...
                        ],
                        'modelArn' => '<string>', // REQUIRED
                    ],
                    'numberOfResults' => <integer>,
                    'overrideSearchType' => 'HYBRID|SEMANTIC',
                    'rerankingConfiguration' => [
                        'bedrockRerankingConfiguration' => [
                            'metadataConfiguration' => [
                                'selectionMode' => 'SELECTIVE|ALL', // REQUIRED
                                'selectiveModeConfiguration' => [
                                    'fieldsToExclude' => [
                                        [
                                            'fieldName' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'fieldsToInclude' => [
                                        [
                                            'fieldName' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            'modelConfiguration' => [ // REQUIRED
                                'additionalModelRequestFields' => [
                                    '<AdditionalModelRequestFieldsKey>' => [
                                    ],
                                    // ...
                                ],
                                'modelArn' => '<string>', // REQUIRED
                            ],
                            'numberOfRerankedResults' => <integer>,
                        ],
                        'type' => 'BEDROCK_RERANKING_MODEL', // REQUIRED
                    ],
                ],
            ],
        ],
        'type' => 'KNOWLEDGE_BASE|EXTERNAL_SOURCES', // REQUIRED
    ],
    'sessionConfiguration' => [
        'kmsKeyArn' => '<string>', // REQUIRED
    ],
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'sessionId' => '<string>',
    'stream' => [ // EventParsingIterator
        'accessDeniedException' => [
            'message' => '<string>',
        ],
        'badGatewayException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'citation' => [
            'citation' => [
                'generatedResponsePart' => [
                    'textResponsePart' => [
                        'span' => [
                            'end' => <integer>,
                            'start' => <integer>,
                        ],
                        'text' => '<string>',
                    ],
                ],
                'retrievedReferences' => [
                    [
                        'content' => [
                            'byteContent' => '<string>',
                            'row' => [
                                [
                                    'columnName' => '<string>',
                                    'columnValue' => '<string>',
                                    'type' => 'BLOB|BOOLEAN|DOUBLE|NULL|LONG|STRING',
                                ],
                                // ...
                            ],
                            'text' => '<string>',
                            'type' => 'TEXT|IMAGE|ROW',
                        ],
                        'location' => [
                            'confluenceLocation' => [
                                'url' => '<string>',
                            ],
                            'customDocumentLocation' => [
                                'id' => '<string>',
                            ],
                            'kendraDocumentLocation' => [
                                'uri' => '<string>',
                            ],
                            's3Location' => [
                                'uri' => '<string>',
                            ],
                            'salesforceLocation' => [
                                'url' => '<string>',
                            ],
                            'sharePointLocation' => [
                                'url' => '<string>',
                            ],
                            'sqlLocation' => [
                                'query' => '<string>',
                            ],
                            'type' => 'S3|WEB|CONFLUENCE|SALESFORCE|SHAREPOINT|CUSTOM|KENDRA|SQL',
                            'webLocation' => [
                                'url' => '<string>',
                            ],
                        ],
                        'metadata' => [
                            '<RetrievalResultMetadataKey>' => [
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'conflictException' => [
            'message' => '<string>',
        ],
        'dependencyFailedException' => [
            'message' => '<string>',
            'resourceName' => '<string>',
        ],
        'guardrail' => [
            'action' => 'INTERVENED|NONE',
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'output' => [
            'text' => '<string>',
        ],
        'resourceNotFoundException' => [
            'message' => '<string>',
        ],
        'serviceQuotaExceededException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'validationException' => [
            'message' => '<string>',
        ],
    ],
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['stream'] as $event) {
    if (isset($event['accessDeniedException'])) {
        // Handle the 'accessDeniedException' event.
    } else if (isset($event['badGatewayException'])) {
        // Handle the 'badGatewayException' event.
    } else if (isset($event['citation'])) {
        // Handle the 'citation' event.
    } else if (isset($event['conflictException'])) {
        // Handle the 'conflictException' event.
    } else if (isset($event['dependencyFailedException'])) {
        // Handle the 'dependencyFailedException' event.
    } else if (isset($event['guardrail'])) {
        // Handle the 'guardrail' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['output'])) {
        // Handle the 'output' event.
    } else if (isset($event['resourceNotFoundException'])) {
        // Handle the 'resourceNotFoundException' event.
    } else if (isset($event['serviceQuotaExceededException'])) {
        // Handle the 'serviceQuotaExceededException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

ConflictException:

There was a conflict performing an operation. Resolve the conflict and retry your request.

ResourceNotFoundException:

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ValidationException:

Input validation failed. Check your request parameters and retry the request.

InternalServerException:

An internal server error occurred. Retry your request.

DependencyFailedException:

There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException:

There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException:

The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException:

The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException:

The number of requests exceeds the service quota. Resubmit your request later.