# Class MultiModalEmbeddingModel (1.153.1)

1.153.1 (latest) 1.153.0 1.152.0 1.151.0 1.150.0 1.149.0 1.148.1 1.147.0 1.146.0 1.145.0 1.144.0 1.143.0 1.142.0 1.141.0 1.140.0 1.139.0 1.138.0 1.137.0 1.136.0 1.135.0 1.134.0 1.133.0 1.132.0 1.131.0 1.130.0 1.129.0 1.122.0 1.121.0 1.120.0 1.119.0 1.118.0 1.117.0 1.95.1 1.94.0 1.93.1 1.92.0 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.0 1.75.0 1.74.0 1.73.0 1.72.0 1.71.1 1.70.0 1.69.0 1.68.0 1.67.1 1.66.0 1.65.0 1.63.0 1.62.0 1.60.0 1.59.0

    MultiModalEmbeddingModel(model_id: str, endpoint_name: typing.Optional[str] = None)

Generates embedding vectors from images and videos.

Examples::

    model = MultiModalEmbeddingModel.from_pretrained("multimodalembedding@001")
    image = Image.load_from_file("image.png")
    video = Video.load_from_file("video.mp4")

    embeddings = model.get_embeddings(
        image=image,
        video=video,
        contextual_text="Hello world",
    )
    image_embedding = embeddings.image_embedding
    video_embeddings = embeddings.video_embeddings
    text_embedding = embeddings.text_embedding

## Methods

### MultiModalEmbeddingModel

    MultiModalEmbeddingModel(model_id: str, endpoint_name: typing.Optional[str] = None)

Creates a _ModelGardenModel.

This constructor should not be called directly.
Use `{model_class}.from_pretrained(model_name=...)` instead.

### from_pretrained

    from_pretrained(model_name: str) -> vertexai._model_garden._model_garden_models.T

Loads a _ModelGardenModel.

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `ValueError` | If model_name is unknown. |
| `ValueError` | If model does not support this class. |

### get_embeddings

    get_embeddings(
        image: typing.Optional[vertexai.vision_models.Image] = None,
        video: typing.Optional[vertexai.vision_models.Video] = None,
        contextual_text: typing.Optional[str] = None,
        dimension: typing.Optional[int] = None,
        video_segment_config: typing.Optional[
            vertexai.vision_models.VideoSegmentConfig
        ] = None,
    ) -> vertexai.vision_models.MultiModalEmbeddingResponse

Gets embedding vectors from the provided image.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `image` | `Image` Optional. The image to generate embeddings for. One of `image`, `video`, or `contextual_text` is required. |
| `video` | `Video` Optional. The video to generate embeddings for. One of `image`, `video` or `contextual_text` is required. |
| `contextual_text` | `str` Optional. Contextual text for your input image or video. If provided, the model will also generate an embedding vector for the provided contextual text. The returned image and text embedding vectors are in the same semantic space with the same dimensionality, and the vectors can be used interchangeably for use cases like searching image by text or searching text by image. One of `image`, `video` or `contextual_text` is required. |
| `dimension` | `int` Optional. The number of embedding dimensions. Lower values offer decreased latency when using these embeddings for subsequent tasks, while higher values offer better accuracy. Available values: `128`, `256`, `512`, and `1408` (default). |
| `video_segment_config` | `VideoSegmentConfig` Optional. The specific video segments (in seconds) the embeddings are generated for. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `MultiModalEmbeddingResponse` | The image and text embedding vectors. |