Class CreateAssistantCommand

Create a new AI assistant.

Example

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

import { Apiv2Client, CreateAssistantCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, CreateAssistantCommand } = require("@codegrade/apiv2-client"); // CommonJS import
const client = new Apiv2Client(config);
const input = { // CreateAssistantRequest
  systemPrompt: "STRING_VALUE", // required
  data: { // AssistantData Union: only one key present
    assignment: { // AssignmentAssistantData
      assignmentId: "STRING_VALUE", // required
    },
  },
  name: "STRING_VALUE", // required
  status: { // AssistantStatus Union: only one key present
    enabled: {},
    disabled: {},
  },
};
const command = new CreateAssistantCommand(input);
const response = await client.send(command);
// { // CreateAssistantResponse
//   assistant: { // Assistant
//     assistantId: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     systemPrompt: "STRING_VALUE", // required
//     status: { // AssistantStatus Union: only one key present
//       enabled: {},
//       disabled: {},
//     },
//     data: { // AssistantData Union: only one key present
//       assignment: { // AssignmentAssistantData
//         assignmentId: "STRING_VALUE", // required
//       },
//     },
//   },
// };

Param: CreateAssistantCommandInput

CreateAssistantCommandInput

Returns

CreateAssistantCommandOutput

See

CreateAssistantCommandInput for command's input shape.
CreateAssistantCommandOutput 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<
    CreateAssistantCommandInput,
    CreateAssistantCommandOutput,
    Apiv2ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- CreateAssistantCommand

Index

Constructors

constructor

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

Properties

`Readonly`input

input: CreateAssistantCommandInput

`Readonly`middlewareStack

middlewareStack: MiddlewareStack<
CreateAssistantCommandInput,
CreateAssistantCommandOutput,
>

`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: CreateAssistantRequest; output: CreateAssistantResponse };
    sdk: {
        input: CreateAssistantCommandInput;
        output: CreateAssistantCommandOutput;
    };
}

type navigation helper, not in runtime.

Methods

resolveMiddleware

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

resolveMiddlewareWithContext

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

`Static`getEndpointParameterInstructions

getEndpointParameterInstructions(): EndpointParameterInstructions
Returns EndpointParameterInstructions
Inherited from $Command.classBuilder<CreateAssistantCommandInput, CreateAssistantCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "CreateAssistant", { }) .n("Apiv2Client", "CreateAssistantCommand") .f(void 0, void 0) .ser(se_CreateAssistantCommand) .de(de_CreateAssistantCommand) .build().getEndpointParameterInstructions

Class CreateAssistantCommand

Example

Param: CreateAssistantCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CreateAssistantCommand

Parameters

Returns CreateAssistantCommand

Properties

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Methods

resolveMiddleware

Parameters

Returns Handler<CreateAssistantCommandInput, CreateAssistantCommandOutput>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, CreateAssistantCommandOutput>

`Static`getEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

Class CreateAssistantCommand

Example

Param: CreateAssistantCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CreateAssistantCommand

Parameters

Returns CreateAssistantCommand

Properties

Readonlyinput

ReadonlymiddlewareStack

Optional Readonlyschema

Protected Static Internal__types

Methods

resolveMiddleware

Parameters

Returns Handler<CreateAssistantCommandInput, CreateAssistantCommandOutput>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, CreateAssistantCommandOutput>

StaticgetEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

`Static`getEndpointParameterInstructions