Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface ModelInfoSupportedParameter

    Describes a parameter supported by the model, including parameter value constraints.

    ModelInfoSupportedParameter

    interface ModelInfoSupportedParameter {
        _default?: ModelInfoSupportedParameterDefault;
        allowedValues?: ModelInfoSupportedParameterAllowedValuesInner[];
        max?: number;
        min?: number;
        parameter: string;
        required: boolean;
        type: string;
        valueType: string;
    }
    Index

    ModelInfoSupportedParameter

    The allowed parameter values when the type is 'one_of'.

    ModelInfoSupportedParameter

    max?: number

    The maximum allowed value (inclusive) when the type is 'numeric_range'.

    ModelInfoSupportedParameter

    min?: number

    The minimum allowed value (inclusive) when the type is 'numeric_range'.

    ModelInfoSupportedParameter

    parameter: string

    The name of the parameter.

    ModelInfoSupportedParameter

    required: boolean

    Whether the parameter is required (true) or optional (false).

    ModelInfoSupportedParameter

    type: string

    The parameter type e.g. 'one_of', 'numeric_range', or 'any'.

    If the type is 'one_of', then 'allowed_values' will be set, and the value specified must be one of the allowed values. 'one_of' is only compatible with value_type 'string' or 'integer'.

    If 'numeric_range', then 'min' and 'max' will be set, then the value specified must adhere to the value_type and must fall within the [min, max] range (inclusive).

    If 'any' then any value is allowed, as long as it adheres to the value_type.

    ModelInfoSupportedParameter

    valueType: string

    The type of value the parameter accepts, e.g. 'string', 'integer', 'float', or 'boolean'.

    ModelInfoSupportedParameter