Class MultimodalEmbeddingGenerator (2.14.0)

MultimodalEmbeddingGenerator(
    *,
    model_name: typing.Optional[typing.Literal["multimodalembedding@001"]] = None,
    session: typing.Optional[bigframes.session.Session] = None,
    connection_name: typing.Optional[str] = None
)

Multimodal embedding generator LLM model.

Parameters
Name	Description
`model_name`	`str, Default to "multimodalembedding@001"` The model for multimodal embedding. Can set to "multimodalembedding@001". Multimodal-embedding models returns model embeddings for text, image and video inputs. If no setting is provided, "multimodalembedding@001" will be used by default and a warning will be issued.
`session`	`bigframes.Session or None` BQ session to create the model. If None, use the global default session.
`connection_name`	`str or None` Connection to connect with remote service. str of the format <PROJECT_NUMBER/PROJECT_ID>.

Methods

repr

__repr__()

Print the estimator's constructor with all non-default parameter values.

get_params

get_params(deep: bool = True) -> typing.Dict[str, typing.Any]

Get parameters for this estimator.

Parameter
Name	Description
`deep`	`bool, default True` Default `True`. If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns
Type	Description
`Dictionary`	A dictionary of parameter names mapped to their values.

predict

predict(
    X: typing.Union[
        bigframes.dataframe.DataFrame,
        bigframes.series.Series,
        pandas.core.frame.DataFrame,
        pandas.core.series.Series,
    ],
    *,
    max_retries: int = 0
) -> bigframes.dataframe.DataFrame

Predict the result from input DataFrame.

Parameters
Name	Description
`X`	`bigframes.dataframe.DataFrame or bigframes.series.Series or pandas.core.frame.DataFrame or pandas.core.series.Series` Input DataFrame or Series, can contain one or more columns. If multiple columns are in the DataFrame, it must contain a "content" column for prediction. The content column must be of string type or BigFrames Blob of image or video.
`max_retries`	`int, default 0` Max number of retries if the prediction for any rows failed. Each try needs to make progress (i.e. has successfully predicted rows) to continue the retry. Each retry will append newly succeeded rows. When the max retries are reached, the remaining rows (the ones without successful predictions) will be appended to the end of the result.

Returns
Type	Description
`bigframes.dataframe.DataFrame`	DataFrame of shape (n_samples, n_input_columns + n_prediction_columns). Returns predicted values.

to_gbq

to_gbq(
    model_name: str, replace: bool = False
) -> bigframes.ml.llm.MultimodalEmbeddingGenerator

Save the model to BigQuery.

Parameters
Name	Description
`model_name`	`str` The name of the model.
`replace`	`bool, default False` Determine whether to replace if the model already exists. Default to False.

Returns
Type	Description
`MultimodalEmbeddingGenerator`	Saved model.