Package org.ametys.plugins.ai.search

Class AIAdditionalDataIndexer

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.ai.search.AIAdditionalDataIndexer

All Implemented Interfaces:

AdditionalDataIndexer, DeferredServiceable, LogEnabled, AdditionalWebDataIndexer, Contextualizable

public class AIAdditionalDataIndexer
extends AbstractLogEnabled
implements AdditionalWebDataIndexer, DeferredServiceable, Contextualizable

Indexer for AI additional data.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA_CHUNK_CONTENT	The content attribute name for a chunk
static final String	DATA_CHUNK_CREATION_DATETIME	The creation datetime attribute name for a chunk
static final String	DATA_CHUNK_CREATOR	The identifier of the embedding used
static final String	DATA_CHUNK_EMBDEDING	The embedding attribute name for a chunk
static final String	SOLR_CONTENT_ID	The solr field name with the content id
static final String	SOLR_EMBEDDING	The solr field name for embedding vector
static final String	SOLR_TYPE	The solr type for chunk embedding

Fields inherited from interface org.ametys.cms.indexing.solr.AdditionalDataIndexer

TYPE_CONTENT, TYPE_RESOURCE, TYPE_TRASH_ELEMENT

Constructor Summary

Constructors

Constructor	Description
AIAdditionalDataIndexer()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
Collection<SchemaDefinition>	getSchemaDefinitions()	Get the schema definitions used by this indexer.
Collection<String>	getSupportedTypes()	Get the object/document types supported by this indexer.
Query	getUnindexAllQuery(String type)	The solr query that returns the documents to delete when unindexing all items of the given type
List<Query>	getUnindexObjectQuery(String ametysObjectId)	The list of Solr queries that returns the documents to delete when unindexing the given ametys object
Query	getUnindexSitemapQuery(String type, String siteName, String sitemapName)	The solr query that returns the documents to delete when unindexing all items of the given type in the given site
Query	getUnindexSiteQuery(String type, String sitename)	The solr query that returns the documents to delete when unindexing all items of the given type in the given site
List<org.apache.solr.common.SolrInputDocument>	indexAdditionalDocuments(AmetysObject object, org.apache.solr.common.SolrInputDocument document)	Index additional object properties in the corresponding document.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SOLR_TYPE

public static final String SOLR_TYPE

The solr type for chunk embedding

See Also:

• Constant Field Values

SOLR_EMBEDDING

public static final String SOLR_EMBEDDING

The solr field name for embedding vector

See Also:

• Constant Field Values

SOLR_CONTENT_ID

public static final String SOLR_CONTENT_ID

The solr field name with the content id

See Also:

• Constant Field Values

DATA_CHUNK_CONTENT

public static final String DATA_CHUNK_CONTENT

The content attribute name for a chunk

See Also:

• Constant Field Values

DATA_CHUNK_EMBDEDING

public static final String DATA_CHUNK_EMBDEDING

The embedding attribute name for a chunk

See Also:

• Constant Field Values

DATA_CHUNK_CREATION_DATETIME

public static final String DATA_CHUNK_CREATION_DATETIME

The creation datetime attribute name for a chunk

See Also:

• Constant Field Values

DATA_CHUNK_CREATOR

public static final String DATA_CHUNK_CREATOR

The identifier of the embedding used

See Also:

• Constant Field Values

Constructor Details

AIAdditionalDataIndexer

public AIAdditionalDataIndexer()

Method Details

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getSupportedTypes

public Collection<String> getSupportedTypes()

Description copied from interface: AdditionalDataIndexer

Get the object/document types supported by this indexer.

Specified by:

getSupportedTypes in interface AdditionalDataIndexer

Returns:

The object or document types supported by this indexer.

indexAdditionalDocuments

public List<org.apache.solr.common.SolrInputDocument> indexAdditionalDocuments(AmetysObject object,
 org.apache.solr.common.SolrInputDocument document)

Description copied from interface: AdditionalDataIndexer

Index additional object properties in the corresponding document.

Specified by:

indexAdditionalDocuments in interface AdditionalDataIndexer

Parameters:

object - The object to index.

document - The destination document.

Returns:

Additional documents to index (can be empty).

getUnindexObjectQuery

public List<Query> getUnindexObjectQuery(String ametysObjectId)
                                  throws Exception

Description copied from interface: AdditionalDataIndexer

The list of Solr queries that returns the documents to delete when unindexing the given ametys object

Specified by:

getUnindexObjectQuery in interface AdditionalDataIndexer

Parameters:

ametysObjectId - The id of the ametys object to unindex

Returns:

The list of Solr queries that returns the documents to delete

Throws:

Exception - If an error occurs while building the queries

getUnindexAllQuery

public Query getUnindexAllQuery(String type)
                         throws Exception

Description copied from interface: AdditionalDataIndexer

The solr query that returns the documents to delete when unindexing all items of the given type

Specified by:

getUnindexAllQuery in interface AdditionalDataIndexer

Parameters:

type - The type of the items to unindex

Returns:

The solr query that returns the documents to delete. Can be null

Throws:

Exception - If an error occurs while building the queries

getUnindexSiteQuery

public Query getUnindexSiteQuery(String type,
 String sitename)
                          throws Exception

Description copied from interface: AdditionalWebDataIndexer

The solr query that returns the documents to delete when unindexing all items of the given type in the given site

Specified by:

getUnindexSiteQuery in interface AdditionalWebDataIndexer

Parameters:

type - The type of the items to unindex

sitename - The site name of the items to unindex

Returns:

The solr query that returns the documents to delete. Can be null

Throws:

Exception - If an error occurs while building the queries

getUnindexSitemapQuery

public Query getUnindexSitemapQuery(String type,
 String siteName,
 String sitemapName)
                             throws Exception

Description copied from interface: AdditionalWebDataIndexer

The solr query that returns the documents to delete when unindexing all items of the given type in the given site

Specified by:

getUnindexSitemapQuery in interface AdditionalWebDataIndexer

Parameters:

type - The type of the items to unindex

siteName - The site name of the items to unindex

sitemapName - The sitemap name of the items to unindex

Returns:

The solr query that returns the documents to delete. Can be null

Throws:

Exception - If an error occurs while building the queries

getSchemaDefinitions

public Collection<SchemaDefinition> getSchemaDefinitions()

Description copied from interface: AdditionalDataIndexer

Get the schema definitions used by this indexer.

Specified by:

getSchemaDefinitions in interface AdditionalDataIndexer

Returns:

The schema definitions used by this indexer.