Class AIControllerApi

Hierarchy

BaseAPI
- AIControllerApi

Index

Constructors

Properties

Methods

generateStructuredContentFromEmail generateStructuredContentFromEmailRaw request validateStructuredOutputSchema validateStructuredOutputSchemaRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new AIControllerApi(configuration?: Configuration): AIControllerApi
Parameters
- configuration: Configuration = ...
Returns AIControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

generateStructuredContentFromEmail

generateStructuredContentFromEmail(requestParameters: GenerateStructuredContentFromEmailRequest, initOverrides?: RequestInit): Promise<StructuredContentResult>
Use output schemas to extract data from an email using AI Generate structured content for an email
Parameters
- requestParameters: GenerateStructuredContentFromEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<StructuredContentResult>

generateStructuredContentFromEmailRaw

generateStructuredContentFromEmailRaw(requestParameters: GenerateStructuredContentFromEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<StructuredContentResult>>
Use output schemas to extract data from an email using AI Generate structured content for an email
Parameters
- requestParameters: GenerateStructuredContentFromEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StructuredContentResult>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

validateStructuredOutputSchema

validateStructuredOutputSchema(requestParameters: ValidateStructuredOutputSchemaRequest, initOverrides?: RequestInit): Promise<StructuredOutputSchemaValidation>
Check if a schema is valid and can be used to extract data using AI Validate structured content schema
Parameters
- requestParameters: ValidateStructuredOutputSchemaRequest
- Optional initOverrides: RequestInit
Returns Promise<StructuredOutputSchemaValidation>

validateStructuredOutputSchemaRaw

validateStructuredOutputSchemaRaw(requestParameters: ValidateStructuredOutputSchemaRequest, initOverrides?: RequestInit): Promise<ApiResponse<StructuredOutputSchemaValidation>>
Check if a schema is valid and can be used to extract data using AI Validate structured content schema
Parameters
- requestParameters: ValidateStructuredOutputSchemaRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StructuredOutputSchemaValidation>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class AIControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns AIControllerApi

Properties

Protected configuration

Methods

generateStructuredContentFromEmail

Parameters

requestParameters: GenerateStructuredContentFromEmailRequest

Optional initOverrides: RequestInit

Returns Promise<StructuredContentResult>

generateStructuredContentFromEmailRaw

Parameters

requestParameters: GenerateStructuredContentFromEmailRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<StructuredContentResult>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

validateStructuredOutputSchema

Parameters

requestParameters: ValidateStructuredOutputSchemaRequest

Optional initOverrides: RequestInit

Returns Promise<StructuredOutputSchemaValidation>

validateStructuredOutputSchemaRaw

Parameters

requestParameters: ValidateStructuredOutputSchemaRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<StructuredOutputSchemaValidation>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

Returns T

Settings

Member Visibility

Theme

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]