Public types

​

ChoiceQuestionParam

class tazo.types.ChoiceQuestionParam

​

NoulQuestionParam

class tazo.types.NoulQuestionParam

​

ChoiceQuestion

class tazo.types.ChoiceQuestion(*, type='choice', instructions, criteria)

• Parameters:
  • type (Literal*[‘choice’]*)
  • instructions (str |dict[str, Any*]* | list*[str]*)
  • criteria (dict*[str,* str |dict[str, Any*]* | list*[str]* | None*]*)

​

NoulQuestion

class tazo.types.NoulQuestion(*, type='noul', instructions, criteria=None)

• Parameters:
  • type (Literal*[‘noul’]*)
  • instructions (str |dict[str, Any*]* | list*[str]*)
  • criteria (dict*[str,* str |dict[str, Any*]* | list*[str]* | None*]* | None)

​

DecisionRequest

class tazo.types.DecisionRequest(*, model='tazo-large', state, questions)

• Parameters:
  • model (str)
  • state (str |dict[str, Any*]* | list*[str]*)
  • questions (dict*[str,* Annotated*[ChoiceQuestion |NoulQuestion,* FieldInfo*(annotation=NoneType,* required=True*,* discriminator=‘type’)]**])

​

ChoiceAnswer

class tazo.types.ChoiceAnswer(*, type, choice, probabilities, confidence, **extra_data)

• Parameters:
  • type (Literal*[‘choice’]*)
  • choice (str)
  • probabilities (dict*[str,* float*]*)
  • confidence (float)
  • extra_data (Any)

​

NoulAnswer

class tazo.types.NoulAnswer(*, type, noul, **extra_data)

• Parameters:
  • type (Literal*[‘noul’]*)
  • noul (float)
  • extra_data (Any)

​

Usage

class tazo.types.Usage(*, audio_seconds, input_tokens=None, output_tokens=None, **extra_data)

• Parameters:
  • audio_seconds (float)
  • input_tokens (int *|*None)
  • output_tokens (int *|*None)
  • extra_data (Any)

​

DecisionResponse

class tazo.types.DecisionResponse(*, id, model, answers, usage, elapsed_ms, request_id=None, idempotency_key=None, **extra_data)

• Parameters:
  • id (str)
  • model (str)
  • answers (dict*[str,* Annotated*[ChoiceAnswer |NoulAnswer,* FieldInfo*(annotation=NoneType,* required=True*,* discriminator=‘type’)]**])
  • usage (Usage)
  • elapsed_ms (float)
  • request_id (str *|*None)
  • idempotency_key (str *|*None)
  • extra_data (Any)

​

ModelCapabilities

class tazo.types.ModelCapabilities(*, question_types, max_questions, max_choice_options=None, requires_no_tool_choice=False, max_audio_seconds=None, required_sample_rate_hz=None, **extra_data)

• Parameters:
  • question_types (list*[str]*)
  • max_questions (int)
  • max_choice_options (int *|*None)
  • requires_no_tool_choice (bool)
  • max_audio_seconds (float *|*None)
  • required_sample_rate_hz (int *|*None)
  • extra_data (Any)

​

Model

class tazo.types.Model(*, id, display_name, description, contract, capabilities, ready, **extra_data)

• Parameters:
  • id (str)
  • display_name (str)
  • description (str)
  • contract (str)
  • capabilities (ModelCapabilities)
  • ready (bool)
  • extra_data (Any)

​

ModelList

class tazo.types.ModelList(*, models, **extra_data)

• Parameters:
  • models (list*[Model]*)
  • extra_data (Any)

​

HealthStatus

class tazo.types.HealthStatus(*, status, **extra_data)

• Parameters:
  • status (Literal*[‘ok’,* ‘unavailable’**])
  • extra_data (Any)

​

AudioFormat

class tazo.types.AudioFormat(*, encoding='pcm_s16le', sample_rate_hz=16000, channels=1, **extra_data)

• Parameters:
  • encoding (Literal*[‘pcm_s16le’]*)
  • sample_rate_hz (Literal*[16000]*)
  • channels (Literal*[1]*)
  • extra_data (Any)

​

SessionReady

class tazo.types.SessionReady(*, type, session_id, sequence, model, config_revision, input_audio, evaluation_interval_ms, max_turn_audio_ms, max_audio_message_bytes, audio_scope, **extra_data)

• Parameters:
  • type (Literal*[‘session.ready’]*)
  • session_id (str)
  • sequence (int)
  • model (str)
  • config_revision (int)
  • input_audio (AudioFormat)
  • evaluation_interval_ms (int)
  • max_turn_audio_ms (int *|*None)
  • max_audio_message_bytes (int)
  • audio_scope (Literal*[‘turn’,* ‘chunk’**])
  • extra_data (Any)

​

SessionUpdated

class tazo.types.SessionUpdated(*, type, session_id, sequence, config_revision, **extra_data)

• Parameters:
  • type (Literal*[‘session.updated’]*)
  • session_id (str)
  • sequence (int)
  • config_revision (int)
  • extra_data (Any)

​

DecisionEvent

class tazo.types.DecisionEvent(*, id, model, answers, usage, elapsed_ms, request_id=None, idempotency_key=None, type, session_id, sequence, turn_id, config_revision, audio_start_ms=0, audio_end_ms, **extra_data)

• Parameters:
  • id (str)
  • model (str)
  • answers (dict*[str,* Annotated*[ChoiceAnswer |NoulAnswer,* FieldInfo*(annotation=NoneType,* required=True*,* discriminator=‘type’)]**])
  • usage (Usage)
  • elapsed_ms (float)
  • request_id (str *|*None)
  • idempotency_key (str *|*None)
  • type (Literal*[‘decision.updated’,* ‘decision.finalized’**])
  • session_id (str)
  • sequence (int)
  • turn_id (str)
  • config_revision (int)
  • audio_start_ms (float)
  • audio_end_ms (float)
  • extra_data (Any)

​

SessionClosed

class tazo.types.SessionClosed(*, type, session_id, sequence, **extra_data)

• Parameters:
  • type (Literal*[‘session.closed’]*)
  • session_id (str)
  • sequence (int)
  • extra_data (Any)

​

ErrorEvent

class tazo.types.ErrorEvent(*, type, error, fatal, session_id=None, sequence=None, **extra_data)

• Parameters:
  • type (Literal*[‘error’]*)
  • error (StreamErrorDetail)
  • fatal (bool)
  • session_id (str *|*None)
  • sequence (int *|*None)
  • extra_data (Any)

​

UnknownEvent

class tazo.types.UnknownEvent(*, type, **extra_data)

• Parameters:
  • type (str)
  • extra_data (Any)