> ## Documentation Index
> Fetch the complete documentation index at: https://docs.obiguard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Embeddings

> Get embeddings from Vertex AI

Vertex AI offers wide ranging support for embedding text, images and videos.
Obiguard provides a standardized interface for embedding multiple modalities.

## Embedding Text

<Tabs>
  <Tab title="Python SDK">
    ```python Python theme={null}
    from obiguard import Obiguard

    client = Obiguard(
      obiguard_api_key="sk-obg***",  # Your Obiguard API key
    )

    embeddings = client.embeddings.create(
      model="textembedding-gecko@003",
      input_type="classification",
      input="The food was delicious and the waiter...",
      # input=["text to embed", "more text to embed"], # if you would like to embed multiple texts
    )
    ```
  </Tab>

  <Tab title="OpenAI SDK">
    ```python OpenAI Python theme={null}
    from openai import OpenAI
    from obiguard import OBIGUARD_GATEWAY_URL, createHeaders

    client = OpenAI(
      api_key='NOT_REQUIRED',
      base_url=OBIGUARD_GATEWAY_URL,
      default_headers=createHeaders(
        provider="openai",
        obiguard_api_key="sk-obg******",  # Your Obiguard API key
      )
    )

    embeddings = client.embeddings.create(
      model="textembedding-gecko@003",
      input_type="classification",
      input="The food was delicious and the waiter...",
      # input=["text to embed", "more text to embed"], # if you would like to embed multiple texts
    )
    ```
  </Tab>
</Tabs>

## Embeddings Images

<Tabs>
  <Tab title="Python SDK">
    ```python Python theme={null}
    from obiguard import Obiguard

    client = Obiguard(
      obiguard_api_key="sk-obg***",  # Your Obiguard API key
    )

    embeddings = client.embeddings.create(
      model="multimodalembedding@001",
      input=[
        {
          "text": "this is the caption of the image",
          "image": {
            "base64": "UklGRkacAABXRUJQVlA4IDqcAACQggKdASqpAn8B.....",
            # "url": "gcs://..." # if you want to use a url
          }
        }
      ]
    )
    ```
  </Tab>

  <Tab title="OpenAI SDK">
    ```python OpenAI Python theme={null}
    from openai import OpenAI
    from obiguard import OBIGUARD_GATEWAY_URL, createHeaders

    client = OpenAI(
      api_key='NOT_REQUIRED',
      base_url=OBIGUARD_GATEWAY_URL,
      default_headers=createHeaders(
        provider="openai",
        obiguard_api_key="sk-obg******",  # Your Obiguard API key
      )
    )

    embeddings = client.embeddings.create(
      model="multimodalembedding@001",
      input=[
        {
          "text": "this is the caption of the image",
          "image": {
            "base64": "UklGRkacAABXRUJQVlA4IDqcAACQggKdASqpAn8B.....",
            # "url": "gcs://..." # if you want to use a url
          }
        }
      ]
    )
    ```
  </Tab>

  <Tab title="cURL">
    ```sh cURL theme={null}
      curl --location 'https://gateway.obiguard.ai/v1/embeddings' \
        --header 'Content-Type: application/json' \
        --header 'x-obiguard-api-key: $OBIGUARD_API_KEY' \
        --data-raw '{
        "model": "multimodalembedding@001",
        "input": [
          {
            "text": "this is the caption of the image",
            "image": {
              "base64": "UklGRkacAABXRUJQVlA4IDqcAACQggKdASqpAn8B....."
              # "url": "gcs://..." # if you want to use a url
            }
        }
      ]
    }'
    ```
  </Tab>
</Tabs>

## Embeddings Videos

<Tabs>
  <Tab title="Python SDK">
    ```python Python theme={null}
    from obiguard import Obiguard

    client = Obiguard(
      obiguard_api_key="sk-obg***",  # Your Obiguard API key
    )

    embeddings = client.embeddings.create(
      model="multimodalembedding@001",
      input=[
        {
          "text": "this is the caption of the video",
          "video": {
            "base64": "UklGRkacAABXRUJQVlA4IDqcAACQggKdASqpAn8B.....",
            "start_offset": 0,
            "end_offset": 10,
            "interval": 5,
            # "url": "gcs://..." # if you want to use a url
          }
        }
      ]
    )
    ```
  </Tab>

  <Tab title="OpenAI SDK">
    ```python OpenAI Python theme={null}
    from openai import OpenAI
    from obiguard import OBIGUARD_GATEWAY_URL, createHeaders

    client = OpenAI(
      api_key='NOT_REQUIRED',
      base_url=OBIGUARD_GATEWAY_URL,
      default_headers=createHeaders(
        provider="openai",
        obiguard_api_key="sk-obg******",  # Your Obiguard API key
      )
    )

    embeddings = client.embeddings.create(
      model="multimodalembedding@001",
      input=[
        {
          "text": "this is the caption of the video",
          "video": {
            "base64": "UklGRkacAABXRUJQVlA4IDqcAACQggKdASqpAn8B.....",
            "start_offset": 0,
            "end_offset": 10,
            "interval": 5,
            # "url": "gcs://..." # if you want to use a url
          }
        }
      ]
    )
    ```
  </Tab>

  <Tab title="cURL">
    ```sh cURL theme={null}
    curl --location 'https://gateway.obiguard.ai/v1/embeddings' \
      --header 'Content-Type: application/json' \
      --header 'x-obiguard-api-key: $OBIGUARD_API_KEY' \
      --data-raw '{
        "model": "multimodalembedding@001",
        "input": [
          {
            "text": "this is the caption of the video",
            "video": {
              "base64": "UklGRkacAABXRUJQVlA4IDqcAACQggKdASqpAn8B.....",
              "start_offset": 0,
              "end_offset": 10,
              "interval": 5
              # "url": "gcs://..." # if you want to use a url
            }
          }
        ]
      }'
    ```
  </Tab>
</Tabs>