lg_agent.utilities.schemas.SPlanSchema Class Reference

Inheritance diagram for lg_agent.utilities.schemas.SPlanSchema:

Static Public Attributes
bool	requires_database = Field(default=False, description="Indicates if a more database queries are required to answer the question. The database contains information about the courses offered at the student's college, including course requirements, sections, and meet times. It also has information about the student, including their academic history and their interests.")
bool	requires_web_search = Field(default=False, description="Indicates if a web search is required to answer the question. If information is needed from both the database and the web, both fields should be set to true.")
bool	requires_insertion = Field(default=False, description="Indicates if the advisor needs to insert information into the database. This should be used if the student mentions interests of their's or course sections they are interested in.")
str	answer = Field(default="", description="The answer to the user's question, if it can be provided without additional information. Should be left blank if either of the first two fields are true. Keep responses clear and concise.")
str	info_needed_db = Field(default=None, description="If the advisor cannot answer the question directly, this field should specify what information from the database is needed to answer the question. If no info is needed leave this field blank.")
str	info_needed_web = Field(default=None, description="If the advisor cannot answer the question directly, this field should specify what information from the web is needed to answer the question. If no info is needed leave this field blank.")
str	info_to_insert = Field(default=None, description="If the advisor needs to insert information into the database, this field should specify what information needs to be inserted. If no insertion is needed, leave this field blank.")

Member Data Documentation

answer

str answer = Field(default="", description="The answer to the user's question, if it can be provided without additional information. Should be left blank if either of the first two fields are true. Keep responses clear and concise.")

static

info_needed_db

str info_needed_db = Field(default=None, description="If the advisor cannot answer the question directly, this field should specify what information from the database is needed to answer the question. If no info is needed leave this field blank.")

static

info_needed_web

str info_needed_web = Field(default=None, description="If the advisor cannot answer the question directly, this field should specify what information from the web is needed to answer the question. If no info is needed leave this field blank.")

static

info_to_insert

str lg_agent.utilities.schemas.SPlanSchema.info_to_insert = Field(default=None, description="If the advisor needs to insert information into the database, this field should specify what information needs to be inserted. If no insertion is needed, leave this field blank.")

static

requires_database

bool requires_database = Field(default=False, description="Indicates if a more database queries are required to answer the question. The database contains information about the courses offered at the student's college, including course requirements, sections, and meet times. It also has information about the student, including their academic history and their interests.")

static

requires_insertion

bool lg_agent.utilities.schemas.SPlanSchema.requires_insertion = Field(default=False, description="Indicates if the advisor needs to insert information into the database. This should be used if the student mentions interests of their's or course sections they are interested in.")

static

requires_web_search

bool requires_web_search = Field(default=False, description="Indicates if a web search is required to answer the question. If information is needed from both the database and the web, both fields should be set to true.")

static

---

The documentation for this class was generated from the following file:

• lg_agent/utilities/schemas.py