File size: 5,759 Bytes
f703ba6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | export type ImageRatio = '1:1' | '3:2' | '2:3' | '4:3' | '3:4' | '16:9' | '9:16' | '21:9' | '9:21'
export type ImageQuality = 'auto' | 'low' | 'medium' | 'high'
export type ImageOutputFormat = 'png' | 'jpeg' | 'webp'
export type ImageBackground = 'auto' | 'opaque'
export type ImageModeration = 'auto' | 'low'
export type ImageInputFidelity = 'low' | 'high'
export type ImageStatus = 'succeeded' | 'failed'
export type GenerationRunStatus = 'running' | ImageStatus
export type GenerationMode = 'text-to-image' | 'image-to-image'
export type ReferenceImage = {
id: string
name: string
mimeType: string
filePath: string | null
fileSizeBytes: number
createdAt: string
}
export type ReferenceImageImportFile = {
name: string
mimeType: string
data: ArrayBuffer
}
export type GenerateImageInput = {
conversationId: string
prompt: string
model: string
ratio: ImageRatio
size: string
quality: ImageQuality
n: number
outputFormat?: ImageOutputFormat
outputCompression?: number
background?: ImageBackground
moderation?: ImageModeration
stream?: boolean
partialImages?: number
inputFidelity?: ImageInputFidelity
referenceImageIds?: string[]
}
export type PromptAssistInput = {
prompt?: string
hasReferenceImages?: boolean
}
export type Conversation = {
id: string
title: string
draftPrompt: string
model: string
ratio: ImageRatio
size: string
quality: ImageQuality
n: number
outputFormat: ImageOutputFormat
outputCompression: number | null
background: ImageBackground
moderation: ImageModeration
stream: boolean
partialImages: number | null
inputFidelity: ImageInputFidelity | null
autoSaveHistory: boolean
keepFailureDetails: boolean
referenceImages: ReferenceImage[]
createdAt: string
updatedAt: string
}
export type ConversationUpdate = Partial<
Pick<
Conversation,
| 'title'
| 'draftPrompt'
| 'model'
| 'ratio'
| 'size'
| 'quality'
| 'n'
| 'outputFormat'
| 'outputCompression'
| 'background'
| 'moderation'
| 'stream'
| 'partialImages'
| 'inputFidelity'
| 'autoSaveHistory'
| 'keepFailureDetails'
>
>
export type ConversationCreateInput = Partial<
Pick<
Conversation,
| 'model'
| 'ratio'
| 'size'
| 'quality'
| 'n'
| 'outputFormat'
| 'outputCompression'
| 'background'
| 'moderation'
| 'stream'
| 'partialImages'
| 'inputFidelity'
| 'autoSaveHistory'
| 'keepFailureDetails'
>
>
export type ImageHistoryItem = {
id: string
conversationId: string | null
runId: string | null
prompt: string
model: string
ratio: ImageRatio
size: string | null
quality: ImageQuality
requestIndex: number | null
durationMs: number | null
filePath: string | null
fileSizeBytes: number | null
status: ImageStatus
errorMessage: string | null
errorDetails: string | null
favorite: boolean
generationMode: GenerationMode
referenceImages: ReferenceImage[]
createdAt: string
}
export type GenerationRun = {
id: string
conversationId: string
prompt: string
model: string
ratio: ImageRatio
size: string | null
quality: ImageQuality
n: number
status: GenerationRunStatus
durationMs: number | null
errorMessage: string | null
errorDetails: string | null
generationMode: GenerationMode
referenceImages: ReferenceImage[]
createdAt: string
items: ImageHistoryItem[]
}
export type ProviderSettings = {
baseURL: string
apiKeyStored: boolean
defaultModel: string
promptModel: string
insecureStorage: boolean
}
export type ProviderSettingsUpdate = {
baseURL?: string
apiKey?: string | null
defaultModel?: string
promptModel?: string
}
export type GenerateImageResult = {
run: GenerationRun
items: ImageHistoryItem[]
errorMessage?: string
errorDetails?: string
canceled?: boolean
}
export type BatchDownloadResult = {
directory: string
saved: number
skipped: number
}
export type HistoryListOptions = {
query?: string
sort?: 'newest' | 'oldest'
favoritesOnly?: boolean
}
export type PixAIAPI = {
settings: {
get: () => Promise<ProviderSettings>
update: (input: ProviderSettingsUpdate) => Promise<ProviderSettings>
}
conversation: {
list: () => Promise<Conversation[]>
create: (input?: ConversationCreateInput) => Promise<Conversation>
update: (id: string, input: ConversationUpdate) => Promise<Conversation>
delete: (id: string) => Promise<void>
runs: (id: string) => Promise<GenerationRun[]>
}
image: {
generate: (input: GenerateImageInput) => Promise<GenerateImageResult>
cancel: (runId: string, requestIndex?: number) => Promise<void>
url: (id: string) => string
copy: (id: string) => Promise<void>
download: (id: string) => Promise<string | null>
downloadMany: (ids: string[]) => Promise<BatchDownloadResult | null>
}
prompt: {
inspire: (input?: PromptAssistInput) => Promise<string>
enrich: (input: PromptAssistInput & { prompt: string }) => Promise<string>
}
reference: {
importFiles: (conversationId: string, files: ReferenceImageImportFile[]) => Promise<ReferenceImage[]>
addFromHistory: (conversationId: string, historyId: string) => Promise<ReferenceImage[]>
remove: (conversationId: string, referenceImageId: string) => Promise<ReferenceImage[]>
reorder: (conversationId: string, referenceImageIds: string[]) => Promise<ReferenceImage[]>
url: (id: string) => string
}
history: {
list: (options?: HistoryListOptions) => Promise<ImageHistoryItem[]>
delete: (id: string) => Promise<void>
favorite: (id: string, favorite: boolean) => Promise<ImageHistoryItem>
}
shell: {
openPath: (filePath: string) => Promise<string>
}
}
|