doc updates

Author: jcompagner

com.servoy.extensions.runtime.aiplugin/src/main/java/com/servoy/extensions/aiplugin/servoy-extension.xml

@@ -34,7 +34,8 @@ composing the final answer. This method exposes that value from the
 underlying langchain4j AI message.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the 'thinking' text produced by the AI message, if any.]]></summary></summaries></function><function clientSupport="ng,wc,sc" name="getTokenUsage"><argumentsTypes/><return type="dev.langchain4j.model.output.TokenUsage" typecode="dev.langchain4j.model.output.TokenUsage"><![CDATA[the token usage details reported by the underlying response, or null
         if not available]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns token usage information for this response. Token usage typically
 contains counts for prompt, completion and total tokens and can be useful for
-billing, monitoring or debugging token consumption.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns token usage information for this response.]]></summary></summaries></function></functions></object><object clientSupport="ng,wc,sc" publicName="EmbeddingMetaDataColumnAdder" qualifiedName="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><description><![CDATA[Builder like class to add a meta data column to a ServoyEmbeddingStoreBuilder.]]></description><functions><function clientSupport="ng,wc,sc" name="add"><argumentsTypes/><return type="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder" typecode="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder"><![CDATA[The ServoyEmbeddingStoreBuilder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Adds the meta data column to the ServoyEmbeddingStoreBuilder and returns it.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Adds the meta data column to the ServoyEmbeddingStoreBuilder and returns it.]]></summary></summaries></function><function clientSupport="ng,wc,sc" name="allowNull"><argumentsTypes><argumentType typecode="boolean"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the allow null option of the meta data column to add.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the allow null option of the meta data column to add.]]></summary></summaries><parameters><parameter name="allowNull" type="com.servoy.j2db.documentation.scripting.docs.Boolean" typecode="boolean"><description><![CDATA[meta data column allow null option (default false).]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="columnType"><argumentsTypes><argumentType typecode="int"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the column type of the meta data column to add.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the column type of the meta data column to add.]]></summary></summaries><parameters><parameter name="columnType" type="com.servoy.j2db.documentation.scripting.docs.Number" typecode="int"><description><![CDATA[meta data column type (default JSColumn.TEXT).]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="flag"><argumentsTypes><argumentType typecode="int"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets a flag for the meta data column to add, for example
+billing, monitoring or debugging token consumption.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns token usage information for this response.]]></summary></summaries></function></functions></object><object clientSupport="ng,wc,sc" publicName="EmbeddingMetaDataColumnAdder" qualifiedName="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><description><![CDATA[Builder like class to add a meta data column to a
+ServoyEmbeddingStoreBuilder.]]></description><functions><function clientSupport="ng,wc,sc" name="add"><argumentsTypes/><return type="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder" typecode="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder"><![CDATA[The ServoyEmbeddingStoreBuilder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Adds the meta data column to the ServoyEmbeddingStoreBuilder and returns it.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Adds the meta data column to the ServoyEmbeddingStoreBuilder and returns it.]]></summary></summaries></function><function clientSupport="ng,wc,sc" name="allowNull"><argumentsTypes><argumentType typecode="boolean"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the allow null option of the meta data column to add.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the allow null option of the meta data column to add.]]></summary></summaries><parameters><parameter name="allowNull" type="com.servoy.j2db.documentation.scripting.docs.Boolean" typecode="boolean"><description><![CDATA[meta data column allow null option (default false).]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="columnType"><argumentsTypes><argumentType typecode="int"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the column type of the meta data column to add.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the column type of the meta data column to add.]]></summary></summaries><parameters><parameter name="columnType" type="com.servoy.j2db.documentation.scripting.docs.Number" typecode="int"><description><![CDATA[meta data column type (default JSColumn.TEXT).]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="flag"><argumentsTypes><argumentType typecode="int"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets a flag for the meta data column to add, for example
 JSColumn.TENANT_COLUMN or JSColumn.UUID_COLUMN.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets a flag for the meta data column to add, for example
 JSColumn.]]></summary></summaries><parameters><parameter name="flag" type="com.servoy.j2db.documentation.scripting.docs.Number" typecode="int"><description><![CDATA[flag to set for the meta data column.]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="name"><argumentsTypes><argumentType typecode="java.lang.String"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingMetaDataColumnAdder"><![CDATA[This adder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the name of the meta data column to add.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the name of the meta data column to add.]]></summary></summaries><parameters><parameter name="name" type="com.servoy.j2db.documentation.scripting.docs.String" typecode="java.lang.String"><description><![CDATA[meta data column name.]]></description></parameter></parameters></function></functions></object><object clientSupport="ng,wc,sc" publicName="EmbeddingModel" qualifiedName="com.servoy.extensions.aiplugin.embedding.EmbeddingModel"><description><![CDATA[EmbeddingModel provides methods to generate embeddings for text and manage
 embedding stores. It supports in-memory and Servoy (pgvector) embedding
@@ -91,7 +92,7 @@ embedding models. Allows setting API key and model name for the OpenAI
 embedding model.]]></description><functions><function clientSupport="ng,wc,sc" name="apiKey"><argumentsTypes><argumentType typecode="java.lang.String"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.OpenAiEmbeddingModelBuilder" typecode="com.servoy.extensions.aiplugin.embedding.OpenAiEmbeddingModelBuilder"><![CDATA[This builder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the OpenAI API key for the embedding model.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the OpenAI API key for the embedding model.]]></summary></summaries><parameters><parameter name="key" type="com.servoy.j2db.documentation.scripting.docs.String" typecode="java.lang.String"><description><![CDATA[The API key.]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="build"><argumentsTypes/><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingModel" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingModel"><![CDATA[A configured EmbeddingClient instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Builds and returns an EmbeddingClient configured with the specified OpenAI
 embedding model settings.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Builds and returns an EmbeddingClient configured with the specified OpenAI
 embedding model settings.]]></summary></summaries></function><function clientSupport="ng,wc,sc" name="modelName"><argumentsTypes><argumentType typecode="java.lang.String"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.OpenAiEmbeddingModelBuilder" typecode="com.servoy.extensions.aiplugin.embedding.OpenAiEmbeddingModelBuilder"><![CDATA[This builder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the OpenAI model name for the embedding model.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the OpenAI model name for the embedding model.]]></summary></summaries><parameters><parameter name="modelName" type="com.servoy.j2db.documentation.scripting.docs.String" typecode="java.lang.String"><description><![CDATA[The model name.]]></description></parameter></parameters></function></functions></object><object clientSupport="ng,wc,sc" publicName="SearchResult" qualifiedName="com.servoy.extensions.aiplugin.embedding.SearchResult"><description><![CDATA[SearchResult represents a single result from an embedding similarity search.
-Contains the similarity score, matched text, and associated metadata.]]></description><functions><function clientSupport="ng,wc,sc" name="getMetadata"><argumentsTypes/><return type="com.servoy.j2db.documentation.scripting.docs.Object" typecode="com.servoy.j2db.scripting.JSMap"><![CDATA[The metadata object.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns the metadata associated with this result as a JS Object.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the metadata associated with this result as a JS Object.]]></summary></summaries></function><function clientSupport="ng,wc,sc" name="getScore"><argumentsTypes/><return type="com.servoy.j2db.documentation.scripting.docs.Number" typecode="java.lang.Double"><![CDATA[The similarity score.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns the similarity score for this result.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the similarity score for this result.]]></summary></summaries></function><function clientSupport="ng,wc,sc" name="getText"><argumentsTypes/><return type="com.servoy.j2db.documentation.scripting.docs.String" typecode="java.lang.String"><![CDATA[The matched text.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns the matched text for this result.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the matched text for this result.]]></summary></summaries></function></functions></object><object clientSupport="ng,wc,sc" publicName="ServoyEmbeddingStoreBuilder" qualifiedName="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder"><functions><function clientSupport="ng,wc,sc" name="addText"><argumentsTypes><argumentType typecode="boolean"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder" typecode="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder"><![CDATA[This builder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the addText option (store original text).]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the addText option (store original text).]]></summary></summaries><parameters><parameter name="addText" type="com.servoy.j2db.documentation.scripting.docs.Boolean" typecode="boolean"><description><![CDATA[addText option.]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="build"><argumentsTypes/><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingStore" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingStore"><![CDATA[An EmbeddingStore backed by a servoy store, or null if creation
+Contains the similarity score, matched text, and associated metadata.]]></description><properties><property clientSupport="ng,wc,sc" name="metadata"><return type="com.servoy.j2db.documentation.scripting.docs.Object" typecode="com.servoy.j2db.scripting.JSMap"><![CDATA[The metadata object.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns the metadata associated with this result as a JS Object.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the metadata associated with this result as a JS Object.]]></summary></summaries></property><property clientSupport="ng,wc,sc" name="score"><return type="com.servoy.j2db.documentation.scripting.docs.Number" typecode="java.lang.Double"><![CDATA[The similarity score.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns the similarity score for this result.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the similarity score for this result.]]></summary></summaries></property><property clientSupport="ng,wc,sc" name="text"><return type="com.servoy.j2db.documentation.scripting.docs.String" typecode="java.lang.String"><![CDATA[The matched text.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Returns the matched text for this result.]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Returns the matched text for this result.]]></summary></summaries></property></properties></object><object clientSupport="ng,wc,sc" publicName="ServoyEmbeddingStoreBuilder" qualifiedName="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder"><functions><function clientSupport="ng,wc,sc" name="addText"><argumentsTypes><argumentType typecode="boolean"/></argumentsTypes><return type="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder" typecode="com.servoy.extensions.aiplugin.embedding.ServoyEmbeddingStoreBuilder"><![CDATA[This builder instance.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Sets the addText option (store original text).]]></description></descriptions><summaries><summary clientSupport="ng,wc,sc"><![CDATA[Sets the addText option (store original text).]]></summary></summaries><parameters><parameter name="addText" type="com.servoy.j2db.documentation.scripting.docs.Boolean" typecode="boolean"><description><![CDATA[addText option.]]></description></parameter></parameters></function><function clientSupport="ng,wc,sc" name="build"><argumentsTypes/><return type="com.servoy.extensions.aiplugin.embedding.EmbeddingStore" typecode="com.servoy.extensions.aiplugin.embedding.EmbeddingStore"><![CDATA[An EmbeddingStore backed by a servoy store, or null if creation
         fails.]]></return><descriptions><description clientSupport="ng,wc,sc"><![CDATA[Creates a Servoy embedding store for the specified table name.
 <p>
 The meta data columns are based on the specified meta data columns.