CreateGreenVectors

Green Vectors is a product which makes vector storage more efficient while providing more accurate and faster search capability.

Add new vectors

POST /vectors

This endpoint is used to convert existing vector embeddings into a faceted vector embedding.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <your token>

Request Body

Attribute Parameters

• facet_vectors array (required) A array containing existing facets with facet names mapped to their current vector embeddings. ONLY provide this array for existing facets returned from our response. When converting a database, there will most likely be no existing facets. For the first call to our system, this attribute can be an empty array (see the initial call example below). Our response will contain the new facet and a vector. For subsequent calls, this facet and vector will be merged into for new input vectors.

  • facet string (required)

    The name of the existing facet.

  • vector object (required)

  This will be the existing facet vector. The input vector will be merged into this vector

  • count int (required)

    The number of vectors merged into this facet.

  • average_weight float (required)

    The average of all weights that have been merged into the vector. For example, if the facet contains 10 vectors and the weight for each vector was .5, the average would be .5

• input_vectors array (required) An array of vector objects being merged to a facet.

  • vector object (required) This will be the input vector. This vector can be merged into multiple facets by adding the facet name and its weight pertaining to that facet.

  • facet_weights dictionary object (required) It's possible for a vector to be merged into multiple facets by adding the facet name and its weight pertaining to that facet. If a vector is part of multiple facets, provide the name of each facet and the weight of this vector pertaining to that facet

{
  "facet_vectors": [
    {
      "facet": "example_facet_1",
      "vector": [0.1, 0.2, 0.3],
      "count": 100,
      "average_weight": 0.5
    }
  ],
  "input_vectors": [
    {
      "vector": [0.2, 0.3, 0.4],
      "facet_weights": {
        "example_facet_1": 0.5 // the weight of this vector pertaining to this facet
        ......  // other facet names if vector belongs to multiple facets
      }
    },
    {
      "vector": [0.3, 0.4, 0.5],
      "facet_weights": {
        "example_facet_1": 0.7 // the weight of this vector pertaining to this facet
        ......  // other facet names if vector belongs to multiple facets
      }
    }
  ]
}

Example - Initial Call Request

{
  "facet_vectors": [],
  "input_vectors": [
    {
      "vector": [0.2, 0.3, 0.4],
      "facet_weights": {
        "Clothing": 0.5
      }
    },
    {
      "vector": [0.3, 0.4, 0.5],
      "facet_weights": {
        "Clothing": 0.7
      }
    }
  ]
}

Example - Initial Call Response

200

{
    "Clothing": [0.19500001, 0.29500002, 0.395]
}

400

{
    "error": {
        "type": "invalid_request",
        "message": "Error message"
    }
}

Example - Subsequent Call Request for Clothing facet

{
  "facet_vectors": {
    "facet": "Clothing",
    "vector": [0.19500001, 0.29500002, 0.395],// the above response from initial call
    "count": 2, // the number of vectors merged into this facet
    "average_weight": 0.6 // (.5 + .7) / 2
  },
  "input_vectors": [
    {
      "vector": [0.2, 0.3, 0.4],
      "facet_weights": {
        "Clothing": 0.5
      }
    }
  ]
}

Example - Subsequent Call Response for merged Clothing facet

200

{
    "Clothing": [0.85400001, 0.3435002, 0.5454544]
}