IMPORTANT: To view this page as Markdown, append `.md` to the URL (e.g. /max/get-started.md). For the complete documentation index, see llms.txt.
Skip to main content
For the complete documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /max/get-started.md).

Python class

ToolChoiceValueEnum

ToolChoiceValueEnum​

class max.pipelines.request.ToolChoiceValueEnum(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

source

Bases: str, Enum

Controls which (if any) tool is called by the model.

  • none: The model will not call any tool and instead generates a message.
  • auto: The model can pick between generating a message or calling one or more tools.
  • required: The model must call one or more tools.

auto​

auto = 'auto'

source

none​

none = 'none'

source

required​

required = 'required'

source