GenAI query classes

The GenaiBaseQuery class enables an API caller to submit a question and generate a response from the watsonx LLM. The base class can be used directly but it does not allow the question to be augmented with document context. For more information, see GenaiBaseQuery class in the FNCM documentation.

The GenaiVectorQuery class inherits from the GenaiBaseQuery class. It enables an API caller to perform a vector query across the vector index for an entire object store. Before any of the document chunks are used for LLM inferencing, or returned to the caller, the Content Platform Engine server verifies whether the caller has VIEW_CONTENT permissions for the underlying documents. The set of documents that most closely match the input prompt are then returned. For more information, see GenaiVectorQuery class in the FNCM documentation.

The class inherits from the GenaiVectorQuery class. It enables an API caller to perform a vector query that is filtered to include chunks from a single document. The Content Platform Engine server verifies whether the call has VIEW_CONTENT access for the underlying document. The set of document chunks that most closely match the input prompt are then returned. For more information, see GenaiDocumentQuery class in the FNCM documentation.

The class inherits from the GenaiVectorQuery class. It enables an API caller to perform a vector query that is filtered to include chunks from a specified document list. The Content Platform Engine server verifies whether the call has VIEW_CONTENT access for the specified documents. The set of document chunks that most closely match the input prompt are then returned. For more information, see GenaiMultiDocumentQuery class in the FNCM documentation.

The GenaiAdhocSummary class inherits from the GenaiBaseQuery class. The class takes a list of documents as input and generates the watsonx summary for the documents by passing a subset of the document content to the LLM. The amount of text taken from each input document depends on the number of input documents and the LLM context window.

The GenaiDocumentComparison class inherits from the GenaiBaseQuery class. This class can be used to compare two document versions. These can be two versions of the same document, or document versions from two different documents. The caller must have VIEW_CONTENT access to both documents. The caller may specify additional instructions that specify how watsonx.ai should perform the comparison.