summaryrefslogtreecommitdiffstats
path: root/lib/public/LanguageModel/IHeadlineProvider.php
blob: 30185f4d4b3d97845f13c39547084e1558af902d (plain)
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
<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2022 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\LanguageModel;

use RuntimeException;

/**
 * This LanguageModel Provider represents headline generation
 * which generates a headline for the passed text
 * @since 27.1.0
 */
interface IHeadlineProvider extends ILanguageModelProvider {
	/**
	 * @param string $text The text to find headline for
	 * @returns string the headline
	 * @since 27.1.0
	 * @throws RuntimeException If the text could not be transcribed
	 */
	public function findHeadline(string $text): string;
}