type stringclasses 5
values | name stringlengths 1 55 | qualified_name stringlengths 5 130 | docstring stringlengths 15 3.11k ⌀ | filepath stringclasses 90
values | is_public bool 2
classes | is_private bool 2
classes | line_start int64 0 1.44k ⌀ | line_end int64 0 1.51k ⌀ | annotation stringclasses 2
values | returns stringclasses 82
values | value stringclasses 66
values | parameters listlengths 0 10 ⌀ | bases listlengths 0 2 ⌀ | parent_class stringclasses 193
values | api_element_summary stringlengths 199 3.43k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
function | _create_nested_model | fenic.core._utils.extract._create_nested_model | Create a Pydantic model type from an ExtractSchema schema, handling nested structures.
Args:
schema: The ExtractSchema to convert to a Pydantic model
model_name: The name to use for the generated model class
Returns:
A Pydantic model type that matches the schema structure | null | false | true | 126 | 170 | null | type[BaseModel] | null | [
"schema",
"model_name"
] | null | null | Type: function
Member Name: _create_nested_model
Qualified Name: fenic.core._utils.extract._create_nested_model
Docstring: Create a Pydantic model type from an ExtractSchema schema, handling nested structures.
Args:
schema: The ExtractSchema to convert to a Pydantic model
model_name: The name to use for the ge... |
module | schema | fenic.core._utils.schema | Utilities for converting between different schema representations. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_utils/schema.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: schema
Qualified Name: fenic.core._utils.schema
Docstring: Utilities for converting between different schema representations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
function | convert_polars_schema_to_custom_schema | fenic.core._utils.schema.convert_polars_schema_to_custom_schema | Convert a Polars schema to an Omnitype Schema.
Args:
polars_schema: The Polars schema to convert
Returns:
The corresponding Omnitype Schema with equivalent column fields
Example:
>>> custom_schema = convert_polars_schema_to_custom_schema(df.schema) | null | true | false | 29 | 51 | null | Schema | null | [
"polars_schema"
] | null | null | Type: function
Member Name: convert_polars_schema_to_custom_schema
Qualified Name: fenic.core._utils.schema.convert_polars_schema_to_custom_schema
Docstring: Convert a Polars schema to an Omnitype Schema.
Args:
polars_schema: The Polars schema to convert
Returns:
The corresponding Omnitype Schema with equival... |
function | convert_custom_schema_to_polars_schema | fenic.core._utils.schema.convert_custom_schema_to_polars_schema | Convert an Omnitype Schema to a Polars schema.
Args:
custom_schema: The Omnitype Schema to convert
Returns:
The corresponding Polars schema with equivalent fields
Example:
>>> polars_schema = convert_custom_schema_to_polars_schema(custom_schema) | null | true | false | 54 | 73 | null | pl.Schema | null | [
"custom_schema"
] | null | null | Type: function
Member Name: convert_custom_schema_to_polars_schema
Qualified Name: fenic.core._utils.schema.convert_custom_schema_to_polars_schema
Docstring: Convert an Omnitype Schema to a Polars schema.
Args:
custom_schema: The Omnitype Schema to convert
Returns:
The corresponding Polars schema with equival... |
function | convert_pydantic_type_to_custom_struct_type | fenic.core._utils.schema.convert_pydantic_type_to_custom_struct_type | Convert a Pydantic model to a custom StructType.
Args:
model: The Pydantic model to convert (either an instance or a class)
Returns:
The corresponding custom StructType
Raises:
ValueError: If the model is not a Pydantic model
Example:
>>> struct_type = convert_pydantic_to_custom_struct_type(model) | null | true | false | 76 | 143 | null | StructType | null | [
"model"
] | null | null | Type: function
Member Name: convert_pydantic_type_to_custom_struct_type
Qualified Name: fenic.core._utils.schema.convert_pydantic_type_to_custom_struct_type
Docstring: Convert a Pydantic model to a custom StructType.
Args:
model: The Pydantic model to convert (either an instance or a class)
Returns:
The corre... |
function | convert_custom_dtype_to_polars | fenic.core._utils.schema.convert_custom_dtype_to_polars | Convert custom data type to the Polars data type.
Args:
custom_dtype: Custom data type
Returns:
pl.DataType: Corresponding Polars data type
Raises:
ValueError: If the custom data type is not supported | null | true | false | 146 | 190 | null | pl.DataType | null | [
"custom_dtype"
] | null | null | Type: function
Member Name: convert_custom_dtype_to_polars
Qualified Name: fenic.core._utils.schema.convert_custom_dtype_to_polars
Docstring: Convert custom data type to the Polars data type.
Args:
custom_dtype: Custom data type
Returns:
pl.DataType: Corresponding Polars data type
Raises:
ValueError: If ... |
function | _convert_pytype_to_custom_dtype | fenic.core._utils.schema._convert_pytype_to_custom_dtype | Convert a basic Python type to a PrimitiveType. | null | false | true | 193 | 206 | null | _PrimitiveType | null | [
"py_type"
] | null | null | Type: function
Member Name: _convert_pytype_to_custom_dtype
Qualified Name: fenic.core._utils.schema._convert_pytype_to_custom_dtype
Docstring: Convert a basic Python type to a PrimitiveType.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["py_type"]
Returns: _PrimitiveType
Parent Class:... |
function | _convert_polars_dtype_to_custom_dtype | fenic.core._utils.schema._convert_polars_dtype_to_custom_dtype | Convert Polars data type to the custom PrimitiveType enum or complex type.
Args:
polars_dtype: Polars data type
Returns:
Union[PrimitiveType, ArrayType, StructType]: Corresponding custom data type
Raises:
ValueError: If the Polars data type is not supported | null | false | true | 209 | 257 | null | DataType | null | [
"polars_dtype"
] | null | null | Type: function
Member Name: _convert_polars_dtype_to_custom_dtype
Qualified Name: fenic.core._utils.schema._convert_polars_dtype_to_custom_dtype
Docstring: Convert Polars data type to the custom PrimitiveType enum or complex type.
Args:
polars_dtype: Polars data type
Returns:
Union[PrimitiveType, ArrayType, S... |
module | types | fenic.core.types | Schema module for defining and manipulating DataFrame schemas. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/types/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: types
Qualified Name: fenic.core.types
Docstring: Schema module for defining and manipulating DataFrame schemas.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.core.types.__all__ | null | null | false | false | 42 | 77 | null | null | ['ArrayType', 'BooleanType', 'BranchSide', 'ClassifyExample', 'ClassifyExampleCollection', 'ColumnField', 'DataType', 'DataLike', 'DataLikeType', 'QueryResult', 'DocumentPathType', 'DoubleType', 'EmbeddingType', 'ExtractSchema', 'ExtractSchemaField', 'ExtractSchemaList', 'FloatType', 'HtmlType', 'IntegerType', 'JoinExa... | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.core.types.__all__
Docstring: none
Value: ['ArrayType', 'BooleanType', 'BranchSide', 'ClassifyExample', 'ClassifyExampleCollection', 'ColumnField', 'DataType', 'DataLike', 'DataLikeType', 'QueryResult', 'DocumentPathType', 'DoubleType', 'EmbeddingType', 'Extrac... |
module | query_result | fenic.core.types.query_result | QueryResult class and related types. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/types/query_result.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: query_result
Qualified Name: fenic.core.types.query_result
Docstring: QueryResult class and related types.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | DataLikeType | fenic.core.types.query_result.DataLikeType | String literal type for specifying data output formats.
Valid values:
- "polars": Native Polars DataFrame format
- "pandas": Pandas DataFrame with PyArrow extension arrays
- "pydict": Python dictionary with column names as keys, lists as values
- "pylist": Python list of dictionaries, each representing... | null | true | false | 13 | 13 | null | null | Literal['polars', 'pandas', 'pydict', 'pylist', 'arrow'] | null | null | null | Type: attribute
Member Name: DataLikeType
Qualified Name: fenic.core.types.query_result.DataLikeType
Docstring: String literal type for specifying data output formats.
Valid values:
- "polars": Native Polars DataFrame format
- "pandas": Pandas DataFrame with PyArrow extension arrays
- "pydict": Python dict... |
attribute | DataLike | fenic.core.types.query_result.DataLike | Union type representing any supported data format for both input and output operations.
This type encompasses all possible data structures that can be:
1. Used as input when creating DataFrames
2. Returned as output from query results
Supported formats:
- pl.DataFrame: Native Polars DataFrame with efficient colum... | null | true | false | 28 | 34 | null | null | Union[pl.DataFrame, pd.DataFrame, Dict[str, List[Any]], List[Dict[str, Any]], pa.Table] | null | null | null | Type: attribute
Member Name: DataLike
Qualified Name: fenic.core.types.query_result.DataLike
Docstring: Union type representing any supported data format for both input and output operations.
This type encompasses all possible data structures that can be:
1. Used as input when creating DataFrames
2. Returned as output... |
class | QueryResult | fenic.core.types.query_result.QueryResult | Container for query execution results and associated metadata.
This dataclass bundles together the materialized data from a query execution
along with metrics about the execution process. It provides a unified interface
for accessing both the computed results and performance information.
Attributes:
data (DataLik... | null | true | false | 61 | 106 | null | null | null | null | [] | null | Type: class
Member Name: QueryResult
Qualified Name: fenic.core.types.query_result.QueryResult
Docstring: Container for query execution results and associated metadata.
This dataclass bundles together the materialized data from a query execution
along with metrics about the execution process. It provides a unified int... |
method | __init__ | fenic.core.types.query_result.QueryResult.__init__ | null | null | true | false | 0 | 0 | null | None | null | [
"self",
"data",
"metrics"
] | null | QueryResult | Type: method
Member Name: __init__
Qualified Name: fenic.core.types.query_result.QueryResult.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "data", "metrics"]
Returns: None
Parent Class: QueryResult |
module | enums | fenic.core.types.enums | Enums used in the DataFrame API. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/types/enums.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: enums
Qualified Name: fenic.core.types.enums
Docstring: Enums used in the DataFrame API.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | SemanticSimilarityMetric | fenic.core.types.enums.SemanticSimilarityMetric | Type alias representing supported semantic similarity metrics.
Valid values:
- "cosine": Cosine similarity, measures the cosine of the angle between two vectors.
- "l2": Euclidean (L2) distance, measures the straight-line distance between two vectors.
- "dot": Dot product similarity, the raw inner product of two vect... | null | true | false | 6 | 6 | null | null | Literal['cosine', 'l2', 'dot'] | null | null | null | Type: attribute
Member Name: SemanticSimilarityMetric
Qualified Name: fenic.core.types.enums.SemanticSimilarityMetric
Docstring: Type alias representing supported semantic similarity metrics.
Valid values:
- "cosine": Cosine similarity, measures the cosine of the angle between two vectors.
- "l2": Euclidean (L2) dist... |
attribute | BranchSide | fenic.core.types.enums.BranchSide | Type alias representing the side of a branch in a lineage graph.
Valid values:
- "left": The left branch of a join.
- "right": The right branch of a join. | null | true | false | 21 | 21 | null | null | Literal['left', 'right'] | null | null | null | Type: attribute
Member Name: BranchSide
Qualified Name: fenic.core.types.enums.BranchSide
Docstring: Type alias representing the side of a branch in a lineage graph.
Valid values:
- "left": The left branch of a join.
- "right": The right branch of a join.
Value: Literal['left', 'right']
Annotation: none
is Public? : ... |
attribute | TranscriptFormatType | fenic.core.types.enums.TranscriptFormatType | Type alias representing supported transcript formats.
Valid values:
- "srt": SubRip Subtitle format with indexed entries and timestamp ranges
- "generic": Conversation transcript format with speaker names and timestamps
Both formats are parsed into a unified schema with fields: index, speaker,
start_time, end_time, ... | null | true | false | 31 | 31 | null | null | Literal['srt', 'generic'] | null | null | null | Type: attribute
Member Name: TranscriptFormatType
Qualified Name: fenic.core.types.enums.TranscriptFormatType
Docstring: Type alias representing supported transcript formats.
Valid values:
- "srt": SubRip Subtitle format with indexed entries and timestamp ranges
- "generic": Conversation transcript format with speake... |
attribute | JoinType | fenic.core.types.enums.JoinType | Type alias representing supported join types.
Valid values:
- "inner": Inner join, returns only rows that have matching values in both tables.
- "outer": Outer join, returns all rows from both tables, filling missing values with nulls.
- "left": Left join, returns all rows from the left table and matching rows from t... | null | true | false | 44 | 44 | null | null | Literal['inner', 'full', 'left', 'right', 'cross'] | null | null | null | Type: attribute
Member Name: JoinType
Qualified Name: fenic.core.types.enums.JoinType
Docstring: Type alias representing supported join types.
Valid values:
- "inner": Inner join, returns only rows that have matching values in both tables.
- "outer": Outer join, returns all rows from both tables, filling missing valu... |
module | extract_schema | fenic.core.types.extract_schema | Type definitions for semantic extraction schemas. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/types/extract_schema.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: extract_schema
Qualified Name: fenic.core.types.extract_schema
Docstring: Type definitions for semantic extraction schemas.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | ExtractSchemaList | fenic.core.types.extract_schema.ExtractSchemaList | Represents a list data type for structured extraction schema definitions.
A schema list contains elements of a specific data type and is used for defining
array-like structures in structured extraction schemas. | null | true | false | 11 | 49 | null | null | null | null | [] | null | Type: class
Member Name: ExtractSchemaList
Qualified Name: fenic.core.types.extract_schema.ExtractSchemaList
Docstring: Represents a list data type for structured extraction schema definitions.
A schema list contains elements of a specific data type and is used for defining
array-like structures in structured extracti... |
method | __init__ | fenic.core.types.extract_schema.ExtractSchemaList.__init__ | Initialize an ExtractSchemaList.
Args:
element_type: The data type of elements in the list. Must be either a primitive
DataType or another ExtractSchema.
Raises:
ValueError: If element_type is a non-primitive DataType. | null | true | false | 21 | 41 | null | null | null | [
"self",
"element_type"
] | null | ExtractSchemaList | Type: method
Member Name: __init__
Qualified Name: fenic.core.types.extract_schema.ExtractSchemaList.__init__
Docstring: Initialize an ExtractSchemaList.
Args:
element_type: The data type of elements in the list. Must be either a primitive
DataType or another ExtractSchema.
Raises:
ValueError: If elem... |
method | __str__ | fenic.core.types.extract_schema.ExtractSchemaList.__str__ | Return a string representation of the ExtractSchemaList.
Returns:
A string in the format "ExtractSchemaList(element_type)". | null | true | false | 43 | 49 | null | str | null | [
"self"
] | null | ExtractSchemaList | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.extract_schema.ExtractSchemaList.__str__
Docstring: Return a string representation of the ExtractSchemaList.
Returns:
A string in the format "ExtractSchemaList(element_type)".
Value: none
Annotation: none
is Public? : true
is Private? : false
Param... |
class | ExtractSchemaField | fenic.core.types.extract_schema.ExtractSchemaField | Represents a field within an structured extraction schema.
An extract schema field has a name, a data type, and a required description that explains
what information should be extracted into this field. | null | true | false | 52 | 100 | null | null | null | null | [] | null | Type: class
Member Name: ExtractSchemaField
Qualified Name: fenic.core.types.extract_schema.ExtractSchemaField
Docstring: Represents a field within an structured extraction schema.
An extract schema field has a name, a data type, and a required description that explains
what information should be extracted into this f... |
method | __init__ | fenic.core.types.extract_schema.ExtractSchemaField.__init__ | Initialize an ExtractSchemaField.
Args:
name: The name of the field.
data_type: The data type of the field. Must be either a primitive DataType,
ExtractSchemaList, or ExtractSchema.
description: A description of what information should be extracted into this field.
Raises:
ValueError: If data_... | null | true | false | 64 | 90 | null | null | null | [
"self",
"name",
"data_type",
"description"
] | null | ExtractSchemaField | Type: method
Member Name: __init__
Qualified Name: fenic.core.types.extract_schema.ExtractSchemaField.__init__
Docstring: Initialize an ExtractSchemaField.
Args:
name: The name of the field.
data_type: The data type of the field. Must be either a primitive DataType,
ExtractSchemaList, or ExtractSchema.... |
method | __str__ | fenic.core.types.extract_schema.ExtractSchemaField.__str__ | Return a string representation of the ExtractSchemaField.
Returns:
A string in the format "ExtractSchemaField(name, data_type, description)". | null | true | false | 92 | 100 | null | str | null | [
"self"
] | null | ExtractSchemaField | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.extract_schema.ExtractSchemaField.__str__
Docstring: Return a string representation of the ExtractSchemaField.
Returns:
A string in the format "ExtractSchemaField(name, data_type, description)".
Value: none
Annotation: none
is Public? : true
is Pri... |
class | ExtractSchema | fenic.core.types.extract_schema.ExtractSchema | Represents a structured extraction schema.
An extract schema contains a collection of named fields with descriptions that define
what information should be extracted into each field. | null | true | false | 103 | 129 | null | null | null | null | [] | null | Type: class
Member Name: ExtractSchema
Qualified Name: fenic.core.types.extract_schema.ExtractSchema
Docstring: Represents a structured extraction schema.
An extract schema contains a collection of named fields with descriptions that define
what information should be extracted into each field.
Value: none
Annotation: ... |
method | __str__ | fenic.core.types.extract_schema.ExtractSchema.__str__ | Return a string representation of the ExtractSchema.
Returns:
A string containing a comma-separated list of field representations. | null | true | false | 113 | 121 | null | str | null | [
"self"
] | null | ExtractSchema | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.extract_schema.ExtractSchema.__str__
Docstring: Return a string representation of the ExtractSchema.
Returns:
A string containing a comma-separated list of field representations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Pa... |
method | field_names | fenic.core.types.extract_schema.ExtractSchema.field_names | Get a list of all field names in the schema.
Returns:
A list of strings containing the names of all fields in the schema. | null | true | false | 123 | 129 | null | List[str] | null | [
"self"
] | null | ExtractSchema | Type: method
Member Name: field_names
Qualified Name: fenic.core.types.extract_schema.ExtractSchema.field_names
Docstring: Get a list of all field names in the schema.
Returns:
A list of strings containing the names of all fields in the schema.
Value: none
Annotation: none
is Public? : true
is Private? : false
Par... |
module | datatypes | fenic.core.types.datatypes | Core data type definitions for the DataFrame API.
This module defines the type system used throughout the DataFrame API. It includes:
- Base classes for all data types
- Primitive types (string, integer, float, etc.)
- Composite types (arrays, structs)
- Specialized types (embeddings, markdown, etc.) | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/types/datatypes.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: datatypes
Qualified Name: fenic.core.types.datatypes
Docstring: Core data type definitions for the DataFrame API.
This module defines the type system used throughout the DataFrame API. It includes:
- Base classes for all data types
- Primitive types (string, integer, float, etc.)
- Composite ... |
class | DataType | fenic.core.types.datatypes.DataType | Base class for all data types.
You won't instantiate this class directly. Instead, use one of the
concrete types like `StringType`, `ArrayType`, or `StructType`.
Used for casting, type validation, and schema inference in the DataFrame API. | null | true | false | 19 | 67 | null | null | null | null | [
"ABC"
] | null | Type: class
Member Name: DataType
Qualified Name: fenic.core.types.datatypes.DataType
Docstring: Base class for all data types.
You won't instantiate this class directly. Instead, use one of the
concrete types like `StringType`, `ArrayType`, or `StructType`.
Used for casting, type validation, and schema inference in ... |
method | __str__ | fenic.core.types.datatypes.DataType.__str__ | Return a string representation of the data type.
Returns:
A string describing the data type. | null | true | false | 28 | 35 | null | str | null | [
"self"
] | null | DataType | Type: method
Member Name: __str__
Qualified Name: fenic.core.types.datatypes.DataType.__str__
Docstring: Return a string representation of the data type.
Returns:
A string describing the data type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: Da... |
method | __eq__ | fenic.core.types.datatypes.DataType.__eq__ | Compare this data type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the objects are equal, False otherwise. | null | true | false | 37 | 47 | null | bool | null | [
"self",
"other"
] | null | DataType | Type: method
Member Name: __eq__
Qualified Name: fenic.core.types.datatypes.DataType.__eq__
Docstring: Compare this data type with another object for equality.
Args:
other: The object to compare with.
Returns:
True if the objects are equal, False otherwise.
Value: none
Annotation: none
is Public? : true
is Pr... |
method | __ne__ | fenic.core.types.datatypes.DataType.__ne__ | Compare this data type with another object for inequality.
Args:
other: The object to compare with.
Returns:
True if the objects are not equal, False otherwise. | null | true | false | 49 | 58 | null | bool | null | [
"self",
"other"
] | null | DataType | Type: method
Member Name: __ne__
Qualified Name: fenic.core.types.datatypes.DataType.__ne__
Docstring: Compare this data type with another object for inequality.
Args:
other: The object to compare with.
Returns:
True if the objects are not equal, False otherwise.
Value: none
Annotation: none
is Public? : true... |
method | __hash__ | fenic.core.types.datatypes.DataType.__hash__ | Return a hash value for this data type.
Returns:
An integer hash value. | null | true | false | 60 | 67 | null | null | null | [
"self"
] | null | DataType | Type: method
Member Name: __hash__
Qualified Name: fenic.core.types.datatypes.DataType.__hash__
Docstring: Return a hash value for this data type.
Returns:
An integer hash value.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: DataType |
class | _PrimitiveType | fenic.core.types.datatypes._PrimitiveType | Marker class for all primitive type. | null | false | true | 70 | 73 | null | null | null | null | [
"DataType"
] | null | Type: class
Member Name: _PrimitiveType
Qualified Name: fenic.core.types.datatypes._PrimitiveType
Docstring: Marker class for all primitive type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
class | _StringBackedType | fenic.core.types.datatypes._StringBackedType | Marker class for all string-backed logical types. | null | false | true | 76 | 79 | null | null | null | null | [
"DataType"
] | null | Type: class
Member Name: _StringBackedType
Qualified Name: fenic.core.types.datatypes._StringBackedType
Docstring: Marker class for all string-backed 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 | 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 | 198 | 232 | 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 | 214 | 220 | 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 | 222 | 232 | 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 | 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: 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 | 247 | 253 | 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 | 255 | 269 | 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 | 272 | 310 | 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 | 290 | 296 | 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 | 298 | 310 | 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 | 313 | 354 | null | null | null | null | [
"DataType"
] | 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 | 330 | 338 | 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 | 340 | 354 | 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 | 360 | 381 | null | null | null | null | [
"_StringBackedType"
] | 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 | 364 | 370 | 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 | 372 | 381 | 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 | 384 | 405 | null | null | null | null | [
"_StringBackedType"
] | 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 | 388 | 394 | 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 | 396 | 405 | 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 | 408 | 429 | null | null | null | null | [
"_StringBackedType"
] | 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 | 412 | 418 | 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 | 420 | 429 | 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 | 432 | 456 | null | null | null | null | [
"_StringBackedType"
] | 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 | 438 | 444 | 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 | 446 | 456 | 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 | 459 | 483 | null | null | null | null | [
"_StringBackedType"
] | 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 | 465 | 471 | 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 | 473 | 483 | 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 | true | false | 486 | 488 | 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? : true
is Private? : false
Parameters: ["dtype"]
Returns: bool
Parent Class: none |
attribute | StringType | fenic.core.types.datatypes.StringType | Represents a UTF-8 encoded string value. | null | true | false | 492 | 492 | 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 | 495 | 495 | 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 | 498 | 498 | 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 | 501 | 501 | 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 | 504 | 504 | 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 | MarkdownType | fenic.core.types.datatypes.MarkdownType | Represents a string containing Markdown-formatted text. | null | true | false | 507 | 507 | 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 | 510 | 510 | 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 | 513 | 513 | 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.0.0-y6d85svd/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 | 26 | 26 | 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 |
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 used in a semantic.map operation. | null | true | false | 29 | 37 | 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 used in a semantic.map operation.
Value: none
Annotation: no... |
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 | 40 | 48 | 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 | 51 | 59 | 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... |
class | JoinExample | fenic.core.types.semantic_examples.JoinExample | A single semantic example for semantic join operations.
Join examples demonstrate the evaluation of two input strings across different
datasets against a specific condition, used in a semantic.join operation. | null | true | false | 62 | 71 | 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 strings across different
datasets against a specific condition, used in a semantic.join operation.... |
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 | 73 | 184 | 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 | 90 | 106 | 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 | 108 | 124 | 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 | 126 | 142 | 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 | 144 | 147 | 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[... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.