Class CreateAssistantMessageCommand

Create a new message from the user to the assistant.

Example

Use a bare-bones client and the command you need to make an API call.

import { Apiv2Client, CreateAssistantMessageCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, CreateAssistantMessageCommand } = require("@codegrade/apiv2-client"); // CommonJS import
const client = new Apiv2Client(config);
const input = { // CreateAssistantMessageRequest
  assistantId: "STRING_VALUE", // required
  conversationId: "STRING_VALUE", // required
  content: { // AssistantMessageUserContent Union: only one key present
    text: "STRING_VALUE",
  },
};
const command = new CreateAssistantMessageCommand(input);
const response = await client.send(command);
// { // CreateAssistantMessageResponse
//   message: { // AssistantMessage
//     assistantId: "STRING_VALUE", // required
//     conversationId: "STRING_VALUE", // required
//     messageId: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     data: { // AssistantMessageData Union: only one key present
//       user: { // AssistantMessageUserData
//         content: { // AssistantMessageUserContent Union: only one key present
//           text: "STRING_VALUE",
//         },
//         author: { // User
//           id: "STRING_VALUE", // required
//           username: "STRING_VALUE", // required
//           name: "STRING_VALUE",
//           tenantId: "STRING_VALUE",
//           isTestStudent: true || false, // required
//         },
//       },
//       assistant: { // AssistantMessageAssistantData
//         content: { // AssistantMessageAssistantContent Union: only one key present
//           text: "STRING_VALUE",
//         },
//         stopReason: { // AssistantMessageStopReason Union: only one key present
//           endTurn: {},
//           maxTokens: { // AssistantMessageStopMaxTokens
//             maxTokens: Number("int"), // required
//           },
//         },
//       },
//     },
//   },
// };

Param: CreateAssistantMessageCommandInput

CreateAssistantMessageCommandInput

Returns

CreateAssistantMessageCommandOutput

See

CreateAssistantMessageCommandInput for command's input shape.
CreateAssistantMessageCommandOutput for command's response shape.
config for Apiv2Client's config shape.

Throws

InternalServerError (server fault) An internal failure at the fault of the server.

Throws

BadRequestError (client fault) An error at the fault of the client sending invalid input.

Throws

NotFoundError (client fault) An error due to the client attempting to access a missing resource.

Throws

NotAuthorizedError (client fault) An error due to the client not being authorized to access the resource.

Throws

NotAuthenticatedError (client fault) An error due to the client not being authenticated.

Throws

ValidationError (client fault) A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

Throws

Apiv2ServiceException

Base exception class for all service exceptions from Apiv2 service.

Hierarchy

CommandImpl<
    CreateAssistantMessageCommandInput,
    CreateAssistantMessageCommandOutput,
    Apiv2ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- CreateAssistantMessageCommand

Index

Constructors

constructor

new CreateAssistantMessageCommand(
input: CreateAssistantMessageCommandInput,
): CreateAssistantMessageCommand
Parameters
- input: CreateAssistantMessageCommandInput
Returns CreateAssistantMessageCommand
Inherited from $Command.classBuilder<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "CreateAssistantMessage", { }) .n("Apiv2Client", "CreateAssistantMessageCommand") .f(void 0, void 0) .ser(se_CreateAssistantMessageCommand) .de(de_CreateAssistantMessageCommand) .build().constructor
new CreateAssistantMessageCommand(
...__namedParameters: [CreateAssistantMessageCommandInput],
): CreateAssistantMessageCommand
Parameters
- ...__namedParameters: [CreateAssistantMessageCommandInput]
Returns CreateAssistantMessageCommand
Inherited from $Command.classBuilder<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "CreateAssistantMessage", { }) .n("Apiv2Client", "CreateAssistantMessageCommand") .f(void 0, void 0) .ser(se_CreateAssistantMessageCommand) .de(de_CreateAssistantMessageCommand) .build().constructor

Properties

`Readonly`input

input: CreateAssistantMessageCommandInput

`Readonly`middlewareStack

middlewareStack: MiddlewareStack<
CreateAssistantMessageCommandInput,
CreateAssistantMessageCommandOutput,
>

`Optional` `Readonly`schema

schema?: OperationSchema

This should be OperationSchema from @smithy/types, but would create problems with the client transform type adaptors.

`Protected` `Static` `Internal`__types

__types: {
    api: {
        input: CreateAssistantMessageRequest;
        output: CreateAssistantMessageResponse;
    };
    sdk: {
        input: CreateAssistantMessageCommandInput;
        output: CreateAssistantMessageCommandOutput;
    };
}

type navigation helper, not in runtime.

Methods

resolveMiddleware

resolveMiddleware(
    stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
    configuration: Apiv2ClientResolvedConfig,
    options: any,
): Handler<
    CreateAssistantMessageCommandInput,
    CreateAssistantMessageCommandOutput,
>
Parameters
- stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>
- configuration: Apiv2ClientResolvedConfig
- options: any
Returns Handler<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput>
Inherited from $Command.classBuilder<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "CreateAssistantMessage", { }) .n("Apiv2Client", "CreateAssistantMessageCommand") .f(void 0, void 0) .ser(se_CreateAssistantMessageCommand) .de(de_CreateAssistantMessageCommand) .build().resolveMiddleware

resolveMiddlewareWithContext

resolveMiddlewareWithContext(
    clientStack: MiddlewareStack<any, any>,
    configuration: {
        logger: Logger;
        requestHandler: RequestHandler<any, any, any>;
    },
    options: any,
    __namedParameters: ResolveMiddlewareContextArgs,
): InitializeHandler<any, CreateAssistantMessageCommandOutput>
Internal
Parameters
- clientStack: MiddlewareStack<any, any>
- configuration: { logger: Logger; requestHandler: RequestHandler<any, any, any> }
- options: any
- __namedParameters: ResolveMiddlewareContextArgs
Returns InitializeHandler<any, CreateAssistantMessageCommandOutput>
Inherited from $Command.classBuilder<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "CreateAssistantMessage", { }) .n("Apiv2Client", "CreateAssistantMessageCommand") .f(void 0, void 0) .ser(se_CreateAssistantMessageCommand) .de(de_CreateAssistantMessageCommand) .build().resolveMiddlewareWithContext

`Static`getEndpointParameterInstructions

getEndpointParameterInstructions(): EndpointParameterInstructions
Returns EndpointParameterInstructions
Inherited from $Command.classBuilder<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "CreateAssistantMessage", { }) .n("Apiv2Client", "CreateAssistantMessageCommand") .f(void 0, void 0) .ser(se_CreateAssistantMessageCommand) .de(de_CreateAssistantMessageCommand) .build().getEndpointParameterInstructions

Class CreateAssistantMessageCommand

Example

Param: CreateAssistantMessageCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CreateAssistantMessageCommand

Parameters

Returns CreateAssistantMessageCommand

Properties

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Methods

resolveMiddleware

Parameters

Returns Handler<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, CreateAssistantMessageCommandOutput>

`Static`getEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

Class CreateAssistantMessageCommand

Example

Param: CreateAssistantMessageCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CreateAssistantMessageCommand

Parameters

Returns CreateAssistantMessageCommand

Properties

Readonlyinput

ReadonlymiddlewareStack

Optional Readonlyschema

Protected Static Internal__types

Methods

resolveMiddleware

Parameters

Returns Handler<CreateAssistantMessageCommandInput, CreateAssistantMessageCommandOutput>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, CreateAssistantMessageCommandOutput>

StaticgetEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

`Static`getEndpointParameterInstructions