type
stringclasses 5
values | name
stringlengths 1
55
| qualified_name
stringlengths 5
143
| docstring
stringlengths 0
3.59k
⌀ | filepath
stringclasses 180
values | is_public
bool 2
classes | is_private
bool 2
classes | line_start
float64 0
1.54k
⌀ | line_end
float64 0
1.56k
⌀ | annotation
stringclasses 8
values | returns
stringclasses 236
values | parameters
listlengths 0
74
⌀ | parent_class
stringclasses 298
values | value
stringclasses 112
values | bases
listlengths 0
3
⌀ | api_element_summary
stringlengths 199
23k
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
method
|
__str__
|
fenic.core.types.datatypes.ArrayType.__str__
|
Return a string representation of the array type.
Returns:
A string describing the array type and its element type.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 214 | 220 | null |
str
|
[
"self"
] |
ArrayType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.ArrayType.__str__
Docstring: Return a string representation of the array type.
Returns:
A string describing the array type and its element type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: ArrayType
|
method
|
__eq__
|
fenic.core.types.datatypes.ArrayType.__eq__
|
Compare this array type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an array type with the same element type,
False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 222 | 232 | null |
bool
|
[
"self",
"other"
] |
ArrayType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.ArrayType.__eq__
Docstring: Compare this array type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an array type with the same element type,
False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: ArrayType
|
class
|
StructField
|
fenic.core.types.datatypes.StructField
|
A field in a StructType. Fields are nullable.
Attributes:
name: The name of the field.
data_type: The data type of the field.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 235 | 269 | null | null | null | null | null |
[] |
Type: class
Member Name: StructField
Qualified Name: fenic.core.types.datatypes.StructField
Docstring: A field in a StructType. Fields are nullable.
Attributes:
name: The name of the field.
data_type: The data type of the field.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes.StructField.__str__
|
Return a string representation of the struct field.
Returns:
A string describing the field name and data type.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 247 | 253 | null |
str
|
[
"self"
] |
StructField
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.StructField.__str__
Docstring: Return a string representation of the struct field.
Returns:
A string describing the field name and data type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: StructField
|
method
|
__eq__
|
fenic.core.types.datatypes.StructField.__eq__
|
Compare this struct field with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a struct field with the same name and data type,
False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 255 | 269 | null |
bool
|
[
"self",
"other"
] |
StructField
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.StructField.__eq__
Docstring: Compare this struct field with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a struct field with the same name and data type,
False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: StructField
|
class
|
StructType
|
fenic.core.types.datatypes.StructType
|
A type representing a struct (record) with named fields.
Attributes:
fields: List of field definitions.
Example: Create a struct with name and age fields
```python
StructType([
StructField("name", StringType),
StructField("age", IntegerType),
])
```
|
site-packages/fenic/core/types/datatypes.py
| true | false | 272 | 310 | null | null | null | null | null |
[
"DataType"
] |
Type: class
Member Name: StructType
Qualified Name: fenic.core.types.datatypes.StructType
Docstring: A type representing a struct (record) with named fields.
Attributes:
fields: List of field definitions.
Example: Create a struct with name and age fields
```python
StructType([
StructField("name", StringType),
StructField("age", IntegerType),
])
```
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes.StructType.__str__
|
Return a string representation of the struct type.
Returns:
A string describing the struct type and its fields.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 290 | 296 | null |
str
|
[
"self"
] |
StructType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.StructType.__str__
Docstring: Return a string representation of the struct type.
Returns:
A string describing the struct type and its fields.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: StructType
|
method
|
__eq__
|
fenic.core.types.datatypes.StructType.__eq__
|
Compare this struct type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a struct type with the same fields,
False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 298 | 310 | null |
bool
|
[
"self",
"other"
] |
StructType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.StructType.__eq__
Docstring: Compare this struct type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a struct type with the same fields,
False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: StructType
|
class
|
EmbeddingType
|
fenic.core.types.datatypes.EmbeddingType
|
A type representing a fixed-length embedding vector.
Attributes:
dimensions: The number of dimensions in the embedding vector.
embedding_model: Name of the model used to generate the embedding.
Example: Create an embedding type for text-embedding-3-small
```python
EmbeddingType(384, embedding_model="text-embedding-3-small")
```
|
site-packages/fenic/core/types/datatypes.py
| true | false | 313 | 354 | null | null | null | null | null |
[
"_LogicalType"
] |
Type: class
Member Name: EmbeddingType
Qualified Name: fenic.core.types.datatypes.EmbeddingType
Docstring: A type representing a fixed-length embedding vector.
Attributes:
dimensions: The number of dimensions in the embedding vector.
embedding_model: Name of the model used to generate the embedding.
Example: Create an embedding type for text-embedding-3-small
```python
EmbeddingType(384, embedding_model="text-embedding-3-small")
```
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes.EmbeddingType.__str__
|
Return a string representation of the embedding type.
Returns:
A string describing the embedding type, its dimensions, and model.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 330 | 338 | null |
str
|
[
"self"
] |
EmbeddingType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.EmbeddingType.__str__
Docstring: Return a string representation of the embedding type.
Returns:
A string describing the embedding type, its dimensions, and model.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: EmbeddingType
|
method
|
__eq__
|
fenic.core.types.datatypes.EmbeddingType.__eq__
|
Compare this embedding type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an embedding type with the same dimensions
and model, False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 340 | 354 | null |
bool
|
[
"self",
"other"
] |
EmbeddingType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.EmbeddingType.__eq__
Docstring: Compare this embedding type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an embedding type with the same dimensions
and model, False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: EmbeddingType
|
class
|
_MarkdownType
|
fenic.core.types.datatypes._MarkdownType
|
Represents a markdown document.
|
site-packages/fenic/core/types/datatypes.py
| false | true | 360 | 381 | null | null | null | null | null |
[
"_LogicalType"
] |
Type: class
Member Name: _MarkdownType
Qualified Name: fenic.core.types.datatypes._MarkdownType
Docstring: Represents a markdown document.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes._MarkdownType.__str__
|
Return a string representation of the markdown type.
Returns:
The string "MarkdownType".
|
site-packages/fenic/core/types/datatypes.py
| true | false | 364 | 370 | null |
str
|
[
"self"
] |
_MarkdownType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._MarkdownType.__str__
Docstring: Return a string representation of the markdown type.
Returns:
The string "MarkdownType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _MarkdownType
|
method
|
__eq__
|
fenic.core.types.datatypes._MarkdownType.__eq__
|
Compare this markdown type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a markdown type, False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 372 | 381 | null |
bool
|
[
"self",
"other"
] |
_MarkdownType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._MarkdownType.__eq__
Docstring: Compare this markdown type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a markdown type, False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: _MarkdownType
|
class
|
_HtmlType
|
fenic.core.types.datatypes._HtmlType
|
Represents a valid HTML document.
|
site-packages/fenic/core/types/datatypes.py
| false | true | 384 | 405 | null | null | null | null | null |
[
"_LogicalType"
] |
Type: class
Member Name: _HtmlType
Qualified Name: fenic.core.types.datatypes._HtmlType
Docstring: Represents a valid HTML document.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes._HtmlType.__str__
|
Return a string representation of the HTML type.
Returns:
The string "HtmlType".
|
site-packages/fenic/core/types/datatypes.py
| true | false | 388 | 394 | null |
str
|
[
"self"
] |
_HtmlType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._HtmlType.__str__
Docstring: Return a string representation of the HTML type.
Returns:
The string "HtmlType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _HtmlType
|
method
|
__eq__
|
fenic.core.types.datatypes._HtmlType.__eq__
|
Compare this HTML type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an HTML type, False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 396 | 405 | null |
bool
|
[
"self",
"other"
] |
_HtmlType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._HtmlType.__eq__
Docstring: Compare this HTML type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an HTML type, False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: _HtmlType
|
class
|
_JsonType
|
fenic.core.types.datatypes._JsonType
|
Represents a valid JSON document.
|
site-packages/fenic/core/types/datatypes.py
| false | true | 408 | 429 | null | null | null | null | null |
[
"_LogicalType"
] |
Type: class
Member Name: _JsonType
Qualified Name: fenic.core.types.datatypes._JsonType
Docstring: Represents a valid JSON document.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes._JsonType.__str__
|
Return a string representation of the JSON type.
Returns:
The string "JsonType".
|
site-packages/fenic/core/types/datatypes.py
| true | false | 412 | 418 | null |
str
|
[
"self"
] |
_JsonType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._JsonType.__str__
Docstring: Return a string representation of the JSON type.
Returns:
The string "JsonType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _JsonType
|
method
|
__eq__
|
fenic.core.types.datatypes._JsonType.__eq__
|
Compare this JSON type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a JSON type, False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 420 | 429 | null |
bool
|
[
"self",
"other"
] |
_JsonType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._JsonType.__eq__
Docstring: Compare this JSON type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a JSON type, False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: _JsonType
|
class
|
TranscriptType
|
fenic.core.types.datatypes.TranscriptType
|
Represents a string containing a transcript in a specific format.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 432 | 456 | null | null | null | null | null |
[
"_LogicalType"
] |
Type: class
Member Name: TranscriptType
Qualified Name: fenic.core.types.datatypes.TranscriptType
Docstring: Represents a string containing a transcript in a specific format.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes.TranscriptType.__str__
|
Return a string representation of the transcript type.
Returns:
A string describing the transcript type and its format.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 438 | 444 | null |
str
|
[
"self"
] |
TranscriptType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.TranscriptType.__str__
Docstring: Return a string representation of the transcript type.
Returns:
A string describing the transcript type and its format.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: TranscriptType
|
method
|
__eq__
|
fenic.core.types.datatypes.TranscriptType.__eq__
|
Compare this transcript type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a transcript type with the same format,
False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 446 | 456 | null |
bool
|
[
"self",
"other"
] |
TranscriptType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.TranscriptType.__eq__
Docstring: Compare this transcript type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a transcript type with the same format,
False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: TranscriptType
|
class
|
DocumentPathType
|
fenic.core.types.datatypes.DocumentPathType
|
Represents a string containing a a document's local (file system) or remote (URL) path.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 459 | 483 | null | null | null | null | null |
[
"_LogicalType"
] |
Type: class
Member Name: DocumentPathType
Qualified Name: fenic.core.types.datatypes.DocumentPathType
Docstring: Represents a string containing a a document's local (file system) or remote (URL) path.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.datatypes.DocumentPathType.__str__
|
Return a string representation of the document path type.
Returns:
A string describing the document path type and its format.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 465 | 471 | null |
str
|
[
"self"
] |
DocumentPathType
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.DocumentPathType.__str__
Docstring: Return a string representation of the document path type.
Returns:
A string describing the document path type and its format.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: DocumentPathType
|
method
|
__eq__
|
fenic.core.types.datatypes.DocumentPathType.__eq__
|
Compare this document path type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a document path type with the same format,
False otherwise.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 473 | 483 | null |
bool
|
[
"self",
"other"
] |
DocumentPathType
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.DocumentPathType.__eq__
Docstring: Compare this document path type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a document path type with the same format,
False otherwise.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: DocumentPathType
|
function
|
_is_dtype_numeric
|
fenic.core.types.datatypes._is_dtype_numeric
|
Check if a data type is a numeric type.
|
site-packages/fenic/core/types/datatypes.py
| false | true | 486 | 488 | null |
bool
|
[
"dtype"
] | null | null | null |
Type: function
Member Name: _is_dtype_numeric
Qualified Name: fenic.core.types.datatypes._is_dtype_numeric
Docstring: Check if a data type is a numeric type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["dtype"]
Returns: bool
Parent Class: none
|
function
|
_is_logical_type
|
fenic.core.types.datatypes._is_logical_type
|
Check if a type is a logical type. If type is a struct or array that contains a LogicalType, it is logical type.
|
site-packages/fenic/core/types/datatypes.py
| false | true | 491 | 499 | null |
bool
|
[
"type"
] | null | null | null |
Type: function
Member Name: _is_logical_type
Qualified Name: fenic.core.types.datatypes._is_logical_type
Docstring: Check if a type is a logical type. If type is a struct or array that contains a LogicalType, it is logical type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["type"]
Returns: bool
Parent Class: none
|
attribute
|
StringType
|
fenic.core.types.datatypes.StringType
|
Represents a UTF-8 encoded string value.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 503 | 503 | null | null | null | null |
_StringType()
| null |
Type: attribute
Member Name: StringType
Qualified Name: fenic.core.types.datatypes.StringType
Docstring: Represents a UTF-8 encoded string value.
Value: _StringType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
IntegerType
|
fenic.core.types.datatypes.IntegerType
|
Represents a signed integer value.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 506 | 506 | null | null | null | null |
_IntegerType()
| null |
Type: attribute
Member Name: IntegerType
Qualified Name: fenic.core.types.datatypes.IntegerType
Docstring: Represents a signed integer value.
Value: _IntegerType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
FloatType
|
fenic.core.types.datatypes.FloatType
|
Represents a 32-bit floating-point number.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 509 | 509 | null | null | null | null |
_FloatType()
| null |
Type: attribute
Member Name: FloatType
Qualified Name: fenic.core.types.datatypes.FloatType
Docstring: Represents a 32-bit floating-point number.
Value: _FloatType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
DoubleType
|
fenic.core.types.datatypes.DoubleType
|
Represents a 64-bit floating-point number.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 512 | 512 | null | null | null | null |
_DoubleType()
| null |
Type: attribute
Member Name: DoubleType
Qualified Name: fenic.core.types.datatypes.DoubleType
Docstring: Represents a 64-bit floating-point number.
Value: _DoubleType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
BooleanType
|
fenic.core.types.datatypes.BooleanType
|
Represents a boolean value. (True/False)
|
site-packages/fenic/core/types/datatypes.py
| true | false | 515 | 515 | null | null | null | null |
_BooleanType()
| null |
Type: attribute
Member Name: BooleanType
Qualified Name: fenic.core.types.datatypes.BooleanType
Docstring: Represents a boolean value. (True/False)
Value: _BooleanType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
MarkdownType
|
fenic.core.types.datatypes.MarkdownType
|
Represents a string containing Markdown-formatted text.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 518 | 518 | null | null | null | null |
_MarkdownType()
| null |
Type: attribute
Member Name: MarkdownType
Qualified Name: fenic.core.types.datatypes.MarkdownType
Docstring: Represents a string containing Markdown-formatted text.
Value: _MarkdownType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
HtmlType
|
fenic.core.types.datatypes.HtmlType
|
Represents a string containing raw HTML markup.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 521 | 521 | null | null | null | null |
_HtmlType()
| null |
Type: attribute
Member Name: HtmlType
Qualified Name: fenic.core.types.datatypes.HtmlType
Docstring: Represents a string containing raw HTML markup.
Value: _HtmlType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
JsonType
|
fenic.core.types.datatypes.JsonType
|
Represents a string containing JSON data.
|
site-packages/fenic/core/types/datatypes.py
| true | false | 524 | 524 | null | null | null | null |
_JsonType()
| null |
Type: attribute
Member Name: JsonType
Qualified Name: fenic.core.types.datatypes.JsonType
Docstring: Represents a string containing JSON data.
Value: _JsonType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
module
|
semantic_examples
|
fenic.core.types.semantic_examples
|
Module for handling semantic examples in query processing.
This module provides classes and utilities for building, managing, and validating semantic examples
used in query processing.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: semantic_examples
Qualified Name: fenic.core.types.semantic_examples
Docstring: Module for handling semantic examples in query processing.
This module provides classes and utilities for building, managing, and validating semantic examples
used in query processing.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
ExampleType
|
fenic.core.types.semantic_examples.ExampleType
| null |
site-packages/fenic/core/types/semantic_examples.py
| true | false | 27 | 27 | null | null | null | null |
TypeVar('ExampleType')
| null |
Type: attribute
Member Name: ExampleType
Qualified Name: fenic.core.types.semantic_examples.ExampleType
Docstring: none
Value: TypeVar('ExampleType')
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
logger
|
fenic.core.types.semantic_examples.logger
| null |
site-packages/fenic/core/types/semantic_examples.py
| true | false | 29 | 29 | null | null | null | null |
logging.getLogger(__name__)
| null |
Type: attribute
Member Name: logger
Qualified Name: fenic.core.types.semantic_examples.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
MapExample
|
fenic.core.types.semantic_examples.MapExample
|
A single semantic example for semantic mapping operations.
Map examples demonstrate the transformation of input variables to a specific output
string or structured model used in a semantic.map operation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 31 | 58 | null | null | null | null | null |
[
"BaseModel"
] |
Type: class
Member Name: MapExample
Qualified Name: fenic.core.types.semantic_examples.MapExample
Docstring: A single semantic example for semantic mapping operations.
Map examples demonstrate the transformation of input variables to a specific output
string or structured model used in a semantic.map operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__eq__
|
fenic.core.types.semantic_examples.MapExample.__eq__
|
Compare MapExample instances, handling dictionary key order differences.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 41 | 58 | null |
bool
|
[
"self",
"other"
] |
MapExample
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.semantic_examples.MapExample.__eq__
Docstring: Compare MapExample instances, handling dictionary key order differences.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: MapExample
|
class
|
ClassifyExample
|
fenic.core.types.semantic_examples.ClassifyExample
|
A single semantic example for classification operations.
Classify examples demonstrate the classification of an input string into a specific category string,
used in a semantic.classify operation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 61 | 69 | null | null | null | null | null |
[
"BaseModel"
] |
Type: class
Member Name: ClassifyExample
Qualified Name: fenic.core.types.semantic_examples.ClassifyExample
Docstring: A single semantic example for classification operations.
Classify examples demonstrate the classification of an input string into a specific category string,
used in a semantic.classify operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
PredicateExample
|
fenic.core.types.semantic_examples.PredicateExample
|
A single semantic example for semantic predicate operations.
Predicate examples demonstrate the evaluation of input variables against a specific condition,
used in a semantic.predicate operation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 72 | 99 | null | null | null | null | null |
[
"BaseModel"
] |
Type: class
Member Name: PredicateExample
Qualified Name: fenic.core.types.semantic_examples.PredicateExample
Docstring: A single semantic example for semantic predicate operations.
Predicate examples demonstrate the evaluation of input variables against a specific condition,
used in a semantic.predicate operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__eq__
|
fenic.core.types.semantic_examples.PredicateExample.__eq__
|
Compare PredicateExample instances, handling dictionary key order differences.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 82 | 99 | null |
bool
|
[
"self",
"other"
] |
PredicateExample
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.semantic_examples.PredicateExample.__eq__
Docstring: Compare PredicateExample instances, handling dictionary key order differences.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: PredicateExample
|
class
|
JoinExample
|
fenic.core.types.semantic_examples.JoinExample
|
A single semantic example for semantic join operations.
Join examples demonstrate the evaluation of two input variables across different
datasets against a specific condition, used in a semantic.join operation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 102 | 111 | null | null | null | null | null |
[
"BaseModel"
] |
Type: class
Member Name: JoinExample
Qualified Name: fenic.core.types.semantic_examples.JoinExample
Docstring: A single semantic example for semantic join operations.
Join examples demonstrate the evaluation of two input variables across different
datasets against a specific condition, used in a semantic.join operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
BaseExampleCollection
|
fenic.core.types.semantic_examples.BaseExampleCollection
|
Abstract base class for all semantic example collections.
Semantic examples demonstrate the expected input-output relationship for a given task,
helping guide language models to produce consistent and accurate responses. Each example
consists of inputs and the corresponding expected output.
These examples are particularly valuable for:
- Demonstrating the expected reasoning pattern
- Showing correct output formats
- Handling edge cases through demonstration
- Improving model performance without changing the underlying model
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 113 | 245 | null | null | null | null | null |
[
"ABC",
"Generic[ExampleType]"
] |
Type: class
Member Name: BaseExampleCollection
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection
Docstring: Abstract base class for all semantic example collections.
Semantic examples demonstrate the expected input-output relationship for a given task,
helping guide language models to produce consistent and accurate responses. Each example
consists of inputs and the corresponding expected output.
These examples are particularly valuable for:
- Demonstrating the expected reasoning pattern
- Showing correct output formats
- Handling edge cases through demonstration
- Improving model performance without changing the underlying model
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core.types.semantic_examples.BaseExampleCollection.__init__
|
Initialize a collection of semantic examples.
Args:
examples: Optional list of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
Note:
The examples list is initialized as empty if no examples are provided.
Each example in the provided list will be processed through create_example()
to ensure proper formatting and validation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 130 | 146 | null | null |
[
"self",
"examples"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.__init__
Docstring: Initialize a collection of semantic examples.
Args:
examples: Optional list of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
Note:
The examples list is initialized as empty if no examples are provided.
Each example in the provided list will be processed through create_example()
to ensure proper formatting and validation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "examples"]
Returns: none
Parent Class: BaseExampleCollection
|
method
|
from_polars
|
fenic.core.types.semantic_examples.BaseExampleCollection.from_polars
|
Create a collection from a Polars DataFrame.
Args:
df: The Polars DataFrame containing example data. The specific
column structure requirements depend on the concrete collection type.
Returns:
A new example collection populated with examples from the DataFrame.
Raises:
InvalidExampleCollectionError: If the DataFrame's structure doesn't match
the expected format for this collection type.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 148 | 164 | null |
BaseExampleCollection
|
[
"cls",
"df"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.from_polars
Docstring: Create a collection from a Polars DataFrame.
Args:
df: The Polars DataFrame containing example data. The specific
column structure requirements depend on the concrete collection type.
Returns:
A new example collection populated with examples from the DataFrame.
Raises:
InvalidExampleCollectionError: If the DataFrame's structure doesn't match
the expected format for this collection type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: BaseExampleCollection
Parent Class: BaseExampleCollection
|
method
|
from_pandas
|
fenic.core.types.semantic_examples.BaseExampleCollection.from_pandas
|
Create a collection from a Pandas DataFrame.
Args:
df: The Pandas DataFrame containing example data. The specific
column structure requirements depend on the concrete collection type.
Returns:
A new example collection populated with examples from the DataFrame.
Raises:
InvalidExampleCollectionError: If the DataFrame's structure doesn't match
the expected format for this collection type.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 166 | 182 | null |
BaseExampleCollection
|
[
"cls",
"df"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: from_pandas
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.from_pandas
Docstring: Create a collection from a Pandas DataFrame.
Args:
df: The Pandas DataFrame containing example data. The specific
column structure requirements depend on the concrete collection type.
Returns:
A new example collection populated with examples from the DataFrame.
Raises:
InvalidExampleCollectionError: If the DataFrame's structure doesn't match
the expected format for this collection type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: BaseExampleCollection
Parent Class: BaseExampleCollection
|
method
|
_as_df_input
|
fenic.core.types.semantic_examples.BaseExampleCollection._as_df_input
|
Convert the collection to a list of dictionaries suitable for DataFrame creation.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 184 | 187 | null |
List[Dict[str, Any]]
|
[
"self"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection._as_df_input
Docstring: Convert the collection to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: BaseExampleCollection
|
method
|
to_polars
|
fenic.core.types.semantic_examples.BaseExampleCollection.to_polars
|
Convert the collection to a Polars DataFrame.
Returns:
A Polars DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 189 | 197 | null |
pl.DataFrame
|
[
"self"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: to_polars
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.to_polars
Docstring: Convert the collection to a Polars DataFrame.
Returns:
A Polars DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pl.DataFrame
Parent Class: BaseExampleCollection
|
method
|
to_pandas
|
fenic.core.types.semantic_examples.BaseExampleCollection.to_pandas
|
Convert the collection to a Pandas DataFrame.
Returns:
A Pandas DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 199 | 207 | null |
pd.DataFrame
|
[
"self"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: to_pandas
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.to_pandas
Docstring: Convert the collection to a Pandas DataFrame.
Returns:
A Pandas DataFrame representing the collection's examples.
Returns an empty DataFrame if the collection contains no examples.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pd.DataFrame
Parent Class: BaseExampleCollection
|
method
|
create_example
|
fenic.core.types.semantic_examples.BaseExampleCollection.create_example
|
Create an example in the collection.
Args:
example: The semantic example to add. Must be an instance of the
collection's example_class.
Returns:
Self for method chaining.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 209 | 224 | null |
BaseExampleCollection
|
[
"self",
"example"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: create_example
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.create_example
Docstring: Create an example in the collection.
Args:
example: The semantic example to add. Must be an instance of the
collection's example_class.
Returns:
Self for method chaining.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "example"]
Returns: BaseExampleCollection
Parent Class: BaseExampleCollection
|
method
|
__eq__
|
fenic.core.types.semantic_examples.BaseExampleCollection.__eq__
|
Check if two example collections are equal.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 226 | 245 | null |
bool
|
[
"self",
"other"
] |
BaseExampleCollection
| null | null |
Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.semantic_examples.BaseExampleCollection.__eq__
Docstring: Check if two example collections are equal.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: BaseExampleCollection
|
class
|
MapExampleCollection
|
fenic.core.types.semantic_examples.MapExampleCollection
|
Collection of input-output examples for semantic map operations.
Stores examples that demonstrate how input data should be transformed into
output text or structured data. Each example shows the expected output for
a given set of input fields.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 247 | 376 | null | null | null | null | null |
[
"BaseExampleCollection[MapExample]"
] |
Type: class
Member Name: MapExampleCollection
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection
Docstring: Collection of input-output examples for semantic map operations.
Stores examples that demonstrate how input data should be transformed into
output text or structured data. Each example shows the expected output for
a given set of input fields.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core.types.semantic_examples.MapExampleCollection.__init__
|
Initialize a collection of semantic map examples.
Args:
examples: List of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 258 | 267 | null | null |
[
"self",
"examples"
] |
MapExampleCollection
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection.__init__
Docstring: Initialize a collection of semantic map examples.
Args:
examples: List of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "examples"]
Returns: none
Parent Class: MapExampleCollection
|
method
|
create_example
|
fenic.core.types.semantic_examples.MapExampleCollection.create_example
|
Create an example in the collection with output and input type validation.
Ensures all examples in the collection have consistent output types
(either all strings or all BaseModel instances) and validates that input
fields have consistent types across examples.
For input validation:
- The first example establishes the schema and cannot have None values
- Subsequent examples must have the same fields but can have None values
- Non-None values must match the established type for each field
Args:
example: The MapExample to add.
Returns:
Self for method chaining.
Raises:
InvalidExampleCollectionError: If the example output type doesn't match
the existing examples in the collection, if the first example contains
None values, or if subsequent examples have type mismatches.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 269 | 305 | null |
MapExampleCollection
|
[
"self",
"example"
] |
MapExampleCollection
| null | null |
Type: method
Member Name: create_example
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection.create_example
Docstring: Create an example in the collection with output and input type validation.
Ensures all examples in the collection have consistent output types
(either all strings or all BaseModel instances) and validates that input
fields have consistent types across examples.
For input validation:
- The first example establishes the schema and cannot have None values
- Subsequent examples must have the same fields but can have None values
- Non-None values must match the established type for each field
Args:
example: The MapExample to add.
Returns:
Self for method chaining.
Raises:
InvalidExampleCollectionError: If the example output type doesn't match
the existing examples in the collection, if the first example contains
None values, or if subsequent examples have type mismatches.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "example"]
Returns: MapExampleCollection
Parent Class: MapExampleCollection
|
method
|
from_polars
|
fenic.core.types.semantic_examples.MapExampleCollection.from_polars
|
Create collection from a Polars DataFrame. Must have an 'output' column and at least one input column.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 307 | 329 | null |
MapExampleCollection
|
[
"cls",
"df"
] |
MapExampleCollection
| null | null |
Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame. Must have an 'output' column and at least one input column.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: MapExampleCollection
Parent Class: MapExampleCollection
|
method
|
_as_df_input
|
fenic.core.types.semantic_examples.MapExampleCollection._as_df_input
|
Convert examples to a list of dictionaries suitable for DataFrame creation.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 331 | 350 | null |
List[Dict[str, Any]]
|
[
"self"
] |
MapExampleCollection
| null | null |
Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: MapExampleCollection
|
method
|
_validate_against_column_types
|
fenic.core.types.semantic_examples.MapExampleCollection._validate_against_column_types
|
Validate that the collection matches the expected input columns from the instruction.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 352 | 354 | null |
None
|
[
"self",
"column_types"
] |
MapExampleCollection
| null | null |
Type: method
Member Name: _validate_against_column_types
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection._validate_against_column_types
Docstring: Validate that the collection matches the expected input columns from the instruction.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "column_types"]
Returns: None
Parent Class: MapExampleCollection
|
method
|
_validate_single_example_output_type
|
fenic.core.types.semantic_examples.MapExampleCollection._validate_single_example_output_type
| null |
site-packages/fenic/core/types/semantic_examples.py
| false | true | 356 | 376 | null |
None
|
[
"self",
"example"
] |
MapExampleCollection
| null | null |
Type: method
Member Name: _validate_single_example_output_type
Qualified Name: fenic.core.types.semantic_examples.MapExampleCollection._validate_single_example_output_type
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "example"]
Returns: None
Parent Class: MapExampleCollection
|
class
|
ClassifyExampleCollection
|
fenic.core.types.semantic_examples.ClassifyExampleCollection
|
Collection of text-to-category examples for classification operations.
Stores examples showing which category each input text should be assigned to.
Each example contains an input string and its corresponding category label.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 378 | 450 | null | null | null | null | null |
[
"BaseExampleCollection[ClassifyExample]"
] |
Type: class
Member Name: ClassifyExampleCollection
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection
Docstring: Collection of text-to-category examples for classification operations.
Stores examples showing which category each input text should be assigned to.
Each example contains an input string and its corresponding category label.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
from_polars
|
fenic.core.types.semantic_examples.ClassifyExampleCollection.from_polars
|
Create collection from a Polars DataFrame. Must have an 'output' column and an 'input' column.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 387 | 417 | null |
ClassifyExampleCollection
|
[
"cls",
"df"
] |
ClassifyExampleCollection
| null | null |
Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame. Must have an 'output' column and an 'input' column.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: ClassifyExampleCollection
Parent Class: ClassifyExampleCollection
|
method
|
_as_df_input
|
fenic.core.types.semantic_examples.ClassifyExampleCollection._as_df_input
|
Convert examples to a list of dictionaries suitable for DataFrame creation.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 419 | 434 | null |
List[Dict[str, Any]]
|
[
"self"
] |
ClassifyExampleCollection
| null | null |
Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: ClassifyExampleCollection
|
method
|
_validate_with_labels
|
fenic.core.types.semantic_examples.ClassifyExampleCollection._validate_with_labels
|
Validate examples against a set of valid labels.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 436 | 450 | null |
None
|
[
"self",
"valid_labels"
] |
ClassifyExampleCollection
| null | null |
Type: method
Member Name: _validate_with_labels
Qualified Name: fenic.core.types.semantic_examples.ClassifyExampleCollection._validate_with_labels
Docstring: Validate examples against a set of valid labels.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "valid_labels"]
Returns: None
Parent Class: ClassifyExampleCollection
|
class
|
PredicateExampleCollection
|
fenic.core.types.semantic_examples.PredicateExampleCollection
|
Collection of input-to-boolean examples for predicate operations.
Stores examples showing which inputs should evaluate to True or False
based on some condition. Each example contains input fields and a
boolean output indicating whether the condition holds.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 453 | 553 | null | null | null | null | null |
[
"BaseExampleCollection[PredicateExample]"
] |
Type: class
Member Name: PredicateExampleCollection
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection
Docstring: Collection of input-to-boolean examples for predicate operations.
Stores examples showing which inputs should evaluate to True or False
based on some condition. Each example contains input fields and a
boolean output indicating whether the condition holds.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core.types.semantic_examples.PredicateExampleCollection.__init__
|
Initialize a collection of semantic predicate examples.
Args:
examples: List of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 463 | 472 | null | null |
[
"self",
"examples"
] |
PredicateExampleCollection
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection.__init__
Docstring: Initialize a collection of semantic predicate examples.
Args:
examples: List of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "examples"]
Returns: none
Parent Class: PredicateExampleCollection
|
method
|
create_example
|
fenic.core.types.semantic_examples.PredicateExampleCollection.create_example
|
Create an example in the collection with input type validation.
Validates that input fields have consistent types across examples.
The first example establishes the schema and cannot have None values.
Subsequent examples must have the same fields but can have None values.
Args:
example: The PredicateExample to add.
Returns:
Self for method chaining.
Raises:
InvalidExampleCollectionError: If the example type is wrong, if the
first example contains None values, or if subsequent examples
have type mismatches.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 474 | 502 | null |
PredicateExampleCollection
|
[
"self",
"example"
] |
PredicateExampleCollection
| null | null |
Type: method
Member Name: create_example
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection.create_example
Docstring: Create an example in the collection with input type validation.
Validates that input fields have consistent types across examples.
The first example establishes the schema and cannot have None values.
Subsequent examples must have the same fields but can have None values.
Args:
example: The PredicateExample to add.
Returns:
Self for method chaining.
Raises:
InvalidExampleCollectionError: If the example type is wrong, if the
first example contains None values, or if subsequent examples
have type mismatches.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "example"]
Returns: PredicateExampleCollection
Parent Class: PredicateExampleCollection
|
method
|
from_polars
|
fenic.core.types.semantic_examples.PredicateExampleCollection.from_polars
|
Create collection from a Polars DataFrame.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 504 | 533 | null |
PredicateExampleCollection
|
[
"cls",
"df"
] |
PredicateExampleCollection
| null | null |
Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: PredicateExampleCollection
Parent Class: PredicateExampleCollection
|
method
|
_as_df_input
|
fenic.core.types.semantic_examples.PredicateExampleCollection._as_df_input
|
Convert examples to a list of dictionaries suitable for DataFrame creation.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 535 | 549 | null |
List[Dict[str, Any]]
|
[
"self"
] |
PredicateExampleCollection
| null | null |
Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: PredicateExampleCollection
|
method
|
_validate_against_column_types
|
fenic.core.types.semantic_examples.PredicateExampleCollection._validate_against_column_types
|
Validate that the collection matches the expected input columns from the instruction.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 551 | 553 | null |
None
|
[
"self",
"column_types"
] |
PredicateExampleCollection
| null | null |
Type: method
Member Name: _validate_against_column_types
Qualified Name: fenic.core.types.semantic_examples.PredicateExampleCollection._validate_against_column_types
Docstring: Validate that the collection matches the expected input columns from the instruction.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "column_types"]
Returns: None
Parent Class: PredicateExampleCollection
|
class
|
JoinExampleCollection
|
fenic.core.types.semantic_examples.JoinExampleCollection
|
Collection of comparison examples for semantic join operations.
Stores examples showing which pairs of values should be considered matches
for joining data. Each example contains a left value, right value, and
boolean output indicating whether they match.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 556 | 676 | null | null | null | null | null |
[
"BaseExampleCollection[JoinExample]"
] |
Type: class
Member Name: JoinExampleCollection
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection
Docstring: Collection of comparison examples for semantic join operations.
Stores examples showing which pairs of values should be considered matches
for joining data. Each example contains a left value, right value, and
boolean output indicating whether they match.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core.types.semantic_examples.JoinExampleCollection.__init__
|
Initialize a collection of semantic join examples.
Args:
examples: List of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 566 | 575 | null | null |
[
"self",
"examples"
] |
JoinExampleCollection
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection.__init__
Docstring: Initialize a collection of semantic join examples.
Args:
examples: List of examples to add to the collection. Each example
will be processed through create_example() to ensure proper formatting
and validation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "examples"]
Returns: none
Parent Class: JoinExampleCollection
|
method
|
create_example
|
fenic.core.types.semantic_examples.JoinExampleCollection.create_example
|
Create an example in the collection with type validation.
Validates that left_on and right_on values have consistent types across
examples. The first example establishes the types and cannot have None values.
Subsequent examples must have matching types but can have None values.
Args:
example: The JoinExample to add.
Returns:
Self for method chaining.
Raises:
InvalidExampleCollectionError: If the example type is wrong, if the
first example contains None values, or if subsequent examples
have type mismatches.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 577 | 610 | null |
JoinExampleCollection
|
[
"self",
"example"
] |
JoinExampleCollection
| null | null |
Type: method
Member Name: create_example
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection.create_example
Docstring: Create an example in the collection with type validation.
Validates that left_on and right_on values have consistent types across
examples. The first example establishes the types and cannot have None values.
Subsequent examples must have matching types but can have None values.
Args:
example: The JoinExample to add.
Returns:
Self for method chaining.
Raises:
InvalidExampleCollectionError: If the example type is wrong, if the
first example contains None values, or if subsequent examples
have type mismatches.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "example"]
Returns: JoinExampleCollection
Parent Class: JoinExampleCollection
|
method
|
from_polars
|
fenic.core.types.semantic_examples.JoinExampleCollection.from_polars
|
Create collection from a Polars DataFrame. Must have 'left_on', 'right_on', and 'output' columns.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 612 | 642 | null |
JoinExampleCollection
|
[
"cls",
"df"
] |
JoinExampleCollection
| null | null |
Type: method
Member Name: from_polars
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection.from_polars
Docstring: Create collection from a Polars DataFrame. Must have 'left_on', 'right_on', and 'output' columns.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "df"]
Returns: JoinExampleCollection
Parent Class: JoinExampleCollection
|
method
|
_validate_against_join_types
|
fenic.core.types.semantic_examples.JoinExampleCollection._validate_against_join_types
|
Validate that example types match the actual join column types.
Args:
left_type: DataType of the left join column
right_type: DataType of the right join column
Raises:
InvalidExampleCollectionError: If example types don't match column types.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 644 | 658 | null |
None
|
[
"self",
"left_type",
"right_type"
] |
JoinExampleCollection
| null | null |
Type: method
Member Name: _validate_against_join_types
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection._validate_against_join_types
Docstring: Validate that example types match the actual join column types.
Args:
left_type: DataType of the left join column
right_type: DataType of the right join column
Raises:
InvalidExampleCollectionError: If example types don't match column types.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "left_type", "right_type"]
Returns: None
Parent Class: JoinExampleCollection
|
method
|
_as_df_input
|
fenic.core.types.semantic_examples.JoinExampleCollection._as_df_input
|
Convert examples to a list of dictionaries suitable for DataFrame creation.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 660 | 676 | null |
List[Dict[str, Any]]
|
[
"self"
] |
JoinExampleCollection
| null | null |
Type: method
Member Name: _as_df_input
Qualified Name: fenic.core.types.semantic_examples.JoinExampleCollection._as_df_input
Docstring: Convert examples to a list of dictionaries suitable for DataFrame creation.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: List[Dict[str, Any]]
Parent Class: JoinExampleCollection
|
class
|
_ExampleTypeValidator
|
fenic.core.types.semantic_examples._ExampleTypeValidator
|
Validates types across examples with no None values allowed.
|
site-packages/fenic/core/types/semantic_examples.py
| false | true | 678 | 748 | null | null | null | null | null |
[] |
Type: class
Member Name: _ExampleTypeValidator
Qualified Name: fenic.core.types.semantic_examples._ExampleTypeValidator
Docstring: Validates types across examples with no None values allowed.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core.types.semantic_examples._ExampleTypeValidator.__init__
| null |
site-packages/fenic/core/types/semantic_examples.py
| true | false | 681 | 683 | null | null |
[
"self"
] |
_ExampleTypeValidator
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core.types.semantic_examples._ExampleTypeValidator.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: _ExampleTypeValidator
|
method
|
process_example
|
fenic.core.types.semantic_examples._ExampleTypeValidator.process_example
|
Process an example dict, establishing or validating types.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 685 | 718 | null |
None
|
[
"self",
"example_dict",
"example_num"
] |
_ExampleTypeValidator
| null | null |
Type: method
Member Name: process_example
Qualified Name: fenic.core.types.semantic_examples._ExampleTypeValidator.process_example
Docstring: Process an example dict, establishing or validating types.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "example_dict", "example_num"]
Returns: None
Parent Class: _ExampleTypeValidator
|
method
|
validate_against_column_types
|
fenic.core.types.semantic_examples._ExampleTypeValidator.validate_against_column_types
|
Validate that column types are a subset of example field types.
Args:
column_types: Mapping of column names to their DataType from the query plan.
Raises:
InvalidExampleCollectionError: If column types don't match example types
or if columns are missing from examples.
|
site-packages/fenic/core/types/semantic_examples.py
| true | false | 720 | 748 | null |
None
|
[
"self",
"column_types"
] |
_ExampleTypeValidator
| null | null |
Type: method
Member Name: validate_against_column_types
Qualified Name: fenic.core.types.semantic_examples._ExampleTypeValidator.validate_against_column_types
Docstring: Validate that column types are a subset of example field types.
Args:
column_types: Mapping of column names to their DataType from the query plan.
Raises:
InvalidExampleCollectionError: If column types don't match example types
or if columns are missing from examples.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "column_types"]
Returns: None
Parent Class: _ExampleTypeValidator
|
module
|
schema
|
fenic.core.types.schema
|
Schema definitions for DataFrame structures.
This module provides classes for defining and working with DataFrame schemas.
It includes ColumnField for individual column definitions and Schema for complete
DataFrame structure definitions.
|
site-packages/fenic/core/types/schema.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: schema
Qualified Name: fenic.core.types.schema
Docstring: Schema definitions for DataFrame structures.
This module provides classes for defining and working with DataFrame schemas.
It includes ColumnField for individual column definitions and Schema for complete
DataFrame structure definitions.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
ColumnField
|
fenic.core.types.schema.ColumnField
|
Represents a typed column in a DataFrame schema.
A ColumnField defines the structure of a single column by specifying its name
and data type. This is used as a building block for DataFrame schemas.
Attributes:
name: The name of the column.
data_type: The data type of the column, as a DataType instance.
|
site-packages/fenic/core/types/schema.py
| true | false | 17 | 74 | null | null | null | null | null |
[] |
Type: class
Member Name: ColumnField
Qualified Name: fenic.core.types.schema.ColumnField
Docstring: Represents a typed column in a DataFrame schema.
A ColumnField defines the structure of a single column by specifying its name
and data type. This is used as a building block for DataFrame schemas.
Attributes:
name: The name of the column.
data_type: The data type of the column, as a DataType instance.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.schema.ColumnField.__str__
|
Return a string representation of the ColumnField.
Returns:
A string in the format "ColumnField(name='name', data_type=type)".
|
site-packages/fenic/core/types/schema.py
| true | false | 32 | 38 | null |
str
|
[
"self"
] |
ColumnField
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.schema.ColumnField.__str__
Docstring: Return a string representation of the ColumnField.
Returns:
A string in the format "ColumnField(name='name', data_type=type)".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: ColumnField
|
method
|
_str_with_indent
|
fenic.core.types.schema.ColumnField._str_with_indent
|
Return a pretty-printed string representation with indentation.
Args:
indent: Number of spaces to indent.
Returns:
A formatted string representation of the ColumnField.
|
site-packages/fenic/core/types/schema.py
| false | true | 40 | 74 | null |
str
|
[
"self",
"indent"
] |
ColumnField
| null | null |
Type: method
Member Name: _str_with_indent
Qualified Name: fenic.core.types.schema.ColumnField._str_with_indent
Docstring: Return a pretty-printed string representation with indentation.
Args:
indent: Number of spaces to indent.
Returns:
A formatted string representation of the ColumnField.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "indent"]
Returns: str
Parent Class: ColumnField
|
class
|
Schema
|
fenic.core.types.schema.Schema
|
Represents the schema of a DataFrame.
A Schema defines the structure of a DataFrame by specifying an ordered collection
of column fields. Each column field defines the name and data type of a column
in the DataFrame.
Attributes:
column_fields: An ordered list of ColumnField objects that define the
structure of the DataFrame.
|
site-packages/fenic/core/types/schema.py
| true | false | 77 | 123 | null | null | null | null | null |
[] |
Type: class
Member Name: Schema
Qualified Name: fenic.core.types.schema.Schema
Docstring: Represents the schema of a DataFrame.
A Schema defines the structure of a DataFrame by specifying an ordered collection
of column fields. Each column field defines the name and data type of a column
in the DataFrame.
Attributes:
column_fields: An ordered list of ColumnField objects that define the
structure of the DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__str__
|
fenic.core.types.schema.Schema.__str__
|
Return a string representation of the Schema.
Returns:
A multi-line string with proper indentation showing the schema structure.
|
site-packages/fenic/core/types/schema.py
| true | false | 92 | 98 | null |
str
|
[
"self"
] |
Schema
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core.types.schema.Schema.__str__
Docstring: Return a string representation of the Schema.
Returns:
A multi-line string with proper indentation showing the schema structure.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: Schema
|
method
|
_str_with_indent
|
fenic.core.types.schema.Schema._str_with_indent
|
Return a pretty-printed string with custom base indentation.
Args:
base_indent: Number of spaces to use as base indentation.
Returns:
A multi-line string with proper indentation relative to base_indent.
|
site-packages/fenic/core/types/schema.py
| false | true | 100 | 115 | null |
str
|
[
"self",
"base_indent"
] |
Schema
| null | null |
Type: method
Member Name: _str_with_indent
Qualified Name: fenic.core.types.schema.Schema._str_with_indent
Docstring: Return a pretty-printed string with custom base indentation.
Args:
base_indent: Number of spaces to use as base indentation.
Returns:
A multi-line string with proper indentation relative to base_indent.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "base_indent"]
Returns: str
Parent Class: Schema
|
method
|
column_names
|
fenic.core.types.schema.Schema.column_names
|
Get a list of all column names in the schema.
Returns:
A list of strings containing the names of all columns in the schema.
|
site-packages/fenic/core/types/schema.py
| true | false | 117 | 123 | null |
List[str]
|
[
"self"
] |
Schema
| null | null |
Type: method
Member Name: column_names
Qualified Name: fenic.core.types.schema.Schema.column_names
Docstring: Get a list of all column names in the schema.
Returns:
A list of strings containing the names of all columns in the schema.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: Schema
|
class
|
DatasetMetadata
|
fenic.core.types.schema.DatasetMetadata
|
Metadata for a dataset (table or view).
Attributes:
schema: The schema of the dataset.
description: The natural language description of the dataset's contents.
|
site-packages/fenic/core/types/schema.py
| true | false | 126 | 135 | null | null | null | null | null |
[] |
Type: class
Member Name: DatasetMetadata
Qualified Name: fenic.core.types.schema.DatasetMetadata
Docstring: Metadata for a dataset (table or view).
Attributes:
schema: The schema of the dataset.
description: The natural language description of the dataset's contents.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
module
|
_inference
|
fenic.core._inference
| null |
site-packages/fenic/core/_inference/__init__.py
| false | true | null | null | null | null | null | null | null | null |
Type: module
Member Name: _inference
Qualified Name: fenic.core._inference
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none
|
module
|
model_provider
|
fenic.core._inference.model_provider
| null |
site-packages/fenic/core/_inference/model_provider.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: model_provider
Qualified Name: fenic.core._inference.model_provider
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
ModelProviderClass
|
fenic.core._inference.model_provider.ModelProviderClass
|
Abstract base class for model providers.
This class defines the interface that all model providers must implement,
including API key validation functionality.
|
site-packages/fenic/core/_inference/model_provider.py
| true | false | 4 | 52 | null | null | null | null | null |
[
"ABC"
] |
Type: class
Member Name: ModelProviderClass
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass
Docstring: Abstract base class for model providers.
This class defines the interface that all model providers must implement,
including API key validation functionality.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
create_client
|
fenic.core._inference.model_provider.ModelProviderClass.create_client
|
Create a synchronous client for this provider.
Returns the provider-specific synchronous client instance configured with the
appropriate credentials and settings.
|
site-packages/fenic/core/_inference/model_provider.py
| true | false | 17 | 24 | null | null |
[
"self"
] |
ModelProviderClass
| null | null |
Type: method
Member Name: create_client
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass.create_client
Docstring: Create a synchronous client for this provider.
Returns the provider-specific synchronous client instance configured with the
appropriate credentials and settings.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: ModelProviderClass
|
method
|
create_aio_client
|
fenic.core._inference.model_provider.ModelProviderClass.create_aio_client
|
Create an async client for this provider.
Returns the provider-specific asynchronous client instance configured with the
appropriate credentials and settings.
|
site-packages/fenic/core/_inference/model_provider.py
| true | false | 26 | 33 | null | null |
[
"self"
] |
ModelProviderClass
| null | null |
Type: method
Member Name: create_aio_client
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass.create_aio_client
Docstring: Create an async client for this provider.
Returns the provider-specific asynchronous client instance configured with the
appropriate credentials and settings.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: ModelProviderClass
|
method
|
validate_api_key
|
fenic.core._inference.model_provider.ModelProviderClass.validate_api_key
|
Validate the API key for this provider.
This method should create the appropriate client and perform a lightweight
API call to verify that the configured credentials are valid and the
service is accessible. Should log success but let exceptions bubble up.
|
site-packages/fenic/core/_inference/model_provider.py
| true | false | 35 | 43 | null |
None
|
[
"self"
] |
ModelProviderClass
| null | null |
Type: method
Member Name: validate_api_key
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass.validate_api_key
Docstring: Validate the API key for this provider.
This method should create the appropriate client and perform a lightweight
API call to verify that the configured credentials are valid and the
service is accessible. Should log success but let exceptions bubble up.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: ModelProviderClass
|
method
|
__str__
|
fenic.core._inference.model_provider.ModelProviderClass.__str__
| null |
site-packages/fenic/core/_inference/model_provider.py
| true | false | 45 | 46 | null |
str
|
[
"self"
] |
ModelProviderClass
| null | null |
Type: method
Member Name: __str__
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass.__str__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: ModelProviderClass
|
method
|
__repr__
|
fenic.core._inference.model_provider.ModelProviderClass.__repr__
| null |
site-packages/fenic/core/_inference/model_provider.py
| true | false | 48 | 49 | null |
str
|
[
"self"
] |
ModelProviderClass
| null | null |
Type: method
Member Name: __repr__
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass.__repr__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: ModelProviderClass
|
method
|
__hash__
|
fenic.core._inference.model_provider.ModelProviderClass.__hash__
| null |
site-packages/fenic/core/_inference/model_provider.py
| true | false | 51 | 52 | null |
int
|
[
"self"
] |
ModelProviderClass
| null | null |
Type: method
Member Name: __hash__
Qualified Name: fenic.core._inference.model_provider.ModelProviderClass.__hash__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: int
Parent Class: ModelProviderClass
|
module
|
model_catalog
|
fenic.core._inference.model_catalog
| null |
site-packages/fenic/core/_inference/model_catalog.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: model_catalog
Qualified Name: fenic.core._inference.model_catalog
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.