inmydata package

Submodules

inmydata.CalendarAssistant module

class inmydata.CalendarAssistant.CalendarAssistant(tenant: str, calendar_name: str, server: str = 'inmydata.com', logging_level=20, log_file: str | None = None)

Bases: object

class DateDetails(year: int, month: int, week: int, quarter: int, yearseq: int, monthseq: int, weekseq: int, quarterseq: int, yearid: int, monthid: int, weekid: int, quarterid: int, date: date)

Bases: object

toJSON()
class GetCalendarDetailsRequest(UseDate, CalendarName)

Bases: object

toJSON()
class GetCalendarDetailsResponse(dateDetails)

Bases: object

toJSON()
get_financial_periods(input_date: date) FinancialPeriodDetails

Returns the financial period (year, month, week, quarter) for the given date.

get_financial_year(input_date: date) int

Returns the financial year (based on the anniversary of the custom start date).

get_month(input_date: date) int

Returns the pseudo-month (1–12) as 4-week periods in the financial year.

get_quarter(input_date: date) int

Returns the quarter (1–4) in the current financial year.

get_week_number(input_date: date) int

Week number (1–53) in the current financial year.

class inmydata.CalendarAssistant.FinancialPeriodDetails(year: int, month: int, week: int, quarter: int)

Bases: object

inmydata.ConversationalData module

class inmydata.ConversationalData.AIQuestionOutputTypeEnum(value)

Bases: Enum

An enumeration.

chart = 2
data = 1
text = 0
class inmydata.ConversationalData.AITypeEnum(value)

Bases: Enum

An enumeration.

azureopenai = 0
openai = 1
class inmydata.ConversationalData.Answer(answer: str)

Bases: object

answer: str
class inmydata.ConversationalData.ConversationalDataDriver(tenant: str, server: str = 'inmydata.com', logging_level=20, log_file: str | None = None)

Bases: object

class AIQuestionAPIRequest(Subject, Question, Date, Model, OutputType, AIType, SkipZeroQuestion, SkipGeneralQuestion, SummariseComments)

Bases: object

toJSON()
class AIQuestionAPIResponse(answer, answerDataJson)

Bases: object

toJSON()
class AIQuestionStatus(ConversationID, User, StatusMessage, StatusCommand, Sequence)

Bases: object

toJSON()
callbacks = None
async get_answer(question: str, subject: str | None = None) Answer
async get_answer_and_data_frame(question: str, subject: str | None = None) QuestionResponse | None
async get_data_frame(question: str, subject: str | None = None) DataFrame | None
on(event_name, callback)
class inmydata.ConversationalData.Model(value)

Bases: Enum

An enumeration.

gpt4 = 0
o3mini = 1
class inmydata.ConversationalData.QuestionResponse(answer: str, dataFrame: pandas.core.frame.DataFrame)

Bases: object

toJSON()

inmydata.StructuredData module

class inmydata.StructuredData.AIDataFilter(Field: str, ConditionOperator: ConditionOperator, LogicalOperator: LogicalOperator, Value, StartGroup: int, EndGroup: int, CaseInsensitive: bool)

Bases: object

to_dict()
class inmydata.StructuredData.AIDataSimpleFilter(Field: str, Value)

Bases: object

to_dict()
class inmydata.StructuredData.ConditionOperator(value)

Bases: Enum

An enumeration.

Contains = 10
Equals = 0
GreaterThan = 2
GreaterThanOrEqualTo = 4
LessThan = 3
LessThanOrEqualTo = 5
Like = 7
NotContains = 1
NotEquals = 1
NotLike = 9
NotStartsWith = 8
StartsWith = 6
class inmydata.StructuredData.LogicalOperator(value)

Bases: Enum

An enumeration.

And = 0
AndNot = 2
Or = 1
class inmydata.StructuredData.StructuredDataDriver(tenant: str, server: str = 'inmydata.com', logging_level=20, log_file: str | None = None)

Bases: object

class AIDataAPIRequest(Subject: str, Fields: list[str], Filters: list[AIDataFilter])

Bases: object

to_dict()
class AIDataAPIResponse(noRows, fileSize, csvDataString, columnNamesandTypes)

Bases: object

toJSON()
get_data(subject: str, fields: list[str], filters: list[AIDataFilter])
get_data_simple(subject: str, fields: list[str], simplefilters: list[AIDataSimpleFilter], caseSensitive: bool | None = True)

Module contents