Index::Create

TODO(infrawhispers) - PENDING

application/json

Request Body required

• name string
• fields string[]
• index_type apiIndexType

  Possible values: [IndexType_UNKNOWN, IndexType_FLAT, IndexType_DiskANNMem]

  Default value: IndexType_UNKNOWN

• metric_type apiMetricType

  Possible values: [MetricType_UNKNOWN, MetricType_COSINE, MetricType_L1, MetricType_L2, MetricType_HAMMING]

  Default value: MetricType_UNKNOWN

• flat_params object

  dimensions int64

  segment_size_kb int64
• embedding_model_name items that are used for the auto-generation of embeddings
• embedding_model_class apiModelClass

  Possible values: [ModelClass_Unknown, ModelClass_CLIP, ModelClass_INSTRUCTOR, ModelClass_E5]

  Default value: ModelClass_Unknown

Responses

• 200
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• object

{}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...