CreateIndexRequest class

No Description

Annotations

• @freezed

Constructors

CreateIndexRequest({required String name, required int dimension, @Default.new(SearchMetric.cosine) SearchMetric metric, @Default.new(1) int pods, @Default.new(1) int replicas, @JsonKey.new(name: 'pod_type') @Default.new(PodType.p1X1) PodType podType, @JsonKey.new(name: 'metadata_config', includeIfNull: false) Map<String, dynamic>? metadataConfig, @JsonKey.new(name: 'source_collection', includeIfNull: false) String? sourceCollection})

Factory constructor for CreateIndexRequest

const

factory

CreateIndexRequest.fromJson(Map<String, dynamic> json)

Object construction from a JSON representation

factory

Properties

copyWith → $CreateIndexRequestCopyWith<CreateIndexRequest>

no setter, inherited

dimension → int

The dimensions of the vectors to be inserted in the index.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

metadataConfig → Map<String, dynamic>?

Configuration for the behavior of Pinecone's internal metadata index.

no setter, inherited

metric → SearchMetric

The vector similarity metric of the index.

no setter, inherited

name → String

The name of the index to be created.

no setter, inherited

pods → int

The number of pods for the index to use, including replicas.

no setter, inherited

podType → PodType

An enumeration of the available pod types.

no setter, inherited

replicas → int

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceCollection → String?

The name of the collection to create an index from.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

inherited

toMap() → Map<String, dynamic>

Map representation of object (not serialized)

toString() → String

A string representation of this object.

inherited

validateSchema() → String?

Perform validations on the schema property values

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

nameMaxLengthValue → const int

Validation constants

podsDefaultValue → const int

podsMinValue → const int

propertyNames → const List<String>

List of all property names of schema

replicasDefaultValue → const int

replicasMinValue → const int