API Reference
    Preparing search index...

    Type Alias BedrockAgentFunctionEvent

    Event structure for Bedrock Agent Function invocations.

    {
      "messageVersion": "1.0",
      "actionGroup": "exampleActionGroup",
      "function": "getWeather",
      "agent": {
        "name": "WeatherAgent",
        "id": "agent-id-123",
        "alias": "v1",
        "version": "1.0"
      },
      "parameters": [{
        "name": "location",
        "type": "string",
        "value": "Seattle"
      }],
      "inputText": "What's the weather like in Seattle?",
      "sessionId": "session-id-456",
      "sessionAttributes": {
        "userId": "user-789",
      },
      "promptSessionAttributes": {},
    }
    type BedrockAgentFunctionEvent = {
        actionGroup: string;
        agent: { alias: string; id: string; name: string; version: string };
        function: string;
        inputText: string;
        knowledgeBasesConfiguration?: Record<string, JSONValue>;
        messageVersion: string;
        parameters?: Parameter[];
        promptSessionAttributes: Record<string, JSONValue>;
        sessionAttributes: Record<string, JSONValue>;
        sessionId: string;
    }
    Index

    Properties

    actionGroup agent function inputText knowledgeBasesConfiguration? messageVersion parameters? promptSessionAttributes sessionAttributes sessionId

    Properties

    actionGroup: string
    agent: { alias: string; id: string; name: string; version: string }
    function: string
    inputText: string
    knowledgeBasesConfiguration?: Record<string, JSONValue>
    messageVersion: string
    parameters?: Parameter[]
    promptSessionAttributes: Record<string, JSONValue>
    sessionAttributes: Record<string, JSONValue>
    sessionId: string

    Settings

    Member Visibility

    On This Page

    Properties