GenaiDocumentComparison

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.

Table 1. GenaiDocumentComparison class properties
Property Data type Description
GenaiContextDocument Object An object valued pointer to the first DocumentVersion object.
GenaiContextDocument2 Object An object valued pointer to the second DocumentVersion object.
GenaiAdditionalInstructions String An optional set of instructions that specify how to perform the comparison.
GenaiLLMModelName String An optional model name. If not provided, then the default model is used.
GenaiPromptTemplate String An optional document comparison prompt template. If not provided, then the default document comparison prompt template for the LLM will be used.
GenaiLLMMaxOutputTokens Integer An optional maximum number of output tokens. If not provided, then the default of XXX will be used.
GenaiLLMPrompt String This is property that is inherited from the parent class and is not used in GenaiDocumentComparison. Any value that you specify for the property is ignored.
GenaiLLMResponse String The output parameter that contains the generated comparison.
GenaiPromptTemplate String An optional parameter that specifies the prompt template for your query operation. If you set this parameter, the template that you pass overrides all the default prompt templates that are already configured in Content Platform Engine.