dag-orchestrator / Exports / IPromptApiClientPort
Interface: IPromptApiClientPort
Port for communicating with a Prompt API Server over HTTP. Method signatures derived from OpenAPI spec operations.
NOT the same as IPromptBackendPort:
- IPromptBackendPort: used inside Prompt API Server to talk to backend runtime
- IPromptApiClientPort: used by Orchestrator to call Prompt API Server over HTTP
Implemented by
Table of contents
Methods
Methods
submitPrompt
▸ submitPrompt(request): Promise<TResult<IPromptResponse, IDagError>>
Parameters
| Name | Type |
|---|---|
request | IPromptRequest |
Returns
Promise<TResult<IPromptResponse, IDagError>>
Defined in
interfaces/prompt-api-client-port.ts:22
getQueue
▸ getQueue(): Promise<TResult<IQueueStatus, IDagError>>
Returns
Promise<TResult<IQueueStatus, IDagError>>
Defined in
interfaces/prompt-api-client-port.ts:23
manageQueue
▸ manageQueue(action): Promise<TResult<void, IDagError>>
Parameters
| Name | Type |
|---|---|
action | IQueueAction |
Returns
Promise<TResult<void, IDagError>>
Defined in
interfaces/prompt-api-client-port.ts:24
getHistory
▸ getHistory(promptId?): Promise<TResult<THistory, IDagError>>
Parameters
| Name | Type |
|---|---|
promptId? | string |
Returns
Promise<TResult<THistory, IDagError>>
Defined in
interfaces/prompt-api-client-port.ts:25
getObjectInfo
▸ getObjectInfo(nodeType?): Promise<TResult<TObjectInfo, IDagError>>
Parameters
| Name | Type |
|---|---|
nodeType? | string |
Returns
Promise<TResult<TObjectInfo, IDagError>>
Defined in
interfaces/prompt-api-client-port.ts:26
getSystemStats
▸ getSystemStats(): Promise<TResult<ISystemStats, IDagError>>
Returns
Promise<TResult<ISystemStats, IDagError>>