bigframes.extensions.core.dataframe_accessor.AIAccessor

class bigframes.extensions.core.dataframe_accessor.AIAccessor(obj: T)

DataFrame accessor for BigQuery AI functions.

forecast(*, data_col: str, timestamp_col: str, model: str = 'TimesFM 2.0', id_cols: Iterable[str] | None = None, horizon: int = 10, confidence_level: float = 0.95, context_window: int | None = None, output_historical_time_series: bool = False, session: bigframes.session.Session | None = None) → T

Forecast time series at future horizon using BigQuery AI.FORECAST.

This is an accessor for bigframes.bigquery.ai.forecast(). See that function’s documentation for detailed parameter descriptions and examples.

generate(prompt: Any, *, connection_id: str | None = None, endpoint: str | None = None, request_type: Literal['dedicated', 'shared', 'unspecified'] | None = None, model_params: Mapping[Any, Any] | None = None, output_schema: Mapping[str, str] | None = None) → S

Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.

This is an accessor for bigframes.bigquery.ai.generate(). See that function’s documentation for detailed parameter descriptions and examples.

generate_bool(prompt: Any, *, connection_id: str | None = None, endpoint: str | None = None, request_type: Literal['dedicated', 'shared', 'unspecified'] | None = None, model_params: Mapping[Any, Any] | None = None) → S

Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.

This is an accessor for bigframes.bigquery.ai.generate_bool(). See that function’s documentation for detailed parameter descriptions and examples.

generate_double(prompt: Any, *, connection_id: str | None = None, endpoint: str | None = None, request_type: Literal['dedicated', 'shared', 'unspecified'] | None = None, model_params: Mapping[Any, Any] | None = None) → S

Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.

This is an accessor for bigframes.bigquery.ai.generate_double(). See that function’s documentation for detailed parameter descriptions and examples.

generate_int(prompt: Any, *, connection_id: str | None = None, endpoint: str | None = None, request_type: Literal['dedicated', 'shared', 'unspecified'] | None = None, model_params: Mapping[Any, Any] | None = None) → S

Returns the AI analysis based on the prompt, which can be any combination of text and unstructured data.

This is an accessor for bigframes.bigquery.ai.generate_int(). See that function’s documentation for detailed parameter descriptions and examples.