QConnect / Client / send_message

send_message

QConnect.Client.send_message(**kwargs)

Submits a message to the Amazon Q in Connect session.

See also: AWS API Documentation

Request Syntax

response = client.send_message(
    assistantId='string',
    sessionId='string',
    type='TEXT',
    message={
        'value': {
            'text': {
                'value': 'string',
                'citations': [
                    {
                        'contentId': 'string',
                        'title': 'string',
                        'knowledgeBaseId': 'string',
                        'citationSpan': {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                        'sourceURL': 'string',
                        'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE'|'BEDROCK_KB_S3'|'BEDROCK_KB_WEB'|'BEDROCK_KB_CONFLUENCE'|'BEDROCK_KB_SALESFORCE'|'BEDROCK_KB_SHAREPOINT'|'BEDROCK_KB_KENDRA'|'BEDROCK_KB_CUSTOM_DOCUMENT'|'BEDROCK_KB_SQL'
                    },
                ],
                'aiGuardrailAssessment': {
                    'blocked': True|False
                }
            },
            'toolUseResult': {
                'toolUseId': 'string',
                'toolName': 'string',
                'toolResult': {...}|[...]|123|123.4|'string'|True|None,
                'inputSchema': {...}|[...]|123|123.4|'string'|True|None
            }
        }
    },
    aiAgentId='string',
    conversationContext={
        'selfServiceConversationHistory': [
            {
                'turnNumber': 123,
                'inputTranscript': 'string',
                'botResponse': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
        ]
    },
    configuration={
        'generateFillerMessage': True|False,
        'generateChunkedMessage': True|False
    },
    clientToken='string',
    orchestratorUseCase='string',
    metadata={
        'string': 'string'
    }
)
Parameters:

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect assistant.

  • sessionId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect session.

  • type (string) –

    [REQUIRED]

    The message type.

  • message (dict) –

    [REQUIRED]

    The message data to submit to the Amazon Q in Connect session.

    • value (dict) – [REQUIRED]

      The message input value.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUseResult.

      • text (dict) –

        The message data in text type.

        • value (string) –

          The value of the message data in text type.

        • citations (list) –

          The citations associated with the text message.

          • (dict) –

            A citation that references source content.

            • contentId (string) –

              The identifier of the content being cited.

            • title (string) –

              The title of the cited content.

            • knowledgeBaseId (string) –

              The identifier of the knowledge base containing the cited content.

            • citationSpan (dict) – [REQUIRED]

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

              • beginOffsetInclusive (integer) –

                Where the text with a citation starts in the generated output.

              • endOffsetExclusive (integer) –

                Where the text with a citation ends in the generated output.

            • sourceURL (string) –

              The source URL for the citation.

            • referenceType (string) – [REQUIRED]

              A type to define the KB origin of a cited content

        • aiGuardrailAssessment (dict) –

          The AI Guardrail assessment for the text message.

          • blocked (boolean) – [REQUIRED]

            Indicates whether the AI Guardrail blocked the content.

      • toolUseResult (dict) –

        The result of tool usage in the message.

        • toolUseId (string) – [REQUIRED]

          The identifier of the tool use instance.

        • toolName (string) – [REQUIRED]

          The name of the tool that was used.

        • toolResult (document) – [REQUIRED]

          The result of the tool usage.

        • inputSchema (document) –

          The input schema for the tool use result.

  • aiAgentId (string) – The identifier of the AI Agent to use for processing the message.

  • conversationContext (dict) –

    The conversation context before the Amazon Q in Connect session.

    • selfServiceConversationHistory (list) – [REQUIRED]

      The self service conversation history before the Amazon Q in Connect session.

      • (dict) –

        The conversation history data to included in conversation context data before the Amazon Q in Connect session.

        • turnNumber (integer) –

          The number of turn of the conversation history data.

        • inputTranscript (string) –

          The input transcript of the conversation history data.

        • botResponse (string) –

          The bot response of the conversation history data.

        • timestamp (datetime) –

          The timestamp of the conversation history entry.

  • configuration (dict) –

    The configuration of the SendMessage request.

    • generateFillerMessage (boolean) –

      Generates a filler response when tool selection is QUESTION.

    • generateChunkedMessage (boolean) –

      Configuration for generating chunked messages.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

  • orchestratorUseCase (string) – The orchestrator use case for message processing.

  • metadata (dict) –

    Additional metadata for the message.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'requestMessageId': 'string',
    'configuration': {
        'generateFillerMessage': True|False,
        'generateChunkedMessage': True|False
    },
    'nextMessageToken': 'string'
}

Response Structure

  • (dict) –

    • requestMessageId (string) –

      The identifier of the submitted message.

    • configuration (dict) –

      The configuration of the SendMessage request.

      • generateFillerMessage (boolean) –

        Generates a filler response when tool selection is QUESTION.

      • generateChunkedMessage (boolean) –

        Configuration for generating chunked messages.

    • nextMessageToken (string) –

      The token for the next message, used by GetNextMessage.

Exceptions