Vectorize

VectorizeIndexes

List Vectorize Indexes

client.Vectorize.Indexes.List(ctx, query) (*SinglePage[CreateIndex], error)

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

Get Vectorize Index

client.Vectorize.Indexes.Get(ctx, indexName, query) (*CreateIndex, error)

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

Create Vectorize Index

client.Vectorize.Indexes.New(ctx, params) (*CreateIndex, error)

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

Delete Vectorize Index

client.Vectorize.Indexes.Delete(ctx, indexName, body) (*unknown, error)

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

Insert Vectors

client.Vectorize.Indexes.Insert(ctx, indexName, params) (*IndexInsertResponse, error)

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

Query Vectors

client.Vectorize.Indexes.Query(ctx, indexName, params) (*IndexQueryResponse, error)

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

Upsert Vectors

client.Vectorize.Indexes.Upsert(ctx, indexName, params) (*IndexUpsertResponse, error)

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

Delete Vectors By Identifier

client.Vectorize.Indexes.DeleteByIDs(ctx, indexName, params) (*IndexDeleteByIDsResponse, error)

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

Get Vectors By Identifier

client.Vectorize.Indexes.GetByIDs(ctx, indexName, params) (*IndexGetByIDsResponse, error)

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

Get Vectorize Index Info

client.Vectorize.Indexes.Info(ctx, indexName, query) (*IndexInfoResponse, error)

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

List Vectors

client.Vectorize.Indexes.ListVectors(ctx, indexName, params) (*IndexListVectorsResponse, error)

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

ModelsExpand Collapse

type CreateIndex struct{…}

Config IndexDimensionConfigurationoptional

CreatedOn Timeoptional

Specifies the timestamp the resource was created as an ISO8601 string.

formatdate-time

Description stringoptional

Specifies the description of the index.

ModifiedOn Timeoptional

Specifies the timestamp the resource was modified as an ISO8601 string.

formatdate-time

Name stringoptional

type IndexDeleteVectorsByID struct{…}

Count int64optional

The count of the vectors successfully deleted.

IDs []stringoptional

Array of vector identifiers of the vectors that were successfully processed for deletion.

type IndexDimensionConfiguration struct{…}

Dimensions int64

Specifies the number of dimensions for the index

maximum1536

minimum1

Metric IndexDimensionConfigurationMetric

Specifies the type of metric to use calculating distance.

One of the following:

const IndexDimensionConfigurationMetricCosine IndexDimensionConfigurationMetric = "cosine"

const IndexDimensionConfigurationMetricEuclidean IndexDimensionConfigurationMetric = "euclidean"

const IndexDimensionConfigurationMetricDOTProduct IndexDimensionConfigurationMetric = "dot-product"

type IndexInsert struct{…}

Count int64optional

Specifies the count of the vectors successfully inserted.

IDs []stringoptional

Array of vector identifiers of the vectors successfully inserted.

type IndexQuery struct{…}

Count int64optional

Specifies the count of vectors returned by the search

Matches []IndexQueryMatchoptional

Array of vectors matched by the search

ID stringoptional

Identifier for a Vector

maxLength64

Metadata unknownoptional

Score float64optional

The score of the vector according to the index's distance metric

Values []float64optional

type IndexUpsert struct{…}

Count int64optional

Specifies the count of the vectors successfully inserted.

IDs []stringoptional

Array of vector identifiers of the vectors successfully inserted.

VectorizeIndexesMetadata Index

List Metadata Indexes

client.Vectorize.Indexes.MetadataIndex.List(ctx, indexName, query) (*IndexMetadataIndexListResponse, error)

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

Create Metadata Index

client.Vectorize.Indexes.MetadataIndex.New(ctx, indexName, params) (*IndexMetadataIndexNewResponse, error)

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

Delete Metadata Index

client.Vectorize.Indexes.MetadataIndex.Delete(ctx, indexName, params) (*IndexMetadataIndexDeleteResponse, error)

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