Vllm.SamplingParams.StructuredOutputsParams (VLLM v0.3.0)

Copy Markdown View Source

Sampling parameters for text generation.

Summary

Types

t()

@opaque t()

Functions

all_constraints_none(ref, opts \\ [])

@spec all_constraints_none(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, boolean()} | {:error, Snakepit.Error.t()}

Returns True if all structured-output constraint fields are None.

Returns

  • boolean()

all_non_structural_tag_constraints_none(ref, opts \\ [])

@spec all_non_structural_tag_constraints_none(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, boolean()} | {:error, Snakepit.Error.t()}

Returns True if all structured-output constraint fields are None.

Returns

  • boolean()

choice(ref)

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

disable_additional_properties(ref)

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

disable_any_whitespace(ref)

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

disable_fallback(ref)

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

grammar(ref)

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

json(ref)

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

json_object(ref)

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

new(dataclass_self__, args, kwargs, opts \\ [])

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

Sampling parameters for text generation.

Parameters

  • dataclass_self__ (term())
  • args (term())
  • kwargs (term())

regex(ref)

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

structural_tag(ref)

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

whitespace_pattern(ref)

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