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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Marcel Klehr <mklehr@gmx.net>
*
* @author Marcel Klehr <mklehr@gmx.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\TextProcessing;
/**
* This is a text processing task
* @since 27.1.0
* @psalm-template T of ITaskType
* @psalm-template S as class-string<T>
* @psalm-template P as IProvider<T>
*/
final class Task implements \JsonSerializable {
protected ?int $id = null;
protected ?string $output = null;
/**
* @since 27.1.0
*/
public const TYPES = [
FreePromptTaskType::class,
SummaryTaskType::class,
HeadlineTaskType::class,
TopicsTaskType::class,
];
/**
* @since 27.1.0
*/
public const STATUS_FAILED = 4;
/**
* @since 27.1.0
*/
public const STATUS_SUCCESSFUL = 3;
/**
* @since 27.1.0
*/
public const STATUS_RUNNING = 2;
/**
* @since 27.1.0
*/
public const STATUS_SCHEDULED = 1;
/**
* @since 27.1.0
*/
public const STATUS_UNKNOWN = 0;
/**
* @psalm-var self::STATUS_*
*/
protected int $status = self::STATUS_UNKNOWN;
/**
* @psalm-param S $type
* @param string $type
* @param string $input
* @param string $appId
* @param string|null $userId
* @param string $identifier An arbitrary identifier for this task. max length: 255 chars
* @since 27.1.0
*/
final public function __construct(
protected string $type,
protected string $input,
protected string $appId,
protected ?string $userId,
protected string $identifier = '',
) {
}
/**
* @psalm-param P $provider
* @param IProvider $provider
* @return string
* @since 27.1.0
*/
public function visitProvider(IProvider $provider): string {
if ($this->canUseProvider($provider)) {
return $provider->process($this->getInput());
} else {
throw new \RuntimeException('Task of type ' . $this->getType() . ' cannot visit provider with task type ' . $provider->getTaskType());
}
}
/**
* @psalm-param P $provider
* @param IProvider $provider
* @return bool
* @since 27.1.0
*/
public function canUseProvider(IProvider $provider): bool {
return $provider->getTaskType() === $this->getType();
}
/**
* @psalm-return S
* @since 27.1.0
*/
final public function getType(): string {
return $this->type;
}
/**
* @return string|null
* @since 27.1.0
*/
final public function getOutput(): ?string {
return $this->output;
}
/**
* @param string|null $output
* @since 27.1.0
*/
final public function setOutput(?string $output): void {
$this->output = $output;
}
/**
* @psalm-return self::STATUS_*
* @since 27.1.0
*/
final public function getStatus(): int {
return $this->status;
}
/**
* @psalm-param self::STATUS_* $status
* @since 27.1.0
*/
final public function setStatus(int $status): void {
$this->status = $status;
}
/**
* @return int|null
* @since 27.1.0
*/
final public function getId(): ?int {
return $this->id;
}
/**
* @param int|null $id
* @since 27.1.0
*/
final public function setId(?int $id): void {
$this->id = $id;
}
/**
* @return string
* @since 27.1.0
*/
final public function getInput(): string {
return $this->input;
}
/**
* @return string
* @since 27.1.0
*/
final public function getAppId(): string {
return $this->appId;
}
/**
* @return string
* @since 27.1.0
*/
final public function getIdentifier(): string {
return $this->identifier;
}
/**
* @return string|null
* @since 27.1.0
*/
final public function getUserId(): ?string {
return $this->userId;
}
/**
* @psalm-return array{id: ?int, type: S, status: 0|1|2|3|4, userId: ?string, appId: string, input: string, output: ?string, identifier: string}
* @since 27.1.0
*/
public function jsonSerialize(): array {
return [
'id' => $this->getId(),
'type' => $this->getType(),
'status' => $this->getStatus(),
'userId' => $this->getUserId(),
'appId' => $this->getAppId(),
'input' => $this->getInput(),
'output' => $this->getOutput(),
'identifier' => $this->getIdentifier(),
];
}
}
|
