# `Vllm.BeamSearch.BeamSearchSequence`
[🔗](https://github.com/nshkrdotcom/vllm/blob/v0.3.0/lib/snakebridge_generated/vllm/beam_search/beam_search_sequence.ex#L7)

A sequence for beam search.

It keeps track of the tokens and the log probability of the sequence.
The text field is optional and will only be filled when the sequence is
about to be returned to the user.

# `t`

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

# `cum_logprob`

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

# `finish_reason`

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

# `lora_request`

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

# `mm_processor_kwargs`

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

# `multi_modal_data`

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

# `new`

```elixir
@spec new(
  [integer()],
  [%{optional(integer()) => Vllm.Logprobs.Logprob.t()}],
  [term()],
  keyword()
) ::
  {:ok, SnakeBridge.Ref.t()} | {:error, Snakepit.Error.t()}
```

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

## Parameters

- `tokens` (list(integer()))
- `logprobs` (list(%{optional(integer()) => Vllm.Logprobs.Logprob.t()}))
- `lora_request` (term() default: None)
- `cum_logprob` (float() default: 0.0)
- `text` (term() default: None)
- `finish_reason` (term() default: None)
- `stop_reason` (term() default: None)
- `multi_modal_data` (term() | nil default: None)
- `mm_processor_kwargs` (term() default: None)

# `stop_reason`

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

# `text`

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

---

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