Mandatory vector field causes type errors

[as-celegen]

Upsert Command

vector-js/README.md

Lines 76 to 84 in 801c666

	//Update Data
	await index.upsert({
	id: "upstash-rocks",
	metadata: {
	title: 'Star Wars',
	genre: 'sci-fi',
	category: 'classic'
	}
	});

Here it is shown upsert command can be called without the vector or data fields to update the metadata information in the index but this is not compatible with the defined type for argument of the upsert command in:

vector-js/src/commands/client/upsert/index.ts

Lines 5 to 16 in 801c666

	type VectorPayload<TMetadata> = {
	id: number | string;
	vector: number[];
	metadata?: NoInfer<TMetadata>;
	};
	type DataPayload<TMetadata> = {
	id: number | string;
	data: string;
	metadata?: NoInfer<TMetadata>;
	};
	type PayloadArray<TMetadata> = VectorPayload<TMetadata>[] | DataPayload<TMetadata>[];

vector-js/src/commands/client/upsert/index.ts

Lines 19 to 21 in 801c666

	constructor(
	payload: VectorPayload<TMetadata> | DataPayload<TMetadata> | PayloadArray<TMetadata>
	) {

Fetch, Range, Query

Commands fetch, query and range has a field called "includeVector" in their argument to specify whether vector field will be included in their return value. However their returned type specify vector field as always returned.

vector-js/src/commands/client/types.ts

Lines 1 to 5 in 801c666

	export type Vector<TMetadata = Record<string, unknown>> = {
	id: string;
	vector: number[];
	metadata?: TMetadata;
	};

vector-js/src/commands/client/fetch/index.ts

Lines 4 to 7 in 801c666

	type FetchCommandOptions = {
	includeMetadata?: boolean;
	includeVectors?: boolean;
	};

vector-js/src/commands/client/fetch/index.ts

Line 9 in 801c666

export type FetchResult<TMetadata = Record<string, unknown>> = Vector<TMetadata> | null;

vector-js/src/commands/client/range/index.ts

Lines 4 to 9 in 801c666

	type RangeCommandPayload = {
	cursor: number | string;
	limit: number;
	includeVectors?: boolean;
	includeMetadata?: boolean;
	};

vector-js/src/commands/client/range/index.ts

Lines 11 to 14 in 801c666

	export type RangeResult<TMetadata = Record<string, unknown>> = {
	nextCursor: string;
	vectors: Vector<TMetadata>[];
	};

vector-js/src/commands/client/query/index.ts

Lines 3 to 8 in 801c666

	type QueryCommandPayload = {
	topK: number;
	filter?: string;
	includeVectors?: boolean;
	includeMetadata?: boolean;
	} & ({ vector: number[]; data?: never } | { data: string; vector?: never });

vector-js/src/commands/client/query/index.ts

Lines 10 to 15 in 801c666

	export type QueryResult<TMetadata = Record<string, unknown>> = {
	id: number | string;
	score: number;
	vector: number[];
	metadata?: TMetadata;
	};

[fahreddinozcan]

Hey,

thanks for the heads up here. We'll prioritize this and solve it as soon as possible.

[fahreddinozcan]

Hey, we've fixed the problem with the upsert method. However, there's a problem with the includeVector issue which is caused by TypeScript. We'll work on it and keep you updated.