Cloudflare.VectorizeIndex (Cloudflare v0.5.0)

Copy Markdown View Source

Vectorize

Create Vectorize Index

POST /accounts/{account_id}/vectorize/v2/indexes

Creates and returns a new Vectorize Index.

Responses

200 Create Vectorize Index Response

Data is at body["result"]

{
  "config": {
    "dimensions": "*integer*",
    "metric": "*string*"
  },
  "created_on": "*string*",
  "description": "*string*",
  "modified_on": "*string*",
  "name": "*string*"
}
4XX Create Vectorize Index Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

List Vectorize Indexes

GET /accounts/{account_id}/vectorize/v2/indexes

Returns a list of Vectorize Indexes

Responses

200 List Vectorize Index Response

Data is at body["result"]

[
  {
    "config": {
      "dimensions": null,
      "metric": null
    },
    "created_on": "*string*",
    "description": "*string*",
    "modified_on": "*string*",
    "name": "*string*"
  }
]
4XX List Vectorize Index Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get Vectorize Index

GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}

Returns the specified Vectorize Index.

Responses

200 Get Vectorize Index Response

Data is at body["result"]

{
  "config": {
    "dimensions": "*integer*",
    "metric": "*string*"
  },
  "created_on": "*string*",
  "description": "*string*",
  "modified_on": "*string*",
  "name": "*string*"
}
4XX Get Vectorize Index Failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete Vectorize Index

DELETE /accounts/{account_id}/vectorize/v2/indexes/{index_name}

Deletes the specified Vectorize Index.

Responses

200 Delete Vectorize Index Response

Data is at body["result"]

{}
4XX Delete Vectorize Index Failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete Vectors By Identifier

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids

Delete a set of vectors from an index by their vector identifiers.

Responses

200 Delete Vector Identifiers Response

Data is at body["result"]

{
  "mutationId": null
}
4XX Delete Vector Identifiers Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get Vectors By Identifier

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids

Get a set of vectors from an index by their vector identifiers.

Responses

200 Get Vectors By Identifier Response

Data is at body["result"]

[
  {
    "id": "*string*",
    "metadata": {},
    "namespace": "*string*",
    "values": [
      "*number*"
    ]
  }
]
4XX Get Vectors By Identifier Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get Vectorize Index Info

GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/info

Get information about a vectorize index.

Responses

200 Get Vectorize Index Info Response

Data is at body["result"]

{
  "dimensions": "*integer*",
  "processedUpToDatetime": "*string*",
  "processedUpToMutation": null,
  "vectorCount": "*integer*"
}
4XX Get Vectorize Index Info Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Insert Vectors

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert

Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.

Responses

200 Insert Vectors Response

Data is at body["result"]

{
  "mutationId": null
}
4XX Insert Vectors Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

List Vectors

GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/list

Returns a paginated list of vector identifiers from the specified index.

Responses

200 List Vectors Response

Data is at body["result"]

{
  "count": "*integer*",
  "cursorExpirationTimestamp": "*string*",
  "isTruncated": "*boolean*",
  "nextCursor": "*string*",
  "totalCount": "*integer*",
  "vectors": [
    {
      "id": "*string*"
    }
  ]
}
4XX List Vectors Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Create Metadata Index

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create

Enable metadata filtering based on metadata property. Limited to 10 properties.

Responses

200 Create Metadata Index Response

Data is at body["result"]

{
  "mutationId": null
}
4XX Create Metadata Index Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete Metadata Index

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete

Allow Vectorize to delete the specified metadata index.

Responses

200 Delete Metadata Index Response

Data is at body["result"]

{
  "mutationId": null
}
4XX Delete Metadata Index Failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

List Metadata Indexes

GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list

List Metadata Indexes for the specified Vectorize Index.

Responses

200 List Metadata Index Response

Data is at body["result"]

{
  "metadataIndexes": [
    {
      "indexType": "*string*",
      "propertyName": "*string*"
    }
  ]
}
4XX List Metadata Index Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Query Vectors

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/query

Finds vectors closest to a given vector in an index.

Responses

200 Query Vectors Response

Data is at body["result"]

{
  "count": "*integer*",
  "matches": [
    {
      "id": "*string*",
      "metadata": {},
      "namespace": "*string*",
      "score": "*number*",
      "values": [
        "*number*"
      ]
    }
  ]
}
4XX Query Vectors Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Upsert Vectors

POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert

Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.

Responses

200 Upsert Vectors Response

Data is at body["result"]

{
  "mutationId": null
}
4XX Upsert Vectors Failure Response
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Summary

Functions

client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
delete(id, opts \\ [])
delete!(id, opts \\ [])
delete_by_ids(id, body, opts \\ [])

Deletes vectors by their identifiers.

index(opts \\ [])
index!(opts \\ [])
info(id, opts \\ [])

Gets info about an index (vector count, dimensions, etc.)

insert(id, body, opts \\ [])

Inserts vectors into the specified index.

path_for(id, opts \\ [])
query(id, body, opts \\ [])

Queries vectors closest to a given vector in an index.

show(id, opts \\ [])
show!(id, opts \\ [])
upsert(id, body, opts \\ [])

Upserts vectors into the specified index.

Functions

client(opts \\ [])

@spec client(Restlax.Resource.action_options()) :: module()

create(body, opts \\ [])

@spec create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}

create!(body, opts \\ [])

@spec create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()

delete(id, opts \\ [])

@spec delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

delete!(id, opts \\ [])

@spec delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

delete_by_ids(id, body, opts \\ [])

Deletes vectors by their identifiers.

index(opts \\ [])

@spec index(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

index!(opts \\ [])

@spec index!(opts :: Restlax.Resource.action_options()) :: map() | no_return()

info(id, opts \\ [])

Gets info about an index (vector count, dimensions, etc.)

insert(id, body, opts \\ [])

Inserts vectors into the specified index.

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

query(id, body, opts \\ [])

Queries vectors closest to a given vector in an index.

show(id, opts \\ [])

@spec show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

show!(id, opts \\ [])

@spec show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

upsert(id, body, opts \\ [])

Upserts vectors into the specified index.