Package org.odpi.openmetadata.frameworks.integration.bitol.common

Class BitolContext

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.common.BitolContext
public class BitolContext extends Object
This class represents the AI and semantic context block of a data contract, schema object, data product or output port (ODCS v3.2.0 and ODPS v1.1.0, RFC 0038). It gives AI agents, LLMs and semantic layer tools instructions on how to use the element, verified questions and answers, and constraints on what must not be done. In ODCS the block may be written as a plain string, which is equivalent to supplying the instructions alone.

  • Constructor Details

    • BitolContext

      public BitolContext()
      Default constructor

  • Method Details

    • getInstructions

      public String getInstructions()
      Return natural language guidance for AI agents and tools on how to use the element.
      Returns:
      String

    • setInstructions

      public void setInstructions(String instructions)
      Set up natural language guidance for AI agents and tools on how to use the element.
      Parameters:
      instructions - String

    • getVerifiedStatements

      public List<BitolVerifiedStatement> getVerifiedStatements()
      Return the canonical questions and verified answers.
      Returns:
      List

    • setVerifiedStatements

      public void setVerifiedStatements(List<BitolVerifiedStatement> verifiedStatements)
      Set up the canonical questions and verified answers.
      Parameters:
      verifiedStatements - List

    • getConstraints

      public List<BitolContextConstraint> getConstraints()
      Return the things AI agents must not do with the element.
      Returns:
      List

    • setConstraints

      public void setConstraints(List<BitolContextConstraint> constraints)
      Set up the things AI agents must not do with the element.
      Parameters:
      constraints - List

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class Object
      Returns:
      int