GenAI Extensions
The GenAI Extensions define classes, properties, and other entities that are required by the IBM Content Assistant.
- Display name
- Gen AI Extensions
- Installation type
- Optional
- Predecessors
- None
- Required by
- None
Property templates
The following are the property templates that are added by the GenAI Extensions.
| Property template | Type | Description |
|---|---|---|
| GenaiDateIndexed | DateTime | The date on which a document was vector indexed. |
| GenaiWatsonxSummary | String | The document summary generated by IBM® Content Assistant. |
| GenaiSourceDocumentId | String | The unique identifier assigned to a source document. |
| GenaiSourceVersionSeriesId | String | The unique identifier that represents the version series of a source document. |
| GenaiHandlerClassName | String | The class name of the GenAI handler. |
| GenaiServiceUrl | String | The URL of the GenAI connector service. |
| GenaiAccessCode | String | The access code which can be used to register an object store with the GenAI connector service. |
| GenaiApiKey | String | The encrypted API key that is used to authorize access to the GenAI connector service for an object store. |
| GenaiProvider | String | The name of the watsonx.ai provider. |
| GenaiEmbeddingModelName | String | The name of the embedding model that the object store uses. |
| GenaiProviderURL | String | The URL of the watsonx.ai provider service. |
| GenaiSpace | String | The SpaceId of a space that is defined within an watsonx.ai service. |
| GenaiAdvancedOptions | String | The property contains JSON-formatted data that represents custom or advanced configuration settings for an object store in the GenAI connector system. |
| GenaiEmbeddingModelAPIKey | String | Obsolete. No longer used. |
| GenaiLLMAPIKey | String | The property value contains the encrypted watsonx.ai API key. |
| GenaiLLMDefaultModel | String | The default LLM model setting for the object store. |
| GenaiIndexingBatchItems | Integer | The property value specifies the maximum number of documents to send to the GenAI connector service in one vector indexing batch. |
| GenaiIndexingBatchCharacters | Integer | The property value specifies the maximum number of characters to send to the GenAI connector service in one vector indexing batch. |
| GenaiMaxSummaryWords | Integer | Specifies the maximum number of words to generate for a document summary. |
| GenaiIndexStatus | String | Specifies the status of the vector index associated with an object store. |
| GenaiLLMQueryPromptTemplate | String | The property defines the template text used to generate responses when querying a Large Language Model (LLM) like watsonx.ai through the GenAI connector. |
| GenaiLLMDocSummaryPromptTemplate | String | The property defines the template text used to generate a summary when querying a Large Language Model (LLM) like watsonx.ai through the GenAI connector. |
| GenaiLLMPrompt | String | The question that a client has asked when submitting a query to watsonx.ai. |
| GenaiLLMModelName | String | The LLM model that a client requests to use when submitting a query to watsonx.ai. |
| GenaiLLMResponse | String | The watsonx.ai response to a client query. |
| GenaiMaxDocumentChunks | Integer | The maximum number of document chunks that are sent to watsonx.ai for a client query request. |
| GenaiPerformLLMQuery | Boolean | The property that specifies whether to perform only a vector search or whether to perform a vector search and follow it with an LLM query. |
| GenaiVectorChunks | String | The property that contains the metadata and text of the document chunks that were found in response to a user query. |
| GenaiContextDocument | Object | The property specifies a single document that provides context for a query submitted to the GenAI connector. |
| GenaiContextDocuments | Array | The property specifies a list of document IDs that provide context for a query submitted to the GenAI connector service. |
| GenaiLLMMaxOutputTokens | Integer | The property specifies the maximum number of tokens that the watsonx.ai LLM is allowed to generate in response to a user query. |
| GenaiRelevancyFilterLevel | Floating point | The relevancy filter threshold level to use for vector queries. A Floating point number between 0.0 (allow any document) and 1.0 (highest threshold value that documents must meet to be used in the query). |
| GenaiProxyHost | String | The name of a proxy host between Content Engine server and the Genai connector service. |
| GenaiProxyPort | Integer | Port number for a proxy host between Content Engine server and the Genai connector service. |
| GenaiProxyTLSEnabled | Boolean | The property indicates whether or not a proxy host requires TLS connections. |
| GenaiSummaryPromptClass | String | A document class for which a per-class summary template should be used. |
| GenaiPromptTemplate | String | A custom summary template. |
Properties of Document Class
The following properties are added to the Document class by the GenAI Extensions.
| Property template | Type | Description |
|---|---|---|
| GenaiDateIndexed | DateTime | The date on which a document was vector indexed. |
| GenaiWatsonxSummary | String | The document summary generated by IBM Content Assistant. |
Objects
The following are the objects that are created by the GenAI Extensions:
| Object | Type | Description |
|---|---|---|
| Gen AI Index Status Choices | Choice List | Reflects the status of vector index for the object store. |
| Gen AI Configuration Change Preprocessor Action | CmAbstractPersistable | Configuration object used to control the attributes of the GenAI connector service. |
| Gen AI Query Change Preprocessor Action | CmChangePreprocessorAction |
Executes GenAI queries and saves the query results. |