ai-1.0.x-dev/modules/ai_api_explorer/src/AiApiExplorerInterface.php

modules/ai_api_explorer/src/AiApiExplorerInterface.php
ai
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
<?php
 
declare(strict_types=1);
 
namespace Drupal\ai_api_explorer;
 
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\ai\AiProviderInterface;
use Drupal\ai\OperationType\GenericType\FileBaseInterface;
use Drupal\ai\Plugin\ProviderProxy;
 
/**
 * Interface for ai_api_explorer plugins.
 */
interface AiApiExplorerInterface {
 
  /**
   * Returns the translated plugin label.
   */
  public function label(): string;
 
  /**
   * Allow forms to carry out additional checks before they display.
   *
   * @return bool
   *   Whether the form is active and so can display to users.
   */
  public function isActive(): bool;
 
  /**
   * Helper to return a human-readable label for the form.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translatable label for the form.
   */
  public function getLabel(): TranslatableMarkup;
 
  /**
   * Helper to return a human-readable description for the form.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translatable description of the form.
   */
  public function getDescription(): TranslatableMarkup;
 
  /**
   * Helper to allow individual forms to provide advanced access restrictions.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The currently logged in user.
   *
   * @return bool
   *   TRUE to grant access, FALSE to deny.
   */
  public function hasAccess(AccountInterface $account): bool;
 
  /**
   * Returns the correct AJAX method from the AiApiExplorerForm.
   *
   * @return string
   *   The AJAX method name. MUST be a method on the form.
   */
  public function getAjaxResponseId(): string;
 
  /**
   * Builds the form to display to users.
   *
   * @param array $form
   *   The Drupal form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The FormState.
   *
   * @return array
   *   The form array.
   */
  public function buildForm(array $form, FormStateInterface $form_state): array;
 
  /**
   * Helper to get the response from the AI.
   *
   * @param array $form
   *   The Drupal form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The FormState.
   *
   * @return array
   *   The processed response.
   */
  public function getResponse(array &$form, FormStateInterface $form_state): array;
 
  /**
   * Helper to return a standard render template for the example code.
   *
   * @return array
   *   A Drupal render array template for a details element.
   */
  public function getCodeExampleTemplate(): array;
 
  /**
   * Helper to provide a structure for the AI Explorer Form.
   *
   * @param array $form
   *   The form array.
   * @param string $ajax_id
   *   The ID used in the AJAX response call.
   * @param string $layout
   *   Either 'two columns' (default), or any other value for three columns.
   *
   * @return array
   *   A form template that can be populated with the form elements.
   */
  public function getFormTemplate(array $form, string $ajax_id, string $layout = 'two_columns'): array;
 
  /**
   * Helper to describe the provider config as a string.
   *
   * @param \Drupal\ai\AiProviderInterface|\Drupal\ai\Plugin\ProviderProxy $provider
   *   The provider.
   *
   * @return string
   *   The string description of the config.
   */
  public function addProviderCodeExample(AiProviderInterface|ProviderProxy $provider):string;
 
  /**
   * Helper to generate a file from an AJAX form submit.
   *
   * @param string $type
   *   The type of file to generate.
   *
   * @return \Drupal\ai\OperationType\GenericType\AudioFile|\Drupal\ai\OperationType\GenericType\ImageFile|null
   *   The generated file or NULL on error.
   */
  public function generateFile(string $type = 'audio'): FileBaseInterface|null;
 
  /**
   * Helper in case the plugin needs to do anything on submit.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The Form State.
   */
  public function submitForm(array &$form, FormStateInterface $form_state): void;
 
}

Главная | Обратная связь

drupal hosting | друпал хостинг | it patrol .inc