Dataset Viewer
Auto-converted to Parquet Duplicate
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
module
fenic
fenic
Fenic is an opinionated, PySpark-inspired DataFrame framework for building production AI and agentic applications.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/__init__.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: fenic Qualified Name: fenic Docstring: Fenic is an opinionated, PySpark-inspired DataFrame framework for building production AI and agentic applications. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
__all__
fenic.__all__
null
null
false
false
88
183
null
null
['Session', 'SessionConfig', 'OpenAIModelConfig', 'AnthropicModelConfig', 'GoogleGLAModelConfig', 'SemanticConfig', 'DataFrameReader', 'DataFrameWriter', 'DataFrame', 'GroupedData', 'SemanticExtensions', 'Column', 'ColumnOrName', 'Catalog', 'ArrayType', 'BooleanType', 'ColumnField', 'DataType', 'DocumentPathType', 'DoubleType', 'EmbeddingType', 'ExtractSchema', 'ExtractSchemaField', 'ExtractSchemaList', 'FloatType', 'HtmlType', 'IntegerType', 'JsonType', 'MapExample', 'MapExampleCollection', 'MarkdownType', 'PredicateExample', 'PredicateExampleCollection', 'Schema', 'ClassifyExample', 'ClassifyExampleCollection', 'JoinExample', 'JoinExampleCollection', 'Schema', 'SemanticSimilarityMetric', 'StringType', 'StructField', 'StructType', 'TranscriptType', 'semantic', 'text', 'json', 'markdown', 'embedding', 'array', 'array_agg', 'array_contains', 'array_size', 'asc', 'asc_nulls_first', 'asc_nulls_last', 'avg', 'coalesce', 'collect_list', 'count', 'desc', 'desc_nulls_first', 'desc_nulls_last', 'max', 'mean', 'min', 'struct', 'sum', 'udf', 'when', 'col', 'lit', 'Lineage', 'QueryMetrics', 'LMMetrics', 'RMMetrics', 'OperatorMetrics', 'InvalidExampleCollectionError', 'configure_logging', 'DataLike', 'DataLikeType', 'QueryResult']
null
null
null
Type: attribute Member Name: __all__ Qualified Name: fenic.__all__ Docstring: none Value: ['Session', 'SessionConfig', 'OpenAIModelConfig', 'AnthropicModelConfig', 'GoogleGLAModelConfig', 'SemanticConfig', 'DataFrameReader', 'DataFrameWriter', 'DataFrame', 'GroupedData', 'SemanticExtensions', 'Column', 'ColumnOrName', 'Catalog', 'ArrayType', 'BooleanType', 'ColumnField', 'DataType', 'DocumentPathType', 'DoubleType', 'EmbeddingType', 'ExtractSchema', 'ExtractSchemaField', 'ExtractSchemaList', 'FloatType', 'HtmlType', 'IntegerType', 'JsonType', 'MapExample', 'MapExampleCollection', 'MarkdownType', 'PredicateExample', 'PredicateExampleCollection', 'Schema', 'ClassifyExample', 'ClassifyExampleCollection', 'JoinExample', 'JoinExampleCollection', 'Schema', 'SemanticSimilarityMetric', 'StringType', 'StructField', 'StructType', 'TranscriptType', 'semantic', 'text', 'json', 'markdown', 'embedding', 'array', 'array_agg', 'array_contains', 'array_size', 'asc', 'asc_nulls_first', 'asc_nulls_last', 'avg', 'coalesce', 'collect_list', 'count', 'desc', 'desc_nulls_first', 'desc_nulls_last', 'max', 'mean', 'min', 'struct', 'sum', 'udf', 'when', 'col', 'lit', 'Lineage', 'QueryMetrics', 'LMMetrics', 'RMMetrics', 'OperatorMetrics', 'InvalidExampleCollectionError', 'configure_logging', 'DataLike', 'DataLikeType', 'QueryResult'] Annotation: none is Public? : false is Private? : false Parameters: none Returns: none Parent Class: none
module
_constants
fenic._constants
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/_constants.py
false
true
null
null
null
null
null
null
null
null
Type: module Member Name: _constants Qualified Name: fenic._constants Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: none Returns: none Parent Class: none
attribute
EXAMPLE_INPUT_KEY
fenic._constants.EXAMPLE_INPUT_KEY
null
null
true
false
4
4
null
null
'input'
null
null
null
Type: attribute Member Name: EXAMPLE_INPUT_KEY Qualified Name: fenic._constants.EXAMPLE_INPUT_KEY Docstring: none Value: 'input' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
EXAMPLE_OUTPUT_KEY
fenic._constants.EXAMPLE_OUTPUT_KEY
null
null
true
false
5
5
null
null
'output'
null
null
null
Type: attribute Member Name: EXAMPLE_OUTPUT_KEY Qualified Name: fenic._constants.EXAMPLE_OUTPUT_KEY Docstring: none Value: 'output' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
EXAMPLE_LEFT_KEY
fenic._constants.EXAMPLE_LEFT_KEY
null
null
true
false
6
6
null
null
'left'
null
null
null
Type: attribute Member Name: EXAMPLE_LEFT_KEY Qualified Name: fenic._constants.EXAMPLE_LEFT_KEY Docstring: none Value: 'left' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
EXAMPLE_RIGHT_KEY
fenic._constants.EXAMPLE_RIGHT_KEY
null
null
true
false
7
7
null
null
'right'
null
null
null
Type: attribute Member Name: EXAMPLE_RIGHT_KEY Qualified Name: fenic._constants.EXAMPLE_RIGHT_KEY Docstring: none Value: 'right' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
INDEX_DIR
fenic._constants.INDEX_DIR
null
null
true
false
10
10
null
null
'indexes'
null
null
null
Type: attribute Member Name: INDEX_DIR Qualified Name: fenic._constants.INDEX_DIR Docstring: none Value: 'indexes' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
VECTOR_INDEX_DIR
fenic._constants.VECTOR_INDEX_DIR
null
null
true
false
11
11
null
null
f'{INDEX_DIR}/vector'
null
null
null
Type: attribute Member Name: VECTOR_INDEX_DIR Qualified Name: fenic._constants.VECTOR_INDEX_DIR Docstring: none Value: f'{INDEX_DIR}/vector' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
TOKEN_OVERHEAD_JSON
fenic._constants.TOKEN_OVERHEAD_JSON
null
null
true
false
14
14
null
null
5
null
null
null
Type: attribute Member Name: TOKEN_OVERHEAD_JSON Qualified Name: fenic._constants.TOKEN_OVERHEAD_JSON Docstring: none Value: 5 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
TOKEN_OVERHEAD_MISC
fenic._constants.TOKEN_OVERHEAD_MISC
null
null
true
false
15
15
null
null
5
null
null
null
Type: attribute Member Name: TOKEN_OVERHEAD_MISC Qualified Name: fenic._constants.TOKEN_OVERHEAD_MISC Docstring: none Value: 5 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
PREFIX_TOKENS_PER_MESSAGE
fenic._constants.PREFIX_TOKENS_PER_MESSAGE
null
null
true
false
16
16
null
null
4
null
null
null
Type: attribute Member Name: PREFIX_TOKENS_PER_MESSAGE Qualified Name: fenic._constants.PREFIX_TOKENS_PER_MESSAGE Docstring: none Value: 4 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
TOKENS_PER_NAME
fenic._constants.TOKENS_PER_NAME
null
null
true
false
17
17
null
null
1
null
null
null
Type: attribute Member Name: TOKENS_PER_NAME Qualified Name: fenic._constants.TOKENS_PER_NAME Docstring: none Value: 1 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
DEFAULT_MAX_TOKENS
fenic._constants.DEFAULT_MAX_TOKENS
null
null
true
false
20
20
null
null
512
null
null
null
Type: attribute Member Name: DEFAULT_MAX_TOKENS Qualified Name: fenic._constants.DEFAULT_MAX_TOKENS Docstring: none Value: 512 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
DEFAULT_TEMPERATURE
fenic._constants.DEFAULT_TEMPERATURE
null
null
true
false
21
21
float
null
0
null
null
null
Type: attribute Member Name: DEFAULT_TEMPERATURE Qualified Name: fenic._constants.DEFAULT_TEMPERATURE Docstring: none Value: 0 Annotation: float is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
MAX_TOKENS_DETERMINISTIC_OUTPUT_SIZE
fenic._constants.MAX_TOKENS_DETERMINISTIC_OUTPUT_SIZE
null
null
true
false
26
26
null
null
64
null
null
null
Type: attribute Member Name: MAX_TOKENS_DETERMINISTIC_OUTPUT_SIZE Qualified Name: fenic._constants.MAX_TOKENS_DETERMINISTIC_OUTPUT_SIZE Docstring: none Value: 64 Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
API_KEY_SUFFIX
fenic._constants.API_KEY_SUFFIX
null
null
true
false
28
28
null
null
'_API_KEY'
null
null
null
Type: attribute Member Name: API_KEY_SUFFIX Qualified Name: fenic._constants.API_KEY_SUFFIX Docstring: none Value: '_API_KEY' Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
SQL_PLACEHOLDER_RE
fenic._constants.SQL_PLACEHOLDER_RE
null
null
true
false
30
30
null
null
re.compile('\\{(\\w+)\\}')
null
null
null
Type: attribute Member Name: SQL_PLACEHOLDER_RE Qualified Name: fenic._constants.SQL_PLACEHOLDER_RE Docstring: none Value: re.compile('\\{(\\w+)\\}') Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
module
logging
fenic.logging
Logging configuration utilities for Fenic.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/logging.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: logging Qualified Name: fenic.logging Docstring: Logging configuration utilities for Fenic. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
function
configure_logging
fenic.logging.configure_logging
Configure logging for the library and root logger in interactive environments. This function ensures that logs from the library's modules appear in output by setting up a default handler on the root logger *only if* one does not already exist. This is especially useful in notebooks, scripts, or REPLs where logging is often unset. It configures the root logger and sets the library's top-level logger to propagate logs to the root. If the root logger has no handlers, this function sets up a default configuration and silences noisy dependencies like 'openai' and 'httpx'. In more complex applications or when integrating with existing logging configurations, you might prefer to manage logging setup externally. In such cases, you may not need to call this function.
null
true
false
8
48
null
None
null
[ "log_level", "log_format", "log_stream" ]
null
null
Type: function Member Name: configure_logging Qualified Name: fenic.logging.configure_logging Docstring: Configure logging for the library and root logger in interactive environments. This function ensures that logs from the library's modules appear in output by setting up a default handler on the root logger *only if* one does not already exist. This is especially useful in notebooks, scripts, or REPLs where logging is often unset. It configures the root logger and sets the library's top-level logger to propagate logs to the root. If the root logger has no handlers, this function sets up a default configuration and silences noisy dependencies like 'openai' and 'httpx'. In more complex applications or when integrating with existing logging configurations, you might prefer to manage logging setup externally. In such cases, you may not need to call this function. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["log_level", "log_format", "log_stream"] Returns: None Parent Class: none
module
core
fenic.core
Core module for Fenic.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/__init__.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: core Qualified Name: fenic.core Docstring: Core module for Fenic. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
attribute
__all__
fenic.core.__all__
null
null
false
false
45
86
null
null
['ArrayType', 'BooleanType', 'BranchSide', 'DataType', 'DocumentPathType', 'DoubleType', 'EmbeddingType', 'FloatType', 'HtmlType', 'IntegerType', 'JsonType', 'MarkdownType', 'StringType', 'StructField', 'StructType', 'TranscriptType', 'ExtractSchema', 'ExtractSchemaField', 'ExtractSchemaList', 'ColumnField', 'Schema', 'ClassifyExample', 'ClassifyExampleCollection', 'JoinExample', 'JoinExampleCollection', 'MapExample', 'MapExampleCollection', 'PredicateExample', 'PredicateExampleCollection', 'SemanticSimilarityMetric', 'QueryMetrics', 'LMMetrics', 'RMMetrics', 'OperatorMetrics', 'DataLike', 'DataLikeType', 'QueryResult']
null
null
null
Type: attribute Member Name: __all__ Qualified Name: fenic.core.__all__ Docstring: none Value: ['ArrayType', 'BooleanType', 'BranchSide', 'DataType', 'DocumentPathType', 'DoubleType', 'EmbeddingType', 'FloatType', 'HtmlType', 'IntegerType', 'JsonType', 'MarkdownType', 'StringType', 'StructField', 'StructType', 'TranscriptType', 'ExtractSchema', 'ExtractSchemaField', 'ExtractSchemaList', 'ColumnField', 'Schema', 'ClassifyExample', 'ClassifyExampleCollection', 'JoinExample', 'JoinExampleCollection', 'MapExample', 'MapExampleCollection', 'PredicateExample', 'PredicateExampleCollection', 'SemanticSimilarityMetric', 'QueryMetrics', 'LMMetrics', 'RMMetrics', 'OperatorMetrics', 'DataLike', 'DataLikeType', 'QueryResult'] Annotation: none is Public? : false is Private? : false Parameters: none Returns: none Parent Class: none
module
metrics
fenic.core.metrics
Metrics tracking for query execution and model usage. This module defines classes for tracking various metrics during query execution, including language model usage, embedding model usage, operator performance, and overall query statistics.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/metrics.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: metrics Qualified Name: fenic.core.metrics Docstring: Metrics tracking for query execution and model usage. This module defines classes for tracking various metrics during query execution, including language model usage, embedding model usage, operator performance, and overall query statistics. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
LMMetrics
fenic.core.metrics.LMMetrics
Tracks language model usage metrics including token counts and costs. Attributes: num_uncached_input_tokens: Number of uncached tokens in the prompt/input num_cached_input_tokens: Number of cached tokens in the prompt/input, num_output_tokens: Number of tokens in the completion/output cost: Total cost in USD for the LM API call
null
true
false
12
45
null
null
null
null
[]
null
Type: class Member Name: LMMetrics Qualified Name: fenic.core.metrics.LMMetrics Docstring: Tracks language model usage metrics including token counts and costs. Attributes: num_uncached_input_tokens: Number of uncached tokens in the prompt/input num_cached_input_tokens: Number of cached tokens in the prompt/input, num_output_tokens: Number of tokens in the completion/output cost: Total cost in USD for the LM API call Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__add__
fenic.core.metrics.LMMetrics.__add__
Add two LMMetrics instances together. Args: other: Another LMMetrics instance to add. Returns: A new LMMetrics instance with combined metrics.
null
true
false
29
45
null
LMMetrics
null
[ "self", "other" ]
null
LMMetrics
Type: method Member Name: __add__ Qualified Name: fenic.core.metrics.LMMetrics.__add__ Docstring: Add two LMMetrics instances together. Args: other: Another LMMetrics instance to add. Returns: A new LMMetrics instance with combined metrics. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "other"] Returns: LMMetrics Parent Class: LMMetrics
method
__init__
fenic.core.metrics.LMMetrics.__init__
null
null
true
false
0
0
null
None
null
[ "self", "num_uncached_input_tokens", "num_cached_input_tokens", "num_output_tokens", "cost", "num_requests" ]
null
LMMetrics
Type: method Member Name: __init__ Qualified Name: fenic.core.metrics.LMMetrics.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "num_uncached_input_tokens", "num_cached_input_tokens", "num_output_tokens", "cost", "num_requests"] Returns: None Parent Class: LMMetrics
class
RMMetrics
fenic.core.metrics.RMMetrics
Tracks embedding model usage metrics including token counts and costs. Attributes: num_input_tokens: Number of tokens to embed cost: Total cost in USD to embed the tokens
null
true
false
48
74
null
null
null
null
[]
null
Type: class Member Name: RMMetrics Qualified Name: fenic.core.metrics.RMMetrics Docstring: Tracks embedding model usage metrics including token counts and costs. Attributes: num_input_tokens: Number of tokens to embed cost: Total cost in USD to embed the tokens Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__add__
fenic.core.metrics.RMMetrics.__add__
Add two RMMetrics instances together. Args: other: Another RMMetrics instance to add. Returns: A new RMMetrics instance with combined metrics.
null
true
false
61
74
null
RMMetrics
null
[ "self", "other" ]
null
RMMetrics
Type: method Member Name: __add__ Qualified Name: fenic.core.metrics.RMMetrics.__add__ Docstring: Add two RMMetrics instances together. Args: other: Another RMMetrics instance to add. Returns: A new RMMetrics instance with combined metrics. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "other"] Returns: RMMetrics Parent Class: RMMetrics
method
__init__
fenic.core.metrics.RMMetrics.__init__
null
null
true
false
0
0
null
None
null
[ "self", "num_input_tokens", "num_requests", "cost" ]
null
RMMetrics
Type: method Member Name: __init__ Qualified Name: fenic.core.metrics.RMMetrics.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "num_input_tokens", "num_requests", "cost"] Returns: None Parent Class: RMMetrics
class
OperatorMetrics
fenic.core.metrics.OperatorMetrics
Metrics for a single operator in the query execution plan. Attributes: operator_id: Unique identifier for the operator num_output_rows: Number of rows output by this operator execution_time_ms: Execution time in milliseconds lm_metrics: Language model usage metrics for this operator is_cache_hit: Whether results were retrieved from cache
null
true
false
77
94
null
null
null
null
[]
null
Type: class Member Name: OperatorMetrics Qualified Name: fenic.core.metrics.OperatorMetrics Docstring: Metrics for a single operator in the query execution plan. Attributes: operator_id: Unique identifier for the operator num_output_rows: Number of rows output by this operator execution_time_ms: Execution time in milliseconds lm_metrics: Language model usage metrics for this operator is_cache_hit: Whether results were retrieved from cache Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.metrics.OperatorMetrics.__init__
null
null
true
false
0
0
null
None
null
[ "self", "operator_id", "num_output_rows", "execution_time_ms", "lm_metrics", "rm_metrics", "is_cache_hit" ]
null
OperatorMetrics
Type: method Member Name: __init__ Qualified Name: fenic.core.metrics.OperatorMetrics.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "operator_id", "num_output_rows", "execution_time_ms", "lm_metrics", "rm_metrics", "is_cache_hit"] Returns: None Parent Class: OperatorMetrics
class
PhysicalPlanRepr
fenic.core.metrics.PhysicalPlanRepr
Tree node representing the physical execution plan, used for pretty printing execution plan.
null
true
false
97
102
null
null
null
null
[]
null
Type: class Member Name: PhysicalPlanRepr Qualified Name: fenic.core.metrics.PhysicalPlanRepr Docstring: Tree node representing the physical execution plan, used for pretty printing execution plan. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.metrics.PhysicalPlanRepr.__init__
null
null
true
false
0
0
null
None
null
[ "self", "operator_id", "children" ]
null
PhysicalPlanRepr
Type: method Member Name: __init__ Qualified Name: fenic.core.metrics.PhysicalPlanRepr.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "operator_id", "children"] Returns: None Parent Class: PhysicalPlanRepr
class
QueryMetrics
fenic.core.metrics.QueryMetrics
Comprehensive metrics for an executed query. Includes overall statistics and detailed metrics for each operator in the execution plan. Attributes: execution_time_ms: Total query execution time in milliseconds num_output_rows: Total number of rows returned by the query total_lm_metrics: Aggregated language model metrics across all operators
null
true
false
105
202
null
null
null
null
[]
null
Type: class Member Name: QueryMetrics Qualified Name: fenic.core.metrics.QueryMetrics Docstring: Comprehensive metrics for an executed query. Includes overall statistics and detailed metrics for each operator in the execution plan. Attributes: execution_time_ms: Total query execution time in milliseconds num_output_rows: Total number of rows returned by the query total_lm_metrics: Aggregated language model metrics across all operators Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
get_summary
fenic.core.metrics.QueryMetrics.get_summary
Summarize the query metrics in a single line. Returns: str: A concise summary of execution time, row count, and LM cost.
null
true
false
127
138
null
str
null
[ "self" ]
null
QueryMetrics
Type: method Member Name: get_summary Qualified Name: fenic.core.metrics.QueryMetrics.get_summary Docstring: Summarize the query metrics in a single line. Returns: str: A concise summary of execution time, row count, and LM cost. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: QueryMetrics
method
get_execution_plan_details
fenic.core.metrics.QueryMetrics.get_execution_plan_details
Generate a formatted execution plan with detailed metrics. Produces a hierarchical representation of the query execution plan, including performance metrics and language model usage for each operator. Returns: str: A formatted string showing the execution plan with metrics.
null
true
false
140
182
null
str
null
[ "self" ]
null
QueryMetrics
Type: method Member Name: get_execution_plan_details Qualified Name: fenic.core.metrics.QueryMetrics.get_execution_plan_details Docstring: Generate a formatted execution plan with detailed metrics. Produces a hierarchical representation of the query execution plan, including performance metrics and language model usage for each operator. Returns: str: A formatted string showing the execution plan with metrics. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: QueryMetrics
method
__str__
fenic.core.metrics.QueryMetrics.__str__
Generate a detailed string representation of the query metrics. Returns: str: A multi-line string containing execution time, row counts, language model and embedding model costs and token usage, and the execution plan details.
null
true
false
184
202
null
str
null
[ "self" ]
null
QueryMetrics
Type: method Member Name: __str__ Qualified Name: fenic.core.metrics.QueryMetrics.__str__ Docstring: Generate a detailed string representation of the query metrics. Returns: str: A multi-line string containing execution time, row counts, language model and embedding model costs and token usage, and the execution plan details. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self"] Returns: str Parent Class: QueryMetrics
method
__init__
fenic.core.metrics.QueryMetrics.__init__
null
null
true
false
0
0
null
None
null
[ "self", "execution_time_ms", "num_output_rows", "total_lm_metrics", "total_rm_metrics", "_operator_metrics", "_plan_repr" ]
null
QueryMetrics
Type: method Member Name: __init__ Qualified Name: fenic.core.metrics.QueryMetrics.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "execution_time_ms", "num_output_rows", "total_lm_metrics", "total_rm_metrics", "_operator_metrics", "_plan_repr"] Returns: None Parent Class: QueryMetrics
module
error
fenic.core.error
Fenic error hierarchy.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/error.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: error Qualified Name: fenic.core.error Docstring: Fenic error hierarchy. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
FenicError
fenic.core.error.FenicError
Base exception for all fenic errors.
null
true
false
12
15
null
null
null
null
[ "Exception" ]
null
Type: class Member Name: FenicError Qualified Name: fenic.core.error.FenicError Docstring: Base exception for all fenic errors. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
ConfigurationError
fenic.core.error.ConfigurationError
Errors during session configuration or initialization.
null
true
false
19
22
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: ConfigurationError Qualified Name: fenic.core.error.ConfigurationError Docstring: Errors during session configuration or initialization. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
SessionError
fenic.core.error.SessionError
Session lifecycle errors.
null
true
false
25
28
null
null
null
null
[ "ConfigurationError" ]
null
Type: class Member Name: SessionError Qualified Name: fenic.core.error.SessionError Docstring: Session lifecycle errors. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
CloudSessionError
fenic.core.error.CloudSessionError
Cloud session lifecycle errors.
null
true
false
31
42
null
null
null
null
[ "SessionError" ]
null
Type: class Member Name: CloudSessionError Qualified Name: fenic.core.error.CloudSessionError Docstring: Cloud session lifecycle errors. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.CloudSessionError.__init__
Initialize a cloud session error. Args: error_message: The error message describing what went wrong.
null
true
false
34
42
null
null
null
[ "self", "error_message" ]
null
CloudSessionError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.CloudSessionError.__init__ Docstring: Initialize a cloud session error. Args: error_message: The error message describing what went wrong. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "error_message"] Returns: none Parent Class: CloudSessionError
class
ValidationError
fenic.core.error.ValidationError
Invalid usage of public APIs or incorrect arguments.
null
true
false
46
49
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: ValidationError Qualified Name: fenic.core.error.ValidationError Docstring: Invalid usage of public APIs or incorrect arguments. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
InvalidExampleCollectionError
fenic.core.error.InvalidExampleCollectionError
Exception raised when a semantic example collection is invalid.
null
true
false
52
55
null
null
null
null
[ "ValidationError" ]
null
Type: class Member Name: InvalidExampleCollectionError Qualified Name: fenic.core.error.InvalidExampleCollectionError Docstring: Exception raised when a semantic example collection is invalid. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
PlanError
fenic.core.error.PlanError
Errors during logical plan construction and validation.
null
true
false
59
62
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: PlanError Qualified Name: fenic.core.error.PlanError Docstring: Errors during logical plan construction and validation. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
ColumnNotFoundError
fenic.core.error.ColumnNotFoundError
Column doesn't exist.
null
true
false
65
78
null
null
null
null
[ "PlanError" ]
null
Type: class Member Name: ColumnNotFoundError Qualified Name: fenic.core.error.ColumnNotFoundError Docstring: Column doesn't exist. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.ColumnNotFoundError.__init__
Initialize a column not found error. Args: column_name: The name of the column that was not found. available_columns: List of column names that are available.
null
true
false
68
78
null
null
null
[ "self", "column_name", "available_columns" ]
null
ColumnNotFoundError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.ColumnNotFoundError.__init__ Docstring: Initialize a column not found error. Args: column_name: The name of the column that was not found. available_columns: List of column names that are available. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "column_name", "available_columns"] Returns: none Parent Class: ColumnNotFoundError
class
TypeMismatchError
fenic.core.error.TypeMismatchError
Type validation errors.
null
true
false
81
106
null
null
null
null
[ "PlanError" ]
null
Type: class Member Name: TypeMismatchError Qualified Name: fenic.core.error.TypeMismatchError Docstring: Type validation errors. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.TypeMismatchError.__init__
Initialize a type mismatch error. Args: expected: The expected data type. actual: The actual data type that was found. context: Additional context about where the type mismatch occurred.
null
true
false
84
92
null
null
null
[ "self", "expected", "actual", "context" ]
null
TypeMismatchError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.TypeMismatchError.__init__ Docstring: Initialize a type mismatch error. Args: expected: The expected data type. actual: The actual data type that was found. context: Additional context about where the type mismatch occurred. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "expected", "actual", "context"] Returns: none Parent Class: TypeMismatchError
method
from_message
fenic.core.error.TypeMismatchError.from_message
Create a TypeMismatchError from a message string. Args: msg: The error message. Returns: A new TypeMismatchError instance with the given message.
null
true
false
94
106
null
TypeMismatchError
null
[ "cls", "msg" ]
null
TypeMismatchError
Type: method Member Name: from_message Qualified Name: fenic.core.error.TypeMismatchError.from_message Docstring: Create a TypeMismatchError from a message string. Args: msg: The error message. Returns: A new TypeMismatchError instance with the given message. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["cls", "msg"] Returns: TypeMismatchError Parent Class: TypeMismatchError
class
CatalogError
fenic.core.error.CatalogError
Catalog and table management errors.
null
true
false
110
113
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: CatalogError Qualified Name: fenic.core.error.CatalogError Docstring: Catalog and table management errors. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
CatalogNotFoundError
fenic.core.error.CatalogNotFoundError
Catalog doesn't exist.
null
true
false
116
125
null
null
null
null
[ "CatalogError" ]
null
Type: class Member Name: CatalogNotFoundError Qualified Name: fenic.core.error.CatalogNotFoundError Docstring: Catalog doesn't exist. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.CatalogNotFoundError.__init__
Initialize a catalog not found error. Args: catalog_name: The name of the catalog that was not found.
null
true
false
119
125
null
null
null
[ "self", "catalog_name" ]
null
CatalogNotFoundError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.CatalogNotFoundError.__init__ Docstring: Initialize a catalog not found error. Args: catalog_name: The name of the catalog that was not found. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "catalog_name"] Returns: none Parent Class: CatalogNotFoundError
class
CatalogAlreadyExistsError
fenic.core.error.CatalogAlreadyExistsError
Catalog already exists.
null
true
false
128
137
null
null
null
null
[ "CatalogError" ]
null
Type: class Member Name: CatalogAlreadyExistsError Qualified Name: fenic.core.error.CatalogAlreadyExistsError Docstring: Catalog already exists. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.CatalogAlreadyExistsError.__init__
Initialize a catalog already exists error. Args: catalog_name: The name of the catalog that already exists.
null
true
false
131
137
null
null
null
[ "self", "catalog_name" ]
null
CatalogAlreadyExistsError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.CatalogAlreadyExistsError.__init__ Docstring: Initialize a catalog already exists error. Args: catalog_name: The name of the catalog that already exists. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "catalog_name"] Returns: none Parent Class: CatalogAlreadyExistsError
class
TableNotFoundError
fenic.core.error.TableNotFoundError
Table doesn't exist.
null
true
false
140
152
null
null
null
null
[ "CatalogError" ]
null
Type: class Member Name: TableNotFoundError Qualified Name: fenic.core.error.TableNotFoundError Docstring: Table doesn't exist. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.TableNotFoundError.__init__
Initialize a table not found error. Args: table_name: The name of the table that was not found. database: The name of the database containing the table.
null
true
false
143
152
null
null
null
[ "self", "table_name", "database" ]
null
TableNotFoundError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.TableNotFoundError.__init__ Docstring: Initialize a table not found error. Args: table_name: The name of the table that was not found. database: The name of the database containing the table. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "table_name", "database"] Returns: none Parent Class: TableNotFoundError
class
TableAlreadyExistsError
fenic.core.error.TableAlreadyExistsError
Table already exists.
null
true
false
155
172
null
null
null
null
[ "CatalogError" ]
null
Type: class Member Name: TableAlreadyExistsError Qualified Name: fenic.core.error.TableAlreadyExistsError Docstring: Table already exists. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.TableAlreadyExistsError.__init__
Initialize a table already exists error. Args: table_name: The name of the table that already exists. database: Optional name of the database containing the table.
null
true
false
158
172
null
null
null
[ "self", "table_name", "database" ]
null
TableAlreadyExistsError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.TableAlreadyExistsError.__init__ Docstring: Initialize a table already exists error. Args: table_name: The name of the table that already exists. database: Optional name of the database containing the table. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "table_name", "database"] Returns: none Parent Class: TableAlreadyExistsError
class
DatabaseNotFoundError
fenic.core.error.DatabaseNotFoundError
Database doesn't exist.
null
true
false
175
184
null
null
null
null
[ "CatalogError" ]
null
Type: class Member Name: DatabaseNotFoundError Qualified Name: fenic.core.error.DatabaseNotFoundError Docstring: Database doesn't exist. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.DatabaseNotFoundError.__init__
Initialize a database not found error. Args: database_name: The name of the database that was not found.
null
true
false
178
184
null
null
null
[ "self", "database_name" ]
null
DatabaseNotFoundError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.DatabaseNotFoundError.__init__ Docstring: Initialize a database not found error. Args: database_name: The name of the database that was not found. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "database_name"] Returns: none Parent Class: DatabaseNotFoundError
class
DatabaseAlreadyExistsError
fenic.core.error.DatabaseAlreadyExistsError
Database already exists.
null
true
false
187
196
null
null
null
null
[ "CatalogError" ]
null
Type: class Member Name: DatabaseAlreadyExistsError Qualified Name: fenic.core.error.DatabaseAlreadyExistsError Docstring: Database already exists. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.DatabaseAlreadyExistsError.__init__
Initialize a database already exists error. Args: database_name: The name of the database that already exists.
null
true
false
190
196
null
null
null
[ "self", "database_name" ]
null
DatabaseAlreadyExistsError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.DatabaseAlreadyExistsError.__init__ Docstring: Initialize a database already exists error. Args: database_name: The name of the database that already exists. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "database_name"] Returns: none Parent Class: DatabaseAlreadyExistsError
class
ExecutionError
fenic.core.error.ExecutionError
Errors during physical plan execution.
null
true
false
200
203
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: ExecutionError Qualified Name: fenic.core.error.ExecutionError Docstring: Errors during physical plan execution. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
CloudExecutionError
fenic.core.error.CloudExecutionError
Errors during physical plan execution in a cloud session.
null
true
false
206
217
null
null
null
null
[ "ExecutionError" ]
null
Type: class Member Name: CloudExecutionError Qualified Name: fenic.core.error.CloudExecutionError Docstring: Errors during physical plan execution in a cloud session. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core.error.CloudExecutionError.__init__
Initialize a cloud execution error. Args: error_message: The error message describing what went wrong.
null
true
false
209
217
null
null
null
[ "self", "error_message" ]
null
CloudExecutionError
Type: method Member Name: __init__ Qualified Name: fenic.core.error.CloudExecutionError.__init__ Docstring: Initialize a cloud execution error. Args: error_message: The error message describing what went wrong. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "error_message"] Returns: none Parent Class: CloudExecutionError
class
LineageError
fenic.core.error.LineageError
Errors during lineage traversal.
null
true
false
221
224
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: LineageError Qualified Name: fenic.core.error.LineageError Docstring: Errors during lineage traversal. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
InternalError
fenic.core.error.InternalError
Internal invariant violations.
null
true
false
228
231
null
null
null
null
[ "FenicError" ]
null
Type: class Member Name: InternalError Qualified Name: fenic.core.error.InternalError Docstring: Internal invariant violations. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
module
_resolved_session_config
fenic.core._resolved_session_config
Internal configuration classes for resolved session settings. This module defines internal configuration classes that represent the fully resolved state of a session after processing user-provided configuration. These classes are used internally after the user creates a SessionConfig in the API layer.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_resolved_session_config.py
false
true
null
null
null
null
null
null
null
null
Type: module Member Name: _resolved_session_config Qualified Name: fenic.core._resolved_session_config Docstring: Internal configuration classes for resolved session settings. This module defines internal configuration classes that represent the fully resolved state of a session after processing user-provided configuration. These classes are used internally after the user creates a SessionConfig in the API layer. Value: none Annotation: none is Public? : false is Private? : true Parameters: none Returns: none Parent Class: none
attribute
ReasoningEffort
fenic.core._resolved_session_config.ReasoningEffort
null
null
true
false
22
22
null
null
Literal['none', 'low', 'medium', 'high']
null
null
null
Type: attribute Member Name: ReasoningEffort Qualified Name: fenic.core._resolved_session_config.ReasoningEffort Docstring: none Value: Literal['none', 'low', 'medium', 'high'] Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
CloudExecutorSize
fenic.core._resolved_session_config.CloudExecutorSize
null
null
true
false
26
30
null
null
null
null
[ "str", "Enum" ]
null
Type: class Member Name: CloudExecutorSize Qualified Name: fenic.core._resolved_session_config.CloudExecutorSize Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
ResolvedOpenAIModelConfig
fenic.core._resolved_session_config.ResolvedOpenAIModelConfig
null
null
true
false
35
39
null
null
null
null
[]
null
Type: class Member Name: ResolvedOpenAIModelConfig Qualified Name: fenic.core._resolved_session_config.ResolvedOpenAIModelConfig Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._resolved_session_config.ResolvedOpenAIModelConfig.__init__
null
null
true
false
0
0
null
None
null
[ "self", "model_name", "rpm", "tpm" ]
null
ResolvedOpenAIModelConfig
Type: method Member Name: __init__ Qualified Name: fenic.core._resolved_session_config.ResolvedOpenAIModelConfig.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "model_name", "rpm", "tpm"] Returns: None Parent Class: ResolvedOpenAIModelConfig
class
ResolvedAnthropicModelConfig
fenic.core._resolved_session_config.ResolvedAnthropicModelConfig
null
null
true
false
42
47
null
null
null
null
[]
null
Type: class Member Name: ResolvedAnthropicModelConfig Qualified Name: fenic.core._resolved_session_config.ResolvedAnthropicModelConfig Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._resolved_session_config.ResolvedAnthropicModelConfig.__init__
null
null
true
false
0
0
null
None
null
[ "self", "model_name", "rpm", "input_tpm", "output_tpm" ]
null
ResolvedAnthropicModelConfig
Type: method Member Name: __init__ Qualified Name: fenic.core._resolved_session_config.ResolvedAnthropicModelConfig.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "model_name", "rpm", "input_tpm", "output_tpm"] Returns: None Parent Class: ResolvedAnthropicModelConfig
class
ResolvedGoogleGLAModelConfig
fenic.core._resolved_session_config.ResolvedGoogleGLAModelConfig
null
null
true
false
49
54
null
null
null
null
[]
null
Type: class Member Name: ResolvedGoogleGLAModelConfig Qualified Name: fenic.core._resolved_session_config.ResolvedGoogleGLAModelConfig Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._resolved_session_config.ResolvedGoogleGLAModelConfig.__init__
null
null
true
false
0
0
null
None
null
[ "self", "model_name", "rpm", "tpm", "reasoning_effort" ]
null
ResolvedGoogleGLAModelConfig
Type: method Member Name: __init__ Qualified Name: fenic.core._resolved_session_config.ResolvedGoogleGLAModelConfig.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "model_name", "rpm", "tpm", "reasoning_effort"] Returns: None Parent Class: ResolvedGoogleGLAModelConfig
attribute
ResolvedModelConfig
fenic.core._resolved_session_config.ResolvedModelConfig
null
null
true
false
56
56
null
null
Union[ResolvedOpenAIModelConfig, ResolvedAnthropicModelConfig, ResolvedGoogleGLAModelConfig]
null
null
null
Type: attribute Member Name: ResolvedModelConfig Qualified Name: fenic.core._resolved_session_config.ResolvedModelConfig Docstring: none Value: Union[ResolvedOpenAIModelConfig, ResolvedAnthropicModelConfig, ResolvedGoogleGLAModelConfig] Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
ResolvedSemanticConfig
fenic.core._resolved_session_config.ResolvedSemanticConfig
null
null
true
false
61
66
null
null
null
null
[]
null
Type: class Member Name: ResolvedSemanticConfig Qualified Name: fenic.core._resolved_session_config.ResolvedSemanticConfig Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._resolved_session_config.ResolvedSemanticConfig.__init__
null
null
true
false
0
0
null
None
null
[ "self", "language_models", "default_language_model", "embedding_models", "default_embedding_model" ]
null
ResolvedSemanticConfig
Type: method Member Name: __init__ Qualified Name: fenic.core._resolved_session_config.ResolvedSemanticConfig.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "language_models", "default_language_model", "embedding_models", "default_embedding_model"] Returns: None Parent Class: ResolvedSemanticConfig
class
ResolvedCloudConfig
fenic.core._resolved_session_config.ResolvedCloudConfig
null
null
true
false
69
71
null
null
null
null
[]
null
Type: class Member Name: ResolvedCloudConfig Qualified Name: fenic.core._resolved_session_config.ResolvedCloudConfig Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._resolved_session_config.ResolvedCloudConfig.__init__
null
null
true
false
0
0
null
None
null
[ "self", "size" ]
null
ResolvedCloudConfig
Type: method Member Name: __init__ Qualified Name: fenic.core._resolved_session_config.ResolvedCloudConfig.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "size"] Returns: None Parent Class: ResolvedCloudConfig
class
ResolvedSessionConfig
fenic.core._resolved_session_config.ResolvedSessionConfig
null
null
true
false
74
80
null
null
null
null
[]
null
Type: class Member Name: ResolvedSessionConfig Qualified Name: fenic.core._resolved_session_config.ResolvedSessionConfig Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._resolved_session_config.ResolvedSessionConfig.__init__
null
null
true
false
0
0
null
None
null
[ "self", "app_name", "db_path", "semantic", "cloud" ]
null
ResolvedSessionConfig
Type: method Member Name: __init__ Qualified Name: fenic.core._resolved_session_config.ResolvedSessionConfig.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "app_name", "db_path", "semantic", "cloud"] Returns: None Parent Class: ResolvedSessionConfig
module
_utils
fenic.core._utils
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_utils/__init__.py
false
true
null
null
null
null
null
null
null
null
Type: module Member Name: _utils Qualified Name: fenic.core._utils Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: none Returns: none Parent Class: none
module
misc
fenic.core._utils.misc
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_utils/misc.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: misc Qualified Name: fenic.core._utils.misc Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
function
parse_instruction
fenic.core._utils.misc.parse_instruction
Extract variable names from instruction text that are wrapped in single curly braces. This function uses regex to find all variables in the format {variable_name} that are not escaped by double braces (e.g., {{variable_name}}). Args: text: The instruction text containing variables in curly braces. Returns: A list of variable names found in the instruction text. Example: >>> parse_instruction("Classify the sentiment of {text} from {source}") ['text', 'source'] >>> parse_instruction("Use {{escaped}} and {not_escaped}") ['not_escaped']
null
true
false
5
24
null
list[str]
null
[ "text" ]
null
null
Type: function Member Name: parse_instruction Qualified Name: fenic.core._utils.misc.parse_instruction Docstring: Extract variable names from instruction text that are wrapped in single curly braces. This function uses regex to find all variables in the format {variable_name} that are not escaped by double braces (e.g., {{variable_name}}). Args: text: The instruction text containing variables in curly braces. Returns: A list of variable names found in the instruction text. Example: >>> parse_instruction("Classify the sentiment of {text} from {source}") ['text', 'source'] >>> parse_instruction("Use {{escaped}} and {not_escaped}") ['not_escaped'] Value: none Annotation: none is Public? : true is Private? : false Parameters: ["text"] Returns: list[str] Parent Class: none
function
get_content_hash
fenic.core._utils.misc.get_content_hash
Generate a short, consistent hash for a string. This uses UUIDv5 (namespaced UUID) to generate a deterministic hash of the content string, and returns the first 8 characters for brevity. Args: content: The input string to hash. Returns: A short string representing the hash of the input. Example: >>> get_content_hash("hello") 'aaf4c61d' # (your output will vary depending on namespace and content)
null
true
false
27
43
null
str
null
[ "content" ]
null
null
Type: function Member Name: get_content_hash Qualified Name: fenic.core._utils.misc.get_content_hash Docstring: Generate a short, consistent hash for a string. This uses UUIDv5 (namespaced UUID) to generate a deterministic hash of the content string, and returns the first 8 characters for brevity. Args: content: The input string to hash. Returns: A short string representing the hash of the input. Example: >>> get_content_hash("hello") 'aaf4c61d' # (your output will vary depending on namespace and content) Value: none Annotation: none is Public? : true is Private? : false Parameters: ["content"] Returns: str Parent Class: none
function
generate_unique_arrow_view_name
fenic.core._utils.misc.generate_unique_arrow_view_name
Generate a unique temporary view name for an Arrow table. This is useful for assigning a one-off name to a view or table when working with in-memory or temporary datasets. Returns: A string representing a unique temporary view name. Example: >>> generate_unique_arrow_view_name() 'temp_arrow_view_1a2b3c4d5e6f...'
null
true
false
46
59
null
str
null
[]
null
null
Type: function Member Name: generate_unique_arrow_view_name Qualified Name: fenic.core._utils.misc.generate_unique_arrow_view_name Docstring: Generate a unique temporary view name for an Arrow table. This is useful for assigning a one-off name to a view or table when working with in-memory or temporary datasets. Returns: A string representing a unique temporary view name. Example: >>> generate_unique_arrow_view_name() 'temp_arrow_view_1a2b3c4d5e6f...' Value: none Annotation: none is Public? : true is Private? : false Parameters: [] Returns: str Parent Class: none
module
type_inference
fenic.core._utils.type_inference
null
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_utils/type_inference.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: type_inference Qualified Name: fenic.core._utils.type_inference Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
class
TypeInferenceError
fenic.core._utils.type_inference.TypeInferenceError
null
null
true
false
16
20
null
null
null
null
[ "ValueError" ]
null
Type: class Member Name: TypeInferenceError Qualified Name: fenic.core._utils.type_inference.TypeInferenceError Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
method
__init__
fenic.core._utils.type_inference.TypeInferenceError.__init__
null
null
true
false
17
20
null
null
null
[ "self", "message", "path" ]
null
TypeInferenceError
Type: method Member Name: __init__ Qualified Name: fenic.core._utils.type_inference.TypeInferenceError.__init__ Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["self", "message", "path"] Returns: none Parent Class: TypeInferenceError
function
infer_dtype_from_pyobj
fenic.core._utils.type_inference.infer_dtype_from_pyobj
null
null
true
false
22
58
null
DataType
null
[ "value", "path" ]
null
null
Type: function Member Name: infer_dtype_from_pyobj Qualified Name: fenic.core._utils.type_inference.infer_dtype_from_pyobj Docstring: none Value: none Annotation: none is Public? : true is Private? : false Parameters: ["value", "path"] Returns: DataType Parent Class: none
function
_find_common_supertype
fenic.core._utils.type_inference._find_common_supertype
null
null
false
true
61
98
null
DataType
null
[ "type1", "type2", "path" ]
null
null
Type: function Member Name: _find_common_supertype Qualified Name: fenic.core._utils.type_inference._find_common_supertype Docstring: none Value: none Annotation: none is Public? : false is Private? : true Parameters: ["type1", "type2", "path"] Returns: DataType Parent Class: none
module
extract
fenic.core._utils.extract
Utility functions for working with structured extraction schemas.
/private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.0.0-y6d85svd/fenic/src/fenic/core/_utils/extract.py
true
false
null
null
null
null
null
null
null
null
Type: module Member Name: extract Qualified Name: fenic.core._utils.extract Docstring: Utility functions for working with structured extraction schemas. Value: none Annotation: none is Public? : true is Private? : false Parameters: none Returns: none Parent Class: none
function
convert_extract_schema_to_pydantic_type
fenic.core._utils.extract.convert_extract_schema_to_pydantic_type
Create a Pydantic model type from an ExtractSchema schema. Args: schema: The ExtractSchema defining the structure Returns: A Pydantic model type that matches the schema structure
null
true
false
21
32
null
type[BaseModel]
null
[ "schema" ]
null
null
Type: function Member Name: convert_extract_schema_to_pydantic_type Qualified Name: fenic.core._utils.extract.convert_extract_schema_to_pydantic_type Docstring: Create a Pydantic model type from an ExtractSchema schema. Args: schema: The ExtractSchema defining the structure Returns: A Pydantic model type that matches the schema structure Value: none Annotation: none is Public? : true is Private? : false Parameters: ["schema"] Returns: type[BaseModel] Parent Class: none
function
validate_extract_schema_structure
fenic.core._utils.extract.validate_extract_schema_structure
Check a ExtractSchema or Pydantic model to ensure it is valid schema for a semantic extract.
null
true
false
35
91
null
None
null
[ "model" ]
null
null
Type: function Member Name: validate_extract_schema_structure Qualified Name: fenic.core._utils.extract.validate_extract_schema_structure Docstring: Check a ExtractSchema or Pydantic model to ensure it is valid schema for a semantic extract. Value: none Annotation: none is Public? : true is Private? : false Parameters: ["model"] Returns: None Parent Class: none
function
_convert_primitive_dtype_to_pytype
fenic.core._utils.extract._convert_primitive_dtype_to_pytype
Convert a PrimitiveType to a Python type. Args: dtype: The PrimitiveType to convert Returns: The corresponding Python type Raises: ValueError: If the data type cannot be converted
null
false
true
94
123
null
type
null
[ "dtype" ]
null
null
Type: function Member Name: _convert_primitive_dtype_to_pytype Qualified Name: fenic.core._utils.extract._convert_primitive_dtype_to_pytype Docstring: Convert a PrimitiveType to a Python type. Args: dtype: The PrimitiveType to convert Returns: The corresponding Python type Raises: ValueError: If the data type cannot be converted Value: none Annotation: none is Public? : false is Private? : true Parameters: ["dtype"] Returns: type Parent Class: none
End of preview. Expand in Data Studio
README.md exists but content is empty.
Downloads last month
16