Copied!

EmbeddingField

EmbeddingField.php : 13
Final
Extends FieldType

Base class for document field definitions.

Properties

public $boost

FieldType.php : 45

The importance of that field (boost factor).

 
public int $boost = 1

public $highlight

FieldType.php : 38

Whether highlighting should be performed for this field on result documents.

 
public bool $highlight = false

public $inResult

FieldType.php : 59

Whether the field should be a part of the resulting document.

 
public bool $inResult = true

public $multiValue

FieldType.php : 52

Whether the field supports multiple values.

 
public bool $multiValue = false

public $name

FieldType.php : 24

Name of the document field. Will be used to query this field.

 
public string $name

public $type read-only

FieldType.php 
public string $type

[deprecated] The type name of the facet, deprecated - use FieldType::getType instead.

Methods

public__construct()

ValueObject.php : 32

Construct object optionally with a set of properties.

 
public __construct([array<string, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they aren't writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string, mixed> [] -

publiccreate()

EmbeddingField.php : 23 
public static create(string $type) : self

Parameters

Name Type Default value Description
$type string -

Has to be handled by configured search engine (ibexa_dense_vector_ada002).

Return values

self

publicgetType()

FieldType.php : 61 
public getType() : string

Return values

string

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Attributes
#[Ignore]