# `Vllm.PoolingParamsClass`
[🔗](https://github.com/nshkrdotcom/vllm/blob/v0.3.0/lib/snakebridge_generated/vllm/pooling_params/pooling_params.ex#L7)

API parameters for pooling models.

Attributes:
    truncate_prompt_tokens: Controls prompt truncation.
        Set to -1 to use the model's default truncation size.
        Set to k to keep only the last k tokens (left truncation).
        Set to None to disable truncation.
    dimensions: Reduce the dimensions of embeddings
        if model support matryoshka representation.
    normalize: Deprecated, please use use_activation instead.
    softmax: Deprecated, please use use_activation instead.
    activation: Deprecated, please use use_activation instead.
    use_activation: Whether to apply activation function to
        the classification outputs.

# `t`

```elixir
@opaque t()
```

# `_merge_default_parameters`

```elixir
@spec _merge_default_parameters(SnakeBridge.Ref.t(), [term()], keyword()) ::
  {:ok, nil} | {:error, Snakepit.Error.t()}
```

Python method `PoolingParams._merge_default_parameters`.

## Parameters

- `model_config` (term() | nil default: None)

## Returns

- `nil`

# `_set_default_parameters`

```elixir
@spec _set_default_parameters(SnakeBridge.Ref.t(), term() | nil, keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

Python method `PoolingParams._set_default_parameters`.

## Parameters

- `model_config` (term() | nil)

## Returns

- `term()`

# `_verify_step_pooling`

```elixir
@spec _verify_step_pooling(SnakeBridge.Ref.t(), term(), [String.t()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

Python method `PoolingParams._verify_step_pooling`.

## Parameters

- `pooler_config` (term())
- `valid_parameters` (list(String.t()))

## Returns

- `term()`

# `_verify_valid_parameters`

```elixir
@spec _verify_valid_parameters(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

Python method `PoolingParams._verify_valid_parameters`.

## Returns

- `term()`

# `activation`

```elixir
@spec activation(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `all_parameters`

```elixir
@spec all_parameters(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `clone`

```elixir
@spec clone(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, t()} | {:error, Snakepit.Error.t()}
```

Returns a deep copy of the PoolingParams instance.

## Returns

- `Vllm.PoolingParamsClass.t()`

# `dimensions`

```elixir
@spec dimensions(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `extra_kwargs`

```elixir
@spec extra_kwargs(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `new`

```elixir
@spec new(
  [term()],
  keyword()
) :: {:ok, SnakeBridge.Ref.t()} | {:error, Snakepit.Error.t()}
```

Initialize self.  See help(type(self)) for accurate signature.

## Parameters

- `args` (term())
- `kwargs` (term())

# `normalize`

```elixir
@spec normalize(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `output_kind`

```elixir
@spec output_kind(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `requires_token_ids`

```elixir
@spec requires_token_ids(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `returned_token_ids`

```elixir
@spec returned_token_ids(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `skip_reading_prefix_cache`

```elixir
@spec skip_reading_prefix_cache(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `softmax`

```elixir
@spec softmax(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `step_tag_id`

```elixir
@spec step_tag_id(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `task`

```elixir
@spec task(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `truncate_prompt_tokens`

```elixir
@spec truncate_prompt_tokens(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `use_activation`

```elixir
@spec use_activation(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `valid_parameters`

```elixir
@spec valid_parameters(SnakeBridge.Ref.t()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
```

# `verify`

```elixir
@spec verify(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, nil} | {:error, Snakepit.Error.t()}
```

Python method `PoolingParams.verify`.

## Parameters

- `task` (term())
- `model_config` (term() | nil default: None)

## Returns

- `nil`

---

*Consult [api-reference.md](api-reference.md) for complete listing*