The EmbedClient class provides methods to create text, image, and audio embeddings.

Create text, image, and audio embeddings

Description: This method creates a new embedding.

Note that you must specify at least the following parameters:

• model_name: The name of the video understanding model to use.

• One or more of the following input types:

  • text: For text embeddings
  • audio_url or audio_file: For audio embeddings. If you specify both, the audio_url parameter takes precedence.
  • image_url or image_file: For image embeddings. If you specify both, the image_url parameter takes precedence.

You must provide at least one input type, but you can include multiple types in a single function call.

Function signature and example:

1
def create(
2
    self,
3
    model_name: Literal["marengo3.0"],
4
    *,
5
    # text params
6
    text: str = None,
7
    # audio params
8
    audio_url: str = None,
9
    audio_file: Union[str, BinaryIO, None] = None,
10
    # image params
11
    image_url: str = None,
12
    image_file: Union[str, BinaryIO, None] = None,
13
    **kwargs,
14
) -> models.CreateEmbeddingsResult

Parameters

Return value

Returns an EmbeddingResponse object containing the embedding results.

The EmbeddingResponse class contains the following properties:

The TextEmbeddingResult class contains the following properties:

The AudioEmbeddingResult class contains the following properties:

The ImageEmbeddingResult class contains the following properties:

The BaseSegment class contains the following properties:

The AudioSegment class extends BaseSegment and contains the following additional properties:

The BaseEmbeddingMetadata class contains the following properties:

API Reference

Create text, audio, and image embeddings.

Related guides

• Create text embeddings
• Create audio embeddings
• Create single image embeddings

Error codes

This section lists the most common error messages you may encounter while creating text, image, and audio embeddings.

• parameter_invalid
  • The text parameter is invalid. The text token length should be less than or equal to 77.
  • The text_truncate parameter is invalid. You should use one of the following values: none, start, end.

For a list of general errors that apply to all endpoints, see the Error codes page.