type
stringclasses
5 values
name
stringlengths
1
55
qualified_name
stringlengths
5
130
docstring
stringlengths
15
3.11k
filepath
stringclasses
90 values
is_public
bool
2 classes
is_private
bool
2 classes
line_start
int64
0
1.44k
line_end
int64
0
1.51k
annotation
stringclasses
2 values
returns
stringclasses
82 values
value
stringclasses
66 values
parameters
listlengths
0
10
bases
listlengths
0
2
parent_class
stringclasses
193 values
api_element_summary
stringlengths
199
3.43k
method
to_column_field
fenic.core._logical_plan.expressions.text.StrLengthExpr.to_column_field
null
null
true
false
861
867
null
ColumnField
null
[ "self", "plan" ]
null
StrLengthExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.text.StrLengthExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: StrLengthExpr
method
children
fenic.core._logical_plan.expressions.text.StrLengthExpr.children
null
null
true
false
869
870
null
List[LogicalExpr]
null
[ "self" ]
null
StrLengthExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.text.StrLengthExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: StrLengthExpr
class
ByteLengthExpr
fenic.core._logical_plan.expressions.text.ByteLengthExpr
Expression for calculating the length of a string column in bytes. This expression creates a new integer column with the number of bytes in each value of the input string column. Args: expr: The input string column expression Raises: TypeError: If the input expression is not a string column
null
true
false
873
901
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: ByteLengthExpr Qualified Name: fenic.core._logical_plan.expressions.text.ByteLengthExpr Docstring: Expression for calculating the length of a string column in bytes. This expression creates a new integer column with the number of bytes in each value of the input string column. Args: expr: The input string column expression Raises: TypeError: If the input expression is not a string column Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.text.ByteLengthExpr.__init__
null
null
true
false
886
887
null
null
null
[ "self", "expr" ]
null
ByteLengthExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.text.ByteLengthExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr"] Returns: none Parent Class: ByteLengthExpr
method
__str__
fenic.core._logical_plan.expressions.text.ByteLengthExpr.__str__
null
null
true
false
889
890
null
str
null
[ "self" ]
null
ByteLengthExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.text.ByteLengthExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: ByteLengthExpr
method
to_column_field
fenic.core._logical_plan.expressions.text.ByteLengthExpr.to_column_field
null
null
true
false
892
898
null
ColumnField
null
[ "self", "plan" ]
null
ByteLengthExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.text.ByteLengthExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: ByteLengthExpr
method
children
fenic.core._logical_plan.expressions.text.ByteLengthExpr.children
null
null
true
false
900
901
null
List[LogicalExpr]
null
[ "self" ]
null
ByteLengthExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.text.ByteLengthExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: ByteLengthExpr
module
case
fenic.core._logical_plan.expressions.case
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_logical_plan/expressions/case.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: case Qualified Name: fenic.core._logical_plan.expressions.case Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
WhenExpr
fenic.core._logical_plan.expressions.case.WhenExpr
null
null
true
false
12
35
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: WhenExpr Qualified Name: fenic.core._logical_plan.expressions.case.WhenExpr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.case.WhenExpr.__init__
null
null
true
false
13
16
null
null
null
[ "self", "expr", "condition", "value" ]
null
WhenExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.case.WhenExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr", "condition", "value"] Returns: none Parent Class: WhenExpr
method
__str__
fenic.core._logical_plan.expressions.case.WhenExpr.__str__
null
null
true
false
18
19
null
null
null
[ "self" ]
null
WhenExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.case.WhenExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: WhenExpr
method
to_column_field
fenic.core._logical_plan.expressions.case.WhenExpr.to_column_field
null
null
true
false
21
28
null
ColumnField
null
[ "self", "plan" ]
null
WhenExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.case.WhenExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: WhenExpr
method
children
fenic.core._logical_plan.expressions.case.WhenExpr.children
null
null
true
false
30
35
null
List[LogicalExpr]
null
[ "self" ]
null
WhenExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.case.WhenExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: WhenExpr
class
OtherwiseExpr
fenic.core._logical_plan.expressions.case.OtherwiseExpr
null
null
true
false
38
52
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: OtherwiseExpr Qualified Name: fenic.core._logical_plan.expressions.case.OtherwiseExpr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.case.OtherwiseExpr.__init__
null
null
true
false
39
43
null
null
null
[ "self", "expr", "value" ]
null
OtherwiseExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.case.OtherwiseExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr", "value"] Returns: none Parent Class: OtherwiseExpr
method
__str__
fenic.core._logical_plan.expressions.case.OtherwiseExpr.__str__
null
null
true
false
45
46
null
null
null
[ "self" ]
null
OtherwiseExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.case.OtherwiseExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: OtherwiseExpr
method
to_column_field
fenic.core._logical_plan.expressions.case.OtherwiseExpr.to_column_field
null
null
true
false
48
49
null
ColumnField
null
[ "self", "plan" ]
null
OtherwiseExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.case.OtherwiseExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: OtherwiseExpr
method
children
fenic.core._logical_plan.expressions.case.OtherwiseExpr.children
null
null
true
false
51
52
null
List[LogicalExpr]
null
[ "self" ]
null
OtherwiseExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.case.OtherwiseExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: OtherwiseExpr
module
json
fenic.core._logical_plan.expressions.json
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_logical_plan/expressions/json.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: json Qualified Name: fenic.core._logical_plan.expressions.json Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
JqExpr
fenic.core._logical_plan.expressions.json.JqExpr
null
null
true
false
21
43
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: JqExpr Qualified Name: fenic.core._logical_plan.expressions.json.JqExpr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.json.JqExpr.__init__
null
null
true
false
22
28
null
null
null
[ "self", "expr", "query" ]
null
JqExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.json.JqExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr", "query"] Returns: none Parent Class: JqExpr
method
__str__
fenic.core._logical_plan.expressions.json.JqExpr.__str__
null
null
true
false
30
31
null
str
null
[ "self" ]
null
JqExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.json.JqExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: JqExpr
method
_validate_types
fenic.core._logical_plan.expressions.json.JqExpr._validate_types
null
null
false
true
33
36
null
null
null
[ "self", "plan" ]
null
JqExpr
Type: method Member Name: _validate_types Qualified Name: fenic.core._logical_plan.expressions.json.JqExpr._validate_types Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "plan"] Returns: none Parent Class: JqExpr
method
to_column_field
fenic.core._logical_plan.expressions.json.JqExpr.to_column_field
null
null
true
false
38
40
null
ColumnField
null
[ "self", "plan" ]
null
JqExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.json.JqExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: JqExpr
method
children
fenic.core._logical_plan.expressions.json.JqExpr.children
null
null
true
false
42
43
null
List[LogicalExpr]
null
[ "self" ]
null
JqExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.json.JqExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: JqExpr
class
JsonTypeExpr
fenic.core._logical_plan.expressions.json.JsonTypeExpr
null
null
true
false
46
64
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: JsonTypeExpr Qualified Name: fenic.core._logical_plan.expressions.json.JsonTypeExpr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.json.JsonTypeExpr.__init__
null
null
true
false
47
49
null
null
null
[ "self", "expr" ]
null
JsonTypeExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.json.JsonTypeExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr"] Returns: none Parent Class: JsonTypeExpr
method
__str__
fenic.core._logical_plan.expressions.json.JsonTypeExpr.__str__
null
null
true
false
51
52
null
str
null
[ "self" ]
null
JsonTypeExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.json.JsonTypeExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: JsonTypeExpr
method
_validate_types
fenic.core._logical_plan.expressions.json.JsonTypeExpr._validate_types
null
null
false
true
54
57
null
null
null
[ "self", "plan" ]
null
JsonTypeExpr
Type: method Member Name: _validate_types Qualified Name: fenic.core._logical_plan.expressions.json.JsonTypeExpr._validate_types Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "plan"] Returns: none Parent Class: JsonTypeExpr
method
to_column_field
fenic.core._logical_plan.expressions.json.JsonTypeExpr.to_column_field
null
null
true
false
59
61
null
ColumnField
null
[ "self", "plan" ]
null
JsonTypeExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.json.JsonTypeExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: JsonTypeExpr
method
children
fenic.core._logical_plan.expressions.json.JsonTypeExpr.children
null
null
true
false
63
64
null
List[LogicalExpr]
null
[ "self" ]
null
JsonTypeExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.json.JsonTypeExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: JsonTypeExpr
class
JsonContainsExpr
fenic.core._logical_plan.expressions.json.JsonContainsExpr
null
null
true
false
67
97
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: JsonContainsExpr Qualified Name: fenic.core._logical_plan.expressions.json.JsonContainsExpr Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.json.JsonContainsExpr.__init__
null
null
true
false
68
82
null
null
null
[ "self", "expr", "value" ]
null
JsonContainsExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.json.JsonContainsExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expr", "value"] Returns: none Parent Class: JsonContainsExpr
method
__str__
fenic.core._logical_plan.expressions.json.JsonContainsExpr.__str__
null
null
true
false
84
85
null
str
null
[ "self" ]
null
JsonContainsExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.json.JsonContainsExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: JsonContainsExpr
method
_validate_types
fenic.core._logical_plan.expressions.json.JsonContainsExpr._validate_types
null
null
false
true
87
90
null
null
null
[ "self", "plan" ]
null
JsonContainsExpr
Type: method Member Name: _validate_types Qualified Name: fenic.core._logical_plan.expressions.json.JsonContainsExpr._validate_types Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "plan"] Returns: none Parent Class: JsonContainsExpr
method
to_column_field
fenic.core._logical_plan.expressions.json.JsonContainsExpr.to_column_field
null
null
true
false
92
94
null
ColumnField
null
[ "self", "plan" ]
null
JsonContainsExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.json.JsonContainsExpr.to_column_field Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: JsonContainsExpr
method
children
fenic.core._logical_plan.expressions.json.JsonContainsExpr.children
null
null
true
false
96
97
null
List[LogicalExpr]
null
[ "self" ]
null
JsonContainsExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.json.JsonContainsExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: JsonContainsExpr
module
base
fenic.core._logical_plan.expressions.base
Base classes for expression implementation.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_logical_plan/expressions/base.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: base Qualified Name: fenic.core._logical_plan.expressions.base Docstring: Base classes for expression implementation. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
Operator
fenic.core._logical_plan.expressions.base.Operator
Enumeration of supported operators for expressions.
null
true
false
15
29
null
null
null
null
[ "Enum" ]
null
Type: class Member Name: Operator Qualified Name: fenic.core._logical_plan.expressions.base.Operator Docstring: Enumeration of supported operators for expressions. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
LogicalExpr
fenic.core._logical_plan.expressions.base.LogicalExpr
Abstract base class for logical expressions.
null
true
false
32
48
null
null
null
null
[ "ABC" ]
null
Type: class Member Name: LogicalExpr Qualified Name: fenic.core._logical_plan.expressions.base.LogicalExpr Docstring: Abstract base class for logical expressions. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__str__
fenic.core._logical_plan.expressions.base.LogicalExpr.__str__
String representation of the expression.
null
true
false
35
38
null
null
null
[ "self" ]
null
LogicalExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.base.LogicalExpr.__str__ Docstring: String representation of the expression. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: LogicalExpr
method
to_column_field
fenic.core._logical_plan.expressions.base.LogicalExpr.to_column_field
Returns the schema field for the expression within the given plan.
null
true
false
40
43
null
ColumnField
null
[ "self", "plan" ]
null
LogicalExpr
Type: method Member Name: to_column_field Qualified Name: fenic.core._logical_plan.expressions.base.LogicalExpr.to_column_field Docstring: Returns the schema field for the expression within the given plan. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "plan"] Returns: ColumnField Parent Class: LogicalExpr
method
children
fenic.core._logical_plan.expressions.base.LogicalExpr.children
Returns the children of the expression. Returns an empty list if the expression has no children.
null
true
false
45
48
null
List[LogicalExpr]
null
[ "self" ]
null
LogicalExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.base.LogicalExpr.children Docstring: Returns the children of the expression. Returns an empty list if the expression has no children. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: LogicalExpr
class
BinaryExpr
fenic.core._logical_plan.expressions.base.BinaryExpr
Base class for binary expressions (comparison, boolean, arithmetic).
null
true
false
51
63
null
null
null
null
[ "LogicalExpr" ]
null
Type: class Member Name: BinaryExpr Qualified Name: fenic.core._logical_plan.expressions.base.BinaryExpr Docstring: Base class for binary expressions (comparison, boolean, arithmetic). Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._logical_plan.expressions.base.BinaryExpr.__init__
null
null
true
false
54
57
null
null
null
[ "self", "left", "right", "op" ]
null
BinaryExpr
Type: method Member Name: __init__ Qualified Name: fenic.core._logical_plan.expressions.base.BinaryExpr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "left", "right", "op"] Returns: none Parent Class: BinaryExpr
method
__str__
fenic.core._logical_plan.expressions.base.BinaryExpr.__str__
null
null
true
false
59
60
null
null
null
[ "self" ]
null
BinaryExpr
Type: method Member Name: __str__ Qualified Name: fenic.core._logical_plan.expressions.base.BinaryExpr.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: BinaryExpr
method
children
fenic.core._logical_plan.expressions.base.BinaryExpr.children
null
null
true
false
62
63
null
List[LogicalExpr]
null
[ "self" ]
null
BinaryExpr
Type: method Member Name: children Qualified Name: fenic.core._logical_plan.expressions.base.BinaryExpr.children Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: List[LogicalExpr] Parent Class: BinaryExpr
module
_inference
fenic._inference
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/__init__.py
false
true
null
null
null
null
null
null
null
null
Type: module Member Name: _inference Qualified Name: fenic._inference Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: none Returns: none Parent Class: none
module
language_model
fenic._inference.language_model
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/language_model.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: language_model Qualified Name: fenic._inference.language_model Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
InferenceConfiguration
fenic._inference.language_model.InferenceConfiguration
null
null
true
false
20
25
null
null
null
null
[]
null
Type: class Member Name: InferenceConfiguration Qualified Name: fenic._inference.language_model.InferenceConfiguration Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.language_model.InferenceConfiguration.__init__
null
null
true
false
0
0
null
None
null
[ "self", "max_output_tokens", "temperature", "top_logprobs", "response_format" ]
null
InferenceConfiguration
Type: method Member Name: __init__ Qualified Name: fenic._inference.language_model.InferenceConfiguration.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "max_output_tokens", "temperature", "top_logprobs", "response_format"] Returns: None Parent Class: InferenceConfiguration
class
LanguageModel
fenic._inference.language_model.LanguageModel
null
null
true
false
27
78
null
null
null
null
[]
null
Type: class Member Name: LanguageModel Qualified Name: fenic._inference.language_model.LanguageModel Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.language_model.LanguageModel.__init__
null
null
true
false
28
36
null
null
null
[ "self", "client" ]
null
LanguageModel
Type: method Member Name: __init__ Qualified Name: fenic._inference.language_model.LanguageModel.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "client"] Returns: none Parent Class: LanguageModel
method
get_completions
fenic._inference.language_model.LanguageModel.get_completions
null
null
true
false
38
68
null
list[Optional[FenicCompletionsResponse]]
null
[ "self", "messages", "max_tokens", "temperature", "response_format", "top_logprobs", "operation_name" ]
null
LanguageModel
Type: method Member Name: get_completions Qualified Name: fenic._inference.language_model.LanguageModel.get_completions Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "messages", "max_tokens", "temperature", "response_format", "top_logprobs", "operation_name"] Returns: list[Optional[FenicCompletionsResponse]] Parent Class: LanguageModel
method
count_tokens
fenic._inference.language_model.LanguageModel.count_tokens
null
null
true
false
70
71
null
int
null
[ "self", "messages" ]
null
LanguageModel
Type: method Member Name: count_tokens Qualified Name: fenic._inference.language_model.LanguageModel.count_tokens Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "messages"] Returns: int Parent Class: LanguageModel
method
reset_metrics
fenic._inference.language_model.LanguageModel.reset_metrics
null
null
true
false
74
75
null
null
null
[ "self" ]
null
LanguageModel
Type: method Member Name: reset_metrics Qualified Name: fenic._inference.language_model.LanguageModel.reset_metrics Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: LanguageModel
method
get_metrics
fenic._inference.language_model.LanguageModel.get_metrics
null
null
true
false
77
78
null
LMMetrics
null
[ "self" ]
null
LanguageModel
Type: method Member Name: get_metrics Qualified Name: fenic._inference.language_model.LanguageModel.get_metrics Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: LMMetrics Parent Class: LanguageModel
module
embedding_model
fenic._inference.embedding_model
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/embedding_model.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: embedding_model Qualified Name: fenic._inference.embedding_model Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
EmbeddingModel
fenic._inference.embedding_model.EmbeddingModel
null
null
true
false
8
23
null
null
null
null
[]
null
Type: class Member Name: EmbeddingModel Qualified Name: fenic._inference.embedding_model.EmbeddingModel Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.embedding_model.EmbeddingModel.__init__
null
null
true
false
9
13
null
null
null
[ "self", "client" ]
null
EmbeddingModel
Type: method Member Name: __init__ Qualified Name: fenic._inference.embedding_model.EmbeddingModel.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "client"] Returns: none Parent Class: EmbeddingModel
method
get_embeddings
fenic._inference.embedding_model.EmbeddingModel.get_embeddings
null
null
true
false
15
17
null
pa.ListArray
null
[ "self", "docs" ]
null
EmbeddingModel
Type: method Member Name: get_embeddings Qualified Name: fenic._inference.embedding_model.EmbeddingModel.get_embeddings Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "docs"] Returns: pa.ListArray Parent Class: EmbeddingModel
method
reset_metrics
fenic._inference.embedding_model.EmbeddingModel.reset_metrics
null
null
true
false
19
20
null
null
null
[ "self" ]
null
EmbeddingModel
Type: method Member Name: reset_metrics Qualified Name: fenic._inference.embedding_model.EmbeddingModel.reset_metrics Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: EmbeddingModel
method
get_metrics
fenic._inference.embedding_model.EmbeddingModel.get_metrics
null
null
true
false
22
23
null
RMMetrics
null
[ "self" ]
null
EmbeddingModel
Type: method Member Name: get_metrics Qualified Name: fenic._inference.embedding_model.EmbeddingModel.get_metrics Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: RMMetrics Parent Class: EmbeddingModel
module
token_counter
fenic._inference.token_counter
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/token_counter.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: token_counter Qualified Name: fenic._inference.token_counter Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
Tokenizable
fenic._inference.token_counter.Tokenizable
null
null
true
false
8
8
null
null
Union[list[dict[str, str]] | str | LMRequestMessages]
null
null
null
Type: attribute Member Name: Tokenizable Qualified Name: fenic._inference.token_counter.Tokenizable Docstring: none Value: Union[list[dict[str, str]] | str | LMRequestMessages] Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
TokenCounter
fenic._inference.token_counter.TokenCounter
null
null
true
false
10
11
null
null
null
null
[ "Protocol" ]
null
Type: class Member Name: TokenCounter Qualified Name: fenic._inference.token_counter.TokenCounter Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
count_tokens
fenic._inference.token_counter.TokenCounter.count_tokens
null
null
true
false
11
11
null
int
null
[ "self", "messages" ]
null
TokenCounter
Type: method Member Name: count_tokens Qualified Name: fenic._inference.token_counter.TokenCounter.count_tokens Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "messages"] Returns: int Parent Class: TokenCounter
class
TiktokenTokenCounter
fenic._inference.token_counter.TiktokenTokenCounter
null
null
true
false
13
43
null
null
null
null
[]
null
Type: class Member Name: TiktokenTokenCounter Qualified Name: fenic._inference.token_counter.TiktokenTokenCounter Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.token_counter.TiktokenTokenCounter.__init__
null
null
true
false
15
19
null
null
null
[ "self", "model_name", "fallback_encoding" ]
null
TiktokenTokenCounter
Type: method Member Name: __init__ Qualified Name: fenic._inference.token_counter.TiktokenTokenCounter.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "model_name", "fallback_encoding"] Returns: none Parent Class: TiktokenTokenCounter
method
count_tokens
fenic._inference.token_counter.TiktokenTokenCounter.count_tokens
null
null
true
false
21
27
null
int
null
[ "self", "messages" ]
null
TiktokenTokenCounter
Type: method Member Name: count_tokens Qualified Name: fenic._inference.token_counter.TiktokenTokenCounter.count_tokens Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "messages"] Returns: int Parent Class: TiktokenTokenCounter
method
_count_request_tokens
fenic._inference.token_counter.TiktokenTokenCounter._count_request_tokens
null
null
false
true
29
30
null
int
null
[ "self", "messages" ]
null
TiktokenTokenCounter
Type: method Member Name: _count_request_tokens Qualified Name: fenic._inference.token_counter.TiktokenTokenCounter._count_request_tokens Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "messages"] Returns: int Parent Class: TiktokenTokenCounter
method
_count_message_tokens
fenic._inference.token_counter.TiktokenTokenCounter._count_message_tokens
null
null
false
true
32
43
null
int
null
[ "self", "messages" ]
null
TiktokenTokenCounter
Type: method Member Name: _count_message_tokens Qualified Name: fenic._inference.token_counter.TiktokenTokenCounter._count_message_tokens Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "messages"] Returns: int Parent Class: TiktokenTokenCounter
module
model_client
fenic._inference.model_client
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_inference/model_client.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: model_client Qualified Name: fenic._inference.model_client Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
MILLISECOND_IN_SECONDS
fenic._inference.model_client.MILLISECOND_IN_SECONDS
null
null
true
false
31
31
null
null
0.001
null
null
null
Type: attribute Member Name: MILLISECOND_IN_SECONDS Qualified Name: fenic._inference.model_client.MILLISECOND_IN_SECONDS Docstring: none Value: 0.001 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
MINUTE_IN_SECONDS
fenic._inference.model_client.MINUTE_IN_SECONDS
null
null
true
false
32
32
null
null
60
null
null
null
Type: attribute Member Name: MINUTE_IN_SECONDS Qualified Name: fenic._inference.model_client.MINUTE_IN_SECONDS Docstring: none Value: 60 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
RequestT
fenic._inference.model_client.RequestT
null
null
true
false
35
35
null
null
TypeVar('RequestT')
null
null
null
Type: attribute Member Name: RequestT Qualified Name: fenic._inference.model_client.RequestT Docstring: none Value: TypeVar('RequestT') Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
ResponseT
fenic._inference.model_client.ResponseT
null
null
true
false
36
36
null
null
TypeVar('ResponseT')
null
null
null
Type: attribute Member Name: ResponseT Qualified Name: fenic._inference.model_client.ResponseT Docstring: none Value: TypeVar('ResponseT') Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
FenicCompletionsResponse
fenic._inference.model_client.FenicCompletionsResponse
null
null
true
false
39
42
null
null
null
null
[]
null
Type: class Member Name: FenicCompletionsResponse Qualified Name: fenic._inference.model_client.FenicCompletionsResponse Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.FenicCompletionsResponse.__init__
null
null
true
false
0
0
null
None
null
[ "self", "completion", "logprobs" ]
null
FenicCompletionsResponse
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.FenicCompletionsResponse.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "completion", "logprobs"] Returns: None Parent Class: FenicCompletionsResponse
class
FenicCompletionsRequest
fenic._inference.model_client.FenicCompletionsRequest
null
null
true
false
45
51
null
null
null
null
[]
null
Type: class Member Name: FenicCompletionsRequest Qualified Name: fenic._inference.model_client.FenicCompletionsRequest Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.FenicCompletionsRequest.__init__
null
null
true
false
0
0
null
None
null
[ "self", "messages", "max_completion_tokens", "top_logprobs", "structured_output", "temperature" ]
null
FenicCompletionsRequest
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.FenicCompletionsRequest.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "messages", "max_completion_tokens", "top_logprobs", "structured_output", "temperature"] Returns: None Parent Class: FenicCompletionsRequest
class
TokenEstimate
fenic._inference.model_client.TokenEstimate
null
null
true
false
54
70
null
null
null
null
[]
null
Type: class Member Name: TokenEstimate Qualified Name: fenic._inference.model_client.TokenEstimate Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__post_init__
fenic._inference.model_client.TokenEstimate.__post_init__
null
null
true
false
60
61
null
null
null
[ "self" ]
null
TokenEstimate
Type: method Member Name: __post_init__ Qualified Name: fenic._inference.model_client.TokenEstimate.__post_init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: TokenEstimate
method
__str__
fenic._inference.model_client.TokenEstimate.__str__
null
null
true
false
63
64
null
null
null
[ "self" ]
null
TokenEstimate
Type: method Member Name: __str__ Qualified Name: fenic._inference.model_client.TokenEstimate.__str__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: none Parent Class: TokenEstimate
method
__add__
fenic._inference.model_client.TokenEstimate.__add__
null
null
true
false
66
70
null
null
null
[ "self", "other" ]
null
TokenEstimate
Type: method Member Name: __add__ Qualified Name: fenic._inference.model_client.TokenEstimate.__add__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "other"] Returns: none Parent Class: TokenEstimate
method
__init__
fenic._inference.model_client.TokenEstimate.__init__
null
null
true
false
0
0
null
None
null
[ "self", "input_tokens", "output_tokens" ]
null
TokenEstimate
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.TokenEstimate.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "input_tokens", "output_tokens"] Returns: None Parent Class: TokenEstimate
attribute
logger
fenic._inference.model_client.logger
null
null
true
false
74
74
null
null
logging.getLogger(__name__)
null
null
null
Type: attribute Member Name: logger Qualified Name: fenic._inference.model_client.logger Docstring: none Value: logging.getLogger(__name__) Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
TransientException
fenic._inference.model_client.TransientException
Represents an exception that might be resolved with a retry.
null
true
false
78
82
null
null
null
null
[]
null
Type: class Member Name: TransientException Qualified Name: fenic._inference.model_client.TransientException Docstring: Represents an exception that might be resolved with a retry. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.TransientException.__init__
null
null
true
false
0
0
null
None
null
[ "self", "exception" ]
null
TransientException
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.TransientException.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "exception"] Returns: None Parent Class: TransientException
class
FatalException
fenic._inference.model_client.FatalException
Represents an exception that is unlikely to be resolved with retries.
null
true
false
85
89
null
null
null
null
[]
null
Type: class Member Name: FatalException Qualified Name: fenic._inference.model_client.FatalException Docstring: Represents an exception that is unlikely to be resolved with retries. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.FatalException.__init__
null
null
true
false
0
0
null
None
null
[ "self", "exception" ]
null
FatalException
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.FatalException.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "exception"] Returns: None Parent Class: FatalException
class
QueueItem
fenic._inference.model_client.QueueItem
Represents an item in the request queue.
null
true
false
92
99
null
null
null
null
[ "Generic[RequestT]" ]
null
Type: class Member Name: QueueItem Qualified Name: fenic._inference.model_client.QueueItem Docstring: Represents an item in the request queue. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.QueueItem.__init__
null
null
true
false
0
0
null
None
null
[ "self", "thread_id", "request", "future", "estimated_tokens" ]
null
QueueItem
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.QueueItem.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "thread_id", "request", "future", "estimated_tokens"] Returns: None Parent Class: QueueItem
class
RateLimitBucket
fenic._inference.model_client.RateLimitBucket
Manages a token bucket for rate limiting.
null
true
false
102
123
null
null
null
null
[]
null
Type: class Member Name: RateLimitBucket Qualified Name: fenic._inference.model_client.RateLimitBucket Docstring: Manages a token bucket for rate limiting. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.RateLimitBucket.__init__
null
null
true
false
104
107
null
null
null
[ "self", "max_capacity" ]
null
RateLimitBucket
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.RateLimitBucket.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "max_capacity"] Returns: none Parent Class: RateLimitBucket
method
_get_available_capacity
fenic._inference.model_client.RateLimitBucket._get_available_capacity
Calculates the available capacity based on the elapsed time and refill rate.
null
false
true
109
118
null
int
null
[ "self", "curr_time" ]
null
RateLimitBucket
Type: method Member Name: _get_available_capacity Qualified Name: fenic._inference.model_client.RateLimitBucket._get_available_capacity Docstring: Calculates the available capacity based on the elapsed time and refill rate. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "curr_time"] Returns: int Parent Class: RateLimitBucket
method
_set_capacity
fenic._inference.model_client.RateLimitBucket._set_capacity
Updates the current capacity and last update time.
null
false
true
120
123
null
null
null
[ "self", "capacity", "curr_time" ]
null
RateLimitBucket
Type: method Member Name: _set_capacity Qualified Name: fenic._inference.model_client.RateLimitBucket._set_capacity Docstring: Updates the current capacity and last update time. Value: none Annotation: none is Public? : false is Private? : true Parameters: ["self", "capacity", "curr_time"] Returns: none Parent Class: RateLimitBucket
class
RateLimitStrategy
fenic._inference.model_client.RateLimitStrategy
Base class for implementing rate limiting strategies for language model requests. This abstract class defines the interface for rate limiting strategies that control both request rate (RPM) and token usage rate (TPM) for language model API calls. Subclasses must implement specific token rate limiting strategies. Attributes: rpm: Requests per minute limit. Must be greater than 0. requests_bucket: Token bucket for tracking and limiting request rate.
null
true
false
126
174
null
null
null
null
[ "ABC" ]
null
Type: class Member Name: RateLimitStrategy Qualified Name: fenic._inference.model_client.RateLimitStrategy Docstring: Base class for implementing rate limiting strategies for language model requests. This abstract class defines the interface for rate limiting strategies that control both request rate (RPM) and token usage rate (TPM) for language model API calls. Subclasses must implement specific token rate limiting strategies. Attributes: rpm: Requests per minute limit. Must be greater than 0. requests_bucket: Token bucket for tracking and limiting request rate. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic._inference.model_client.RateLimitStrategy.__init__
null
null
true
false
137
141
null
null
null
[ "self", "rpm" ]
null
RateLimitStrategy
Type: method Member Name: __init__ Qualified Name: fenic._inference.model_client.RateLimitStrategy.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "rpm"] Returns: none Parent Class: RateLimitStrategy
method
backoff
fenic._inference.model_client.RateLimitStrategy.backoff
Backoff the request/token rate limit bucket.
null
true
false
143
146
null
int
null
[ "self", "curr_time" ]
null
RateLimitStrategy
Type: method Member Name: backoff Qualified Name: fenic._inference.model_client.RateLimitStrategy.backoff Docstring: Backoff the request/token rate limit bucket. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "curr_time"] Returns: int Parent Class: RateLimitStrategy