Interface EmbeddingProviderModelParameterInfo

Info about any additional, arbitrary parameter the model may take in. May or may not be required.

Passed into the parameters block in VectorizeServiceOptions (except for vectorDimension, which should be set in the upper-level dimension: number field).

Example

// openai.parameters[1]
{
  name: 'vectorDimension',
  type: 'number',
  required: true,
  defaultValue: '1536',
  validation: { numericRange: [2, 1536] },
  help: 'Vector dimension to use in the database and when calling OpenAI.',
}

Field

name - The name of the parameter to be passed in.

Field

type - The datatype of the parameter.

Field

required - Whether the parameter is required to be passed in.

Field

defaultValue - The default value of the provider, or an empty string if there is none.

Field

validation - Validations that may be done on the inputted value.

Field

help - Any additional help text/information about the parameter.

See

  • EmbeddingProviderInfo
  • EmbeddingProviderModelInfo
interface EmbeddingProviderModelParameterInfo {
    defaultValue: string;
    help: string;
    name: string;
    required: boolean;
    type: string;
    validation: Record<string, unknown>[];
}

Hierarchy (view full)

Properties

defaultValue help name required type validation

Properties

defaultValue

defaultValue: string

The default value of the provider, or an empty string if there is none.

Will always be in string form (even if the type is 'number').

Example

// huggingface.parameters[0].defaultValue
''

help

help: string

Any additional help text/information about the parameter.

Example

// huggingface.parameters[0].help
'The name of your Hugging Face dedicated endpoint, the first part of the Endpoint URL.'

name

name: string

The name of the parameter to be passed in.

The one exception is the vectorDimension parameter, which should be passed into the dimension field of the vector block in CollectionVectorOptions/TableVectorColumnDefinition.

Example

// huggingface.parameters[0].name
endpointName

required

required: boolean

Whether the parameter is required to be passed in.

Example

// huggingface.parameters[0].required
true

type

type: string

The datatype of the parameter.

Commonly number or STRING.

Example

// huggingface.parameters[0].type
STRING

validation

validation: Record<string, unknown>[]

Validations that may be done on the inputted value.

Commonly either an empty record, or { numericRange: [<min>, <max>] }.

Example

// huggingface.parameters[0].validation
{}

Settings

Member Visibility

Theme

On This Page

defaultValuehelpnamerequiredtypevalidation