Parameter Scheme

class ibm_watsonx_ai.foundation_models.schema.BaseSchema

Bases: object

classmethod get_sample_params()

Override this method in subclasses to provide example values for parameters.

classmethod show()

Displays a table with the parameter name, type, and example value.

Chat Parameters

class ibm_watsonx_ai.foundation_models.schema.TextChatParameters(frequency_penalty: float | None = None, logprobs: bool | None = None, top_logprobs: int | None = None, presence_penalty: float | None = None, response_format: dict | ibm_watsonx_ai.foundation_models.schema._api.TextChatResponseFormat | None = None, temperature: float | None = None, max_tokens: int | None = None, time_limit: int | None = None, top_p: float | None = None, n: int | None = None)

Bases: BaseSchema

frequency_penalty = None

logprobs = None

max_tokens = None

n = None

presence_penalty = None

response_format = None

temperature = None

time_limit = None

top_logprobs = None

top_p = None

class ibm_watsonx_ai.foundation_models.schema.TextChatResponseFormat(type: str | ibm_watsonx_ai.foundation_models.schema._api.TextChatResponseFormatType | None = None)

Bases: BaseSchema

type = None

class ibm_watsonx_ai.foundation_models.schema.TextChatResponseFormatType(value)

Bases: StrEnum

An enumeration.

JSON_OBJECT = 'json_object'

Generate Parameters

class ibm_watsonx_ai.foundation_models.schema.TextGenParameters(decoding_method: str | ibm_watsonx_ai.foundation_models.schema._api.TextGenDecodingMethod | None = None, length_penalty: dict | ibm_watsonx_ai.foundation_models.schema._api.TextGenLengthPenalty | None = None, temperature: float | None = None, top_p: float | None = None, top_k: int | None = None, random_seed: int | None = None, repetition_penalty: float | None = None, min_new_tokens: int | None = None, max_new_tokens: int | None = None, stop_sequences: list[str] | None = None, time_limit: int | None = None, truncate_input_tokens: int | None = None, return_options: dict | ibm_watsonx_ai.foundation_models.schema._api.ReturnOptionProperties | None = None, include_stop_sequence: bool | None = None, prompt_variables: dict | None = None)

Bases: BaseSchema

decoding_method = None

include_stop_sequence = None

length_penalty = None

max_new_tokens = None

min_new_tokens = None

prompt_variables = None

random_seed = None

repetition_penalty = None

return_options = None

stop_sequences = None

temperature = None

time_limit = None

top_k = None

top_p = None

truncate_input_tokens = None

class ibm_watsonx_ai.foundation_models.schema.ReturnOptionProperties(input_text: bool | None = None, generated_tokens: bool | None = None, input_tokens: bool | None = None, token_logprobs: bool | None = None, token_ranks: bool | None = None, top_n_tokens: bool | None = None)

Bases: BaseSchema

generated_tokens = None

input_text = None

input_tokens = None

token_logprobs = None

token_ranks = None

top_n_tokens = None

class ibm_watsonx_ai.foundation_models.schema.TextGenLengthPenalty(decay_factor: float | None = None, start_index: int | None = None)

Bases: object

decay_factor = None

start_index = None

class ibm_watsonx_ai.foundation_models.schema.TextGenDecodingMethod(value)

Bases: StrEnum

An enumeration.

GREEDY = 'greedy'

SAMPLE = 'sample'

Rerank Parameters

class ibm_watsonx_ai.foundation_models.schema.RerankParameters(truncate_input_tokens: int | None = None, return_options: dict | ibm_watsonx_ai.foundation_models.schema._api.RerankReturnOptions | None = None)

Bases: BaseSchema

return_options = None

truncate_input_tokens = None

class ibm_watsonx_ai.foundation_models.schema.RerankReturnOptions(top_n: int | None = None, inputs: bool | None = None, query: bool | None = None)

Bases: BaseSchema

inputs = None

query = None

top_n = None