search_api.processor.schema.yml 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. # Base definitions for processors
  2. search_api.default_processor_configuration:
  3. type: mapping
  4. label: 'Default processor configuration'
  5. mapping:
  6. weights:
  7. type: sequence
  8. label: 'The processor''s weights for the different processing stages'
  9. sequence:
  10. type: integer
  11. label: 'The processor''s weight for this stage'
  12. search_api.fields_processor_configuration:
  13. type: search_api.default_processor_configuration
  14. label: 'Fields processor configuration'
  15. mapping:
  16. all_fields:
  17. type: boolean
  18. label: 'Enabled for all supported fields'
  19. fields:
  20. type: sequence
  21. label: 'The selected fields'
  22. sequence:
  23. type: string
  24. label: 'Selected field'
  25. # Default for any processor without specific configuration
  26. plugin.plugin_configuration.search_api_processor.*:
  27. type: search_api.default_processor_configuration
  28. # Definitions for individual processors
  29. plugin.plugin_configuration.search_api_processor.hierarchy:
  30. type: search_api.default_processor_configuration
  31. label: 'Hierarchy processor configuration'
  32. mapping:
  33. fields:
  34. type: sequence
  35. label: 'Fields for which to add the hierarchy'
  36. sequence:
  37. type: string
  38. label: 'Field ID'
  39. plugin.plugin_configuration.search_api_processor.highlight:
  40. type: search_api.default_processor_configuration
  41. label: 'Highlight processor configuration'
  42. mapping:
  43. prefix:
  44. type: string
  45. label: 'Text/HTML that will be prepended to all occurrences of search keywords in highlighted text'
  46. suffix:
  47. type: string
  48. label: 'Text/HTML that will be appended to all occurrences of search keywords in highlighted text'
  49. excerpt:
  50. type: boolean
  51. label: 'When enabled, an excerpt will be created for searches with keywords, containing all occurrences of keywords in a fulltext field.'
  52. excerpt_length:
  53. type: integer
  54. label: 'The requested length of the excerpt, in characters'
  55. exclude_fields:
  56. type: sequence
  57. label: 'Fields excluded from excerpt'
  58. sequence:
  59. type: string
  60. label: 'An excluded field''s ID'
  61. highlight:
  62. type: string
  63. label: 'Defines whether returned fields should be highlighted (always/if returned/never).'
  64. highlight_partial:
  65. type: boolean
  66. label: 'Whether matches in parts of words should be highlighted'
  67. plugin.plugin_configuration.search_api_processor.html_filter:
  68. type: search_api.fields_processor_configuration
  69. label: 'HTML filter processor configuration'
  70. mapping:
  71. title:
  72. type: boolean
  73. label: 'Title'
  74. alt:
  75. type: boolean
  76. label: 'Alt'
  77. tags:
  78. type: sequence
  79. label: 'Tag boosts'
  80. sequence:
  81. type: integer
  82. label: Boost
  83. plugin.plugin_configuration.search_api_processor.ignorecase:
  84. type: search_api.fields_processor_configuration
  85. label: 'Ignore case processor configuration'
  86. plugin.plugin_configuration.search_api_processor.ignore_character:
  87. type: search_api.fields_processor_configuration
  88. label: 'Ignore Character processor configuration'
  89. mapping:
  90. ignorable:
  91. type: string
  92. label: 'Regular expression for characters it should ignore to stem'
  93. strip:
  94. type: mapping
  95. label: 'Configurable characters to ignore'
  96. mapping:
  97. character_sets:
  98. type: sequence
  99. label: 'Configuration of the character sets'
  100. sequence:
  101. type: ignore
  102. label: 'Character set'
  103. plugin.plugin_configuration.search_api_processor.stemmer:
  104. type: search_api.fields_processor_configuration
  105. label: 'Stemmer processor configuration'
  106. mapping:
  107. exceptions:
  108. type: sequence
  109. label: 'Stemming exceptions'
  110. sequence:
  111. type: string
  112. label: Exception
  113. plugin.plugin_configuration.search_api_processor.role_filter:
  114. type: search_api.default_processor_configuration
  115. label: 'Role filter processor configuration'
  116. mapping:
  117. default:
  118. type: boolean
  119. label: 'Default'
  120. roles:
  121. type: sequence
  122. label: 'The selected roles'
  123. sequence:
  124. type: string
  125. label: 'The role name'
  126. plugin.plugin_configuration.search_api_processor.stopwords:
  127. type: search_api.fields_processor_configuration
  128. label: 'Stopwords processor configuration'
  129. mapping:
  130. stopwords:
  131. type: sequence
  132. label: 'entered stopwords'
  133. sequence:
  134. type: string
  135. label: Stopword
  136. plugin.plugin_configuration.search_api_processor.tokenizer:
  137. type: search_api.fields_processor_configuration
  138. label: 'Tokenizer processor configuration'
  139. mapping:
  140. spaces:
  141. type: string
  142. label: 'Regular expression for spaces'
  143. ignorable:
  144. type: string
  145. label: 'Regular expression for ignorable characters'
  146. overlap_cjk:
  147. type: integer
  148. label: 'Defines if simple CJK handling should be enabled.'
  149. minimum_word_size:
  150. type: string
  151. label: 'Defines the minimum word size'
  152. plugin.plugin_configuration.search_api_processor.transliteration:
  153. type: search_api.fields_processor_configuration
  154. label: 'Transliteration processor configuration'
  155. plugin.plugin_configuration.search_api_processor.type_boost:
  156. type: search_api.default_processor_configuration
  157. label: 'Type-specific boosting processor configuration'
  158. mapping:
  159. boosts:
  160. type: sequence
  161. label: 'Boost settings'
  162. sequence:
  163. type: mapping
  164. label: 'Datasource boost settings'
  165. mapping:
  166. datasource_boost:
  167. type: float
  168. label: 'Base boost for the datasource'
  169. bundle_boosts:
  170. type: sequence
  171. label: 'Bundle-specific boosts'
  172. sequence:
  173. type: float
  174. label: 'The boost value for this bundle'
  175. # Definitions for property configuration
  176. search_api.property_configuration.*:
  177. type: mapping
  178. label: 'Default field configuration'
  179. mapping: {}
  180. search_api.property_configuration.aggregated_field:
  181. type: mapping
  182. label: 'Aggregated field configuration'
  183. mapping:
  184. type:
  185. type: string
  186. label: 'The type of the aggregation'
  187. fields:
  188. type: sequence
  189. label: 'The properties to be aggregated'
  190. sequence:
  191. type: string
  192. label: 'A property that should be part of the aggregation'
  193. search_api.property_configuration.rendered_item:
  194. type: mapping
  195. label: 'Rendered item processor configuration'
  196. mapping:
  197. roles:
  198. type: sequence
  199. label: 'The selected roles'
  200. sequence:
  201. type: string
  202. label: 'The user roles which will be active when the entity is rendered'
  203. view_mode:
  204. type: sequence
  205. label: 'The selected view modes for each datasource, by bundle'
  206. sequence:
  207. type: sequence
  208. label: 'The selected view modes for the datasource, by bundle'
  209. sequence:
  210. type: string
  211. label: 'The view mode used to render the entity for the specified bundle'