ITMSMCPCustomCloudImageAI Interface
Contract every image service implementation fulfils: it builds the provider-specific request for each supported operation and interprets the provider-specific response.
API unit family: TMS.MCP.CloudImageAI
Extends: IInterface
Syntax
ITMSMCPCustomCloudImageAI = interface(IInterface)
Remarks
One implementation exists per supported service, and the component creates the matching one when its service selection changes. Applications do not implement or call this interface directly; they work through the component, which translates its generate, remove-background and replace-background calls into the members below.
Methods
| Name | Description |
|---|---|
| BuildImageToImageRequest | Fills a request with the service call that transforms one supplied image according to a prompt. |
| BuildPollRequest | Fills a request with the follow-up call that asks the service for the state or the result of a pending job. |
| BuildRemoveBackgroundRequest | Fills a request with the service call that removes the background of the supplied image. |
| BuildReplaceBackgroundRequest | Fills a request with the service call that places the subject of one image onto the background of another. |
| BuildTextToImageRequest | Fills a request with the service call that creates an image from a prompt. |
| DestroyCloudImageAI | Detaches the implementation from the factory that created it so it can be released. |
| ExtractImageResult | Extracts the generated image from a successful response. |
| ExtractPollData | Reads the polling target out of a response, for services that answer a generate request with a job reference. |
| GetPollFrequency | Returns how long to wait between two poll requests. |
| IsRequestComplete | Reports whether a polled response indicates that the image is finished and can be read from the response. |
| IsRequestPending | Reports whether a polled response indicates that the request is still being processed. |
| NeedsPolling | Reports whether the service answers a request with a job reference that has to be polled instead of the finished image. |