Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

1.5 KB
Raw Blame
<a id="camel.embeddings.together_embedding"></a>

<a id="camel.embeddings.together_embedding.TogetherEmbedding"></a>

## TogetherEmbedding

```python
class TogetherEmbedding:
```

Provides text embedding functionalities using Together AI's models.

**Parameters:**

- **model_type** (str, optional): The model name to be used for text embeddings. (default: :obj:`togethercomputer/m2-bert-80M-8k-retrieval`)
- **api_key** (str, optional): The API key for authenticating with the Together service. (default: :obj:`None`)
- **dimensions** (int, optional): The text embedding output dimensions. (default: :obj:`None`)

<a id="camel.embeddings.together_embedding.TogetherEmbedding.__init__"></a>

### __init__

```python
def __init__(
    self,
    model_type: str = 'togethercomputer/m2-bert-80M-8k-retrieval',
    api_key: Optional[str] = None,
    dimensions: Optional[int] = None
):
```

<a id="camel.embeddings.together_embedding.TogetherEmbedding.embed_list"></a>

### embed_list

```python
def embed_list(self, objs: list[str], **kwargs: Any):
```

Generates embeddings for the given texts.

**Parameters:**

- **objs** (list[str]): The texts for which to generate the embeddings. **kwargs (Any): Extra kwargs passed to the embedding API.

**Returns:**

  list[list[float]]: A list that represents the generated embedding
as a list of floating-point numbers.

<a id="camel.embeddings.together_embedding.TogetherEmbedding.get_output_dim"></a>

### get_output_dim

```python
def get_output_dim(self):
```

**Returns:**

  int: The dimensionality of the embedding for the current model.