type stringclasses 5
values | name stringlengths 1 55 | qualified_name stringlengths 5 147 | docstring stringlengths 15 4.52k ⌀ | filepath stringclasses 206
values | is_public bool 2
classes | is_private bool 2
classes | line_start int64 0 1.99k ⌀ | line_end int64 0 2.01k ⌀ | annotation stringclasses 14
values | returns stringclasses 308
values | value stringclasses 152
values | parameters listlengths 0 117 ⌀ | bases listlengths 0 3 ⌀ | parent_class stringclasses 376
values | api_element_summary stringlengths 199 33.8k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
class | _LogicalType | fenic.core.types.datatypes._LogicalType | Marker class for all logical types. | null | false | true | 76 | 79 | null | null | null | null | [
"DataType"
] | null | Type: class
Member Name: _LogicalType
Qualified Name: fenic.core.types.datatypes._LogicalType
Docstring: Marker class for all logical types.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
class | _StringType | fenic.core.types.datatypes._StringType | null | null | false | true | 85 | 104 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _StringType
Qualified Name: fenic.core.types.datatypes._StringType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._StringType.__str__ | Return a string representation of the string type.
Returns:
The string "StringType". | null | true | false | 87 | 93 | null | str | null | [
"self"
] | null | _StringType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._StringType.__str__
Docstring: Return a string representation of the string type.
Returns:
The string "StringType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _String... |
method | __eq__ | fenic.core.types.datatypes._StringType.__eq__ | Compare this string type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a string type, False otherwise. | null | true | false | 95 | 104 | null | bool | null | [
"self",
"other"
] | null | _StringType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._StringType.__eq__
Docstring: Compare this string type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a string type, False otherwise.
Value: none
Annotation: none
i... |
class | _IntegerType | fenic.core.types.datatypes._IntegerType | null | null | false | true | 107 | 126 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _IntegerType
Qualified Name: fenic.core.types.datatypes._IntegerType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._IntegerType.__str__ | Return a string representation of the integer type.
Returns:
The string "IntegerType". | null | true | false | 109 | 115 | null | str | null | [
"self"
] | null | _IntegerType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._IntegerType.__str__
Docstring: Return a string representation of the integer type.
Returns:
The string "IntegerType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _Int... |
method | __eq__ | fenic.core.types.datatypes._IntegerType.__eq__ | Compare this integer type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an integer type, False otherwise. | null | true | false | 117 | 126 | null | bool | null | [
"self",
"other"
] | null | _IntegerType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._IntegerType.__eq__
Docstring: Compare this integer type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also an integer type, False otherwise.
Value: none
Annotation: no... |
class | _FloatType | fenic.core.types.datatypes._FloatType | null | null | false | true | 129 | 148 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _FloatType
Qualified Name: fenic.core.types.datatypes._FloatType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._FloatType.__str__ | Return a string representation of the float type.
Returns:
The string "FloatType". | null | true | false | 131 | 137 | null | str | null | [
"self"
] | null | _FloatType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._FloatType.__str__
Docstring: Return a string representation of the float type.
Returns:
The string "FloatType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _FloatType |
method | __eq__ | fenic.core.types.datatypes._FloatType.__eq__ | Compare this float type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a float type, False otherwise. | null | true | false | 139 | 148 | null | bool | null | [
"self",
"other"
] | null | _FloatType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._FloatType.__eq__
Docstring: Compare this float type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a float type, False otherwise.
Value: none
Annotation: none
is P... |
class | _DoubleType | fenic.core.types.datatypes._DoubleType | null | null | false | true | 151 | 170 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _DoubleType
Qualified Name: fenic.core.types.datatypes._DoubleType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._DoubleType.__str__ | Return a string representation of the double type.
Returns:
The string "DoubleType". | null | true | false | 153 | 159 | null | str | null | [
"self"
] | null | _DoubleType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._DoubleType.__str__
Docstring: Return a string representation of the double type.
Returns:
The string "DoubleType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _Double... |
method | __eq__ | fenic.core.types.datatypes._DoubleType.__eq__ | Compare this double type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a double type, False otherwise. | null | true | false | 161 | 170 | null | bool | null | [
"self",
"other"
] | null | _DoubleType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._DoubleType.__eq__
Docstring: Compare this double type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a double type, False otherwise.
Value: none
Annotation: none
i... |
class | _BooleanType | fenic.core.types.datatypes._BooleanType | null | null | false | true | 173 | 192 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _BooleanType
Qualified Name: fenic.core.types.datatypes._BooleanType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._BooleanType.__str__ | Return a string representation of the boolean type.
Returns:
The string "BooleanType". | null | true | false | 175 | 181 | null | str | null | [
"self"
] | null | _BooleanType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._BooleanType.__str__
Docstring: Return a string representation of the boolean type.
Returns:
The string "BooleanType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _Boo... |
method | __eq__ | fenic.core.types.datatypes._BooleanType.__eq__ | Compare this boolean type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a boolean type, False otherwise. | null | true | false | 183 | 192 | null | bool | null | [
"self",
"other"
] | null | _BooleanType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._BooleanType.__eq__
Docstring: Compare this boolean type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a boolean type, False otherwise.
Value: none
Annotation: non... |
class | _DateType | fenic.core.types.datatypes._DateType | null | null | false | true | 195 | 214 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _DateType
Qualified Name: fenic.core.types.datatypes._DateType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._DateType.__str__ | Return a string representation of the date type.
Returns:
The string "DateType". | null | true | false | 197 | 203 | null | str | null | [
"self"
] | null | _DateType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._DateType.__str__
Docstring: Return a string representation of the date type.
Returns:
The string "DateType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: _DateType |
method | __eq__ | fenic.core.types.datatypes._DateType.__eq__ | Compare this date type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a date type, False otherwise. | null | true | false | 205 | 214 | null | bool | null | [
"self",
"other"
] | null | _DateType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._DateType.__eq__
Docstring: Compare this date type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a date type, False otherwise.
Value: none
Annotation: none
is Publ... |
class | _TimestampType | fenic.core.types.datatypes._TimestampType | null | null | false | true | 217 | 236 | null | null | null | null | [
"_PrimitiveType"
] | null | Type: class
Member Name: _TimestampType
Qualified Name: fenic.core.types.datatypes._TimestampType
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
method | __str__ | fenic.core.types.datatypes._TimestampType.__str__ | Return a string representation of the timestamp type.
Returns:
The string "TimestampType". | null | true | false | 219 | 225 | null | str | null | [
"self"
] | null | _TimestampType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes._TimestampType.__str__
Docstring: Return a string representation of the timestamp type.
Returns:
The string "TimestampType".
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class... |
method | __eq__ | fenic.core.types.datatypes._TimestampType.__eq__ | Compare this timestamp type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a timestamp type, False otherwise. | null | true | false | 227 | 236 | null | bool | null | [
"self",
"other"
] | null | _TimestampType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes._TimestampType.__eq__
Docstring: Compare this timestamp type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the other object is also a timestamp type, False otherwise.
Value: none
Annotatio... |
class | ArrayType | fenic.core.types.datatypes.ArrayType | A type representing a homogeneous variable-length array (list) of elements.
Attributes:
element_type: The data type of each element in the array.
Example: Create an array of strings
```python
ArrayType(StringType)
ArrayType(element_type=StringType)
``` | null | true | false | 242 | 276 | null | null | null | null | [
"DataType"
] | null | Type: class
Member Name: ArrayType
Qualified Name: fenic.core.types.datatypes.ArrayType
Docstring: A type representing a homogeneous variable-length array (list) of elements.
Attributes:
element_type: The data type of each element in the array.
Example: Create an array of strings
```python
ArrayType(Strin... |
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. | null | true | false | 258 | 264 | null | str | null | [
"self"
] | null | ArrayType | 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"]
Retur... |
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. | null | true | false | 266 | 276 | null | bool | null | [
"self",
"other"
] | null | ArrayType | 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.
Va... |
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. | null | true | false | 279 | 313 | 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: non... |
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. | null | true | false | 291 | 297 | null | str | null | [
"self"
] | null | StructField | 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:... |
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. | null | true | false | 299 | 313 | null | bool | null | [
"self",
"other"
] | null | StructField | 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 ot... |
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),
])
``` | null | true | false | 316 | 354 | null | null | null | null | [
"DataType"
] | null | 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", ... |
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. | null | true | false | 334 | 340 | null | str | null | [
"self"
] | null | StructType | 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:... |
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. | null | true | false | 342 | 354 | null | bool | null | [
"self",
"other"
] | null | StructType | 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:... |
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="t... | null | true | false | 357 | 398 | null | null | null | null | [
"_LogicalType"
] | null | 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: ... |
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. | null | true | false | 374 | 382 | null | str | null | [
"self"
] | null | EmbeddingType | 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
Paramete... |
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. | null | true | false | 384 | 398 | null | bool | null | [
"self",
"other"
] | null | EmbeddingType | 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,... |
class | _MarkdownType | fenic.core.types.datatypes._MarkdownType | Represents a markdown document. | null | false | true | 404 | 425 | null | null | null | null | [
"_LogicalType"
] | null | 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". | null | true | false | 408 | 414 | null | str | null | [
"self"
] | null | _MarkdownType | 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: _... |
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. | null | true | false | 416 | 425 | null | bool | null | [
"self",
"other"
] | null | _MarkdownType | 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: ... |
class | _HtmlType | fenic.core.types.datatypes._HtmlType | Represents a valid HTML document. | null | false | true | 428 | 449 | null | null | null | null | [
"_LogicalType"
] | null | 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". | null | true | false | 432 | 438 | null | str | null | [
"self"
] | null | _HtmlType | 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. | null | true | false | 440 | 449 | null | bool | null | [
"self",
"other"
] | null | _HtmlType | 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 Pub... |
class | _JsonType | fenic.core.types.datatypes._JsonType | Represents a valid JSON document. | null | false | true | 452 | 473 | null | null | null | null | [
"_LogicalType"
] | null | 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". | null | true | false | 456 | 462 | null | str | null | [
"self"
] | null | _JsonType | 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. | null | true | false | 464 | 473 | null | bool | null | [
"self",
"other"
] | null | _JsonType | 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 Publ... |
class | TranscriptType | fenic.core.types.datatypes.TranscriptType | Represents a string containing a transcript in a specific format. | null | true | false | 476 | 500 | null | null | null | null | [
"_LogicalType"
] | null | 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. | null | true | false | 482 | 488 | null | str | null | [
"self"
] | null | TranscriptType | 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: ["sel... |
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. | null | true | false | 490 | 500 | null | bool | null | [
"self",
"other"
] | null | TranscriptType | 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 other... |
class | DocumentPathType | fenic.core.types.datatypes.DocumentPathType | Represents a string containing a a document's local (file system) or remote (URL) path. | null | true | false | 503 | 527 | null | null | null | null | [
"_LogicalType"
] | null | 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. | null | true | false | 509 | 515 | null | str | null | [
"self"
] | null | DocumentPathType | 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
Parameter... |
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. | null | true | false | 517 | 527 | null | bool | null | [
"self",
"other"
] | null | DocumentPathType | 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,
Fal... |
function | _is_dtype_numeric | fenic.core.types.datatypes._is_dtype_numeric | Check if a data type is a numeric type. | null | false | true | 530 | 532 | null | bool | null | [
"dtype"
] | 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. | null | false | true | 535 | 543 | null | bool | null | [
"type"
] | 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"]
Re... |
attribute | StringType | fenic.core.types.datatypes.StringType | Represents a UTF-8 encoded string value. | null | true | false | 547 | 547 | null | null | _StringType() | null | null | 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. | null | true | false | 550 | 550 | null | null | _IntegerType() | null | null | 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. | null | true | false | 553 | 553 | null | null | _FloatType() | null | null | 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. | null | true | false | 556 | 556 | null | null | _DoubleType() | null | null | 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) | null | true | false | 559 | 559 | null | null | _BooleanType() | null | null | 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 | DateType | fenic.core.types.datatypes.DateType | Represents a date value. | null | true | false | 562 | 562 | null | null | _DateType() | null | null | null | Type: attribute
Member Name: DateType
Qualified Name: fenic.core.types.datatypes.DateType
Docstring: Represents a date value.
Value: _DateType()
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | TimestampType | fenic.core.types.datatypes.TimestampType | Represents a timestamp value. | null | true | false | 565 | 565 | null | null | _TimestampType() | null | null | null | Type: attribute
Member Name: TimestampType
Qualified Name: fenic.core.types.datatypes.TimestampType
Docstring: Represents a timestamp value.
Value: _TimestampType()
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. | null | true | false | 568 | 568 | null | null | _MarkdownType() | null | null | 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. | null | true | false | 571 | 571 | null | null | _HtmlType() | null | null | 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. | null | true | false | 574 | 574 | null | null | _JsonType() | null | null | 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. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/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... |
attribute | ExampleType | fenic.core.types.semantic_examples.ExampleType | null | null | true | false | 27 | 27 | null | null | TypeVar('ExampleType') | null | null | 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 | null | true | false | 29 | 29 | null | null | logging.getLogger(__name__) | null | null | 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. | null | true | false | 31 | 58 | null | null | null | null | [
"BaseModel"
] | null | 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:... |
method | __eq__ | fenic.core.types.semantic_examples.MapExample.__eq__ | Compare MapExample instances, handling dictionary key order differences. | null | true | false | 41 | 58 | null | bool | null | [
"self",
"other"
] | null | MapExample | 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: MapExampl... |
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. | null | true | false | 61 | 69 | null | null | null | null | [
"BaseModel"
] | null | 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.
Val... |
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. | null | true | false | 72 | 99 | null | null | null | null | [
"BaseModel"
] | null | 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.
Va... |
method | __eq__ | fenic.core.types.semantic_examples.PredicateExample.__eq__ | Compare PredicateExample instances, handling dictionary key order differences. | null | true | false | 82 | 99 | null | bool | null | [
"self",
"other"
] | null | PredicateExample | 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 Clas... |
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. | null | true | false | 102 | 111 | null | null | null | null | [
"BaseModel"
] | null | 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 operatio... |
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 particu... | null | true | false | 113 | 245 | null | null | null | null | [
"ABC",
"Generic[ExampleType]"
] | null | 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 co... |
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.
... | null | true | false | 130 | 146 | null | null | null | [
"self",
"examples"
] | null | BaseExampleCollection | 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... |
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:
InvalidExampleCollectionErr... | null | true | false | 148 | 164 | null | BaseExampleCollection | null | [
"cls",
"df"
] | null | BaseExampleCollection | 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 collec... |
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:
InvalidExampleCollectionErr... | null | true | false | 166 | 182 | null | BaseExampleCollection | null | [
"cls",
"df"
] | null | BaseExampleCollection | 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 collec... |
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. | null | false | true | 184 | 187 | null | List[Dict[str, Any]] | null | [
"self"
] | null | BaseExampleCollection | 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[... |
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. | null | true | false | 189 | 197 | null | pl.DataFrame | null | [
"self"
] | null | BaseExampleCollection | 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.
... |
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. | null | true | false | 199 | 207 | null | pd.DataFrame | null | [
"self"
] | null | BaseExampleCollection | 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.
... |
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. | null | true | false | 209 | 224 | null | BaseExampleCollection | null | [
"self",
"example"
] | null | BaseExampleCollection | 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 chain... |
method | __eq__ | fenic.core.types.semantic_examples.BaseExampleCollection.__eq__ | Check if two example collections are equal. | null | true | false | 226 | 245 | null | bool | null | [
"self",
"other"
] | null | BaseExampleCollection | 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. | null | true | false | 247 | 376 | null | null | null | null | [
"BaseExampleCollection[MapExample]"
] | null | 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... |
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. | null | true | false | 258 | 267 | null | null | null | [
"self",
"examples"
] | null | MapExampleCollection | 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 prope... |
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 th... | null | true | false | 269 | 305 | null | MapExampleCollection | null | [
"self",
"example"
] | null | MapExampleCollection | 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 ... |
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. | null | true | false | 307 | 329 | null | MapExampleCollection | null | [
"cls",
"df"
] | null | MapExampleCollection | 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... |
method | _as_df_input | fenic.core.types.semantic_examples.MapExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 331 | 350 | null | List[Dict[str, Any]] | null | [
"self"
] | null | MapExampleCollection | 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[st... |
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. | null | false | true | 352 | 354 | null | None | null | [
"self",
"column_types"
] | null | MapExampleCollection | 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? : t... |
method | _validate_single_example_output_type | fenic.core.types.semantic_examples.MapExampleCollection._validate_single_example_output_type | null | null | false | true | 356 | 376 | null | None | null | [
"self",
"example"
] | null | MapExampleCollection | 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: MapEx... |
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. | null | true | false | 378 | 450 | null | null | null | null | [
"BaseExampleCollection[ClassifyExample]"
] | null | 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 ... |
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. | null | true | false | 387 | 417 | null | ClassifyExampleCollection | null | [
"cls",
"df"
] | null | ClassifyExampleCollection | 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", ... |
method | _as_df_input | fenic.core.types.semantic_examples.ClassifyExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 419 | 434 | null | List[Dict[str, Any]] | null | [
"self"
] | null | ClassifyExampleCollection | 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[Di... |
method | _validate_with_labels | fenic.core.types.semantic_examples.ClassifyExampleCollection._validate_with_labels | Validate examples against a set of valid labels. | null | false | true | 436 | 450 | null | None | null | [
"self",
"valid_labels"
] | null | ClassifyExampleCollection | 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: ... |
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. | null | true | false | 453 | 553 | null | null | null | null | [
"BaseExampleCollection[PredicateExample]"
] | null | 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 cont... |
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. | null | true | false | 463 | 472 | null | null | null | [
"self",
"examples"
] | null | PredicateExampleCollection | 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 ... |
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 ad... | null | true | false | 474 | 502 | null | PredicateExampleCollection | null | [
"self",
"example"
] | null | PredicateExampleCollection | 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 an... |
method | from_polars | fenic.core.types.semantic_examples.PredicateExampleCollection.from_polars | Create collection from a Polars DataFrame. | null | true | false | 504 | 533 | null | PredicateExampleCollection | null | [
"cls",
"df"
] | null | PredicateExampleCollection | 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 Cl... |
method | _as_df_input | fenic.core.types.semantic_examples.PredicateExampleCollection._as_df_input | Convert examples to a list of dictionaries suitable for DataFrame creation. | null | false | true | 535 | 549 | null | List[Dict[str, Any]] | null | [
"self"
] | null | PredicateExampleCollection | 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[D... |
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. | null | false | true | 551 | 553 | null | None | null | [
"self",
"column_types"
] | null | PredicateExampleCollection | 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 Privat... |
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. | null | true | false | 556 | 676 | null | null | null | null | [
"BaseExampleCollection[JoinExample]"
] | null | 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 va... |
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. | null | true | false | 566 | 575 | null | null | null | [
"self",
"examples"
] | null | JoinExampleCollection | 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 pro... |
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 ... | null | true | false | 577 | 610 | null | JoinExampleCollection | null | [
"self",
"example"
] | null | JoinExampleCollection | 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... |
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. | null | true | false | 612 | 642 | null | JoinExampleCollection | null | [
"cls",
"df"
] | null | JoinExampleCollection | 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", "... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.