@cloudflare/workers-types 4.20241022.0 → 4.20241106.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2769,7 +2769,7 @@ declare abstract class SqlStorageCursor<
2769
2769
  toArray(): T[];
2770
2770
  one(): T;
2771
2771
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2772
- get columnNames(): string[];
2772
+ columnNames: string[];
2773
2773
  get rowsRead(): number;
2774
2774
  get rowsWritten(): number;
2775
2775
  [Symbol.iterator](): IterableIterator<T>;
@@ -5381,7 +5381,7 @@ interface VectorizeIndexDetails {
5381
5381
  */
5382
5382
  interface VectorizeIndexInfo {
5383
5383
  /** The number of records containing vectors within the index. */
5384
- vectorsCount: number;
5384
+ vectorCount: number;
5385
5385
  /** Number of dimensions the index has been configured for. */
5386
5386
  dimensions: number;
5387
5387
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5506,6 +5506,16 @@ declare abstract class Vectorize {
5506
5506
  vector: VectorFloatArray | number[],
5507
5507
  options?: VectorizeQueryOptions,
5508
5508
  ): Promise<VectorizeMatches>;
5509
+ /**
5510
+ * Use the provided vector-id to perform a similarity search across the index.
5511
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5512
+ * @param options Configuration options to massage the returned data.
5513
+ * @returns A promise that resolves with matched and scored vectors.
5514
+ */
5515
+ public queryById(
5516
+ vectorId: string,
5517
+ options?: VectorizeQueryOptions,
5518
+ ): Promise<VectorizeMatches>;
5509
5519
  /**
5510
5520
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5511
5521
  * @param vectors List of vectors that will be inserted.
@@ -2780,7 +2780,7 @@ export declare abstract class SqlStorageCursor<
2780
2780
  toArray(): T[];
2781
2781
  one(): T;
2782
2782
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2783
- get columnNames(): string[];
2783
+ columnNames: string[];
2784
2784
  get rowsRead(): number;
2785
2785
  get rowsWritten(): number;
2786
2786
  [Symbol.iterator](): IterableIterator<T>;
@@ -5293,7 +5293,7 @@ export interface VectorizeIndexDetails {
5293
5293
  */
5294
5294
  export interface VectorizeIndexInfo {
5295
5295
  /** The number of records containing vectors within the index. */
5296
- vectorsCount: number;
5296
+ vectorCount: number;
5297
5297
  /** Number of dimensions the index has been configured for. */
5298
5298
  dimensions: number;
5299
5299
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5418,6 +5418,16 @@ export declare abstract class Vectorize {
5418
5418
  vector: VectorFloatArray | number[],
5419
5419
  options?: VectorizeQueryOptions,
5420
5420
  ): Promise<VectorizeMatches>;
5421
+ /**
5422
+ * Use the provided vector-id to perform a similarity search across the index.
5423
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5424
+ * @param options Configuration options to massage the returned data.
5425
+ * @returns A promise that resolves with matched and scored vectors.
5426
+ */
5427
+ public queryById(
5428
+ vectorId: string,
5429
+ options?: VectorizeQueryOptions,
5430
+ ): Promise<VectorizeMatches>;
5421
5431
  /**
5422
5432
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5423
5433
  * @param vectors List of vectors that will be inserted.
@@ -2795,7 +2795,7 @@ declare abstract class SqlStorageCursor<
2795
2795
  toArray(): T[];
2796
2796
  one(): T;
2797
2797
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2798
- get columnNames(): string[];
2798
+ columnNames: string[];
2799
2799
  get rowsRead(): number;
2800
2800
  get rowsWritten(): number;
2801
2801
  [Symbol.iterator](): IterableIterator<T>;
@@ -5407,7 +5407,7 @@ interface VectorizeIndexDetails {
5407
5407
  */
5408
5408
  interface VectorizeIndexInfo {
5409
5409
  /** The number of records containing vectors within the index. */
5410
- vectorsCount: number;
5410
+ vectorCount: number;
5411
5411
  /** Number of dimensions the index has been configured for. */
5412
5412
  dimensions: number;
5413
5413
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5532,6 +5532,16 @@ declare abstract class Vectorize {
5532
5532
  vector: VectorFloatArray | number[],
5533
5533
  options?: VectorizeQueryOptions,
5534
5534
  ): Promise<VectorizeMatches>;
5535
+ /**
5536
+ * Use the provided vector-id to perform a similarity search across the index.
5537
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5538
+ * @param options Configuration options to massage the returned data.
5539
+ * @returns A promise that resolves with matched and scored vectors.
5540
+ */
5541
+ public queryById(
5542
+ vectorId: string,
5543
+ options?: VectorizeQueryOptions,
5544
+ ): Promise<VectorizeMatches>;
5535
5545
  /**
5536
5546
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5537
5547
  * @param vectors List of vectors that will be inserted.
@@ -2806,7 +2806,7 @@ export declare abstract class SqlStorageCursor<
2806
2806
  toArray(): T[];
2807
2807
  one(): T;
2808
2808
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2809
- get columnNames(): string[];
2809
+ columnNames: string[];
2810
2810
  get rowsRead(): number;
2811
2811
  get rowsWritten(): number;
2812
2812
  [Symbol.iterator](): IterableIterator<T>;
@@ -5319,7 +5319,7 @@ export interface VectorizeIndexDetails {
5319
5319
  */
5320
5320
  export interface VectorizeIndexInfo {
5321
5321
  /** The number of records containing vectors within the index. */
5322
- vectorsCount: number;
5322
+ vectorCount: number;
5323
5323
  /** Number of dimensions the index has been configured for. */
5324
5324
  dimensions: number;
5325
5325
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5444,6 +5444,16 @@ export declare abstract class Vectorize {
5444
5444
  vector: VectorFloatArray | number[],
5445
5445
  options?: VectorizeQueryOptions,
5446
5446
  ): Promise<VectorizeMatches>;
5447
+ /**
5448
+ * Use the provided vector-id to perform a similarity search across the index.
5449
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5450
+ * @param options Configuration options to massage the returned data.
5451
+ * @returns A promise that resolves with matched and scored vectors.
5452
+ */
5453
+ public queryById(
5454
+ vectorId: string,
5455
+ options?: VectorizeQueryOptions,
5456
+ ): Promise<VectorizeMatches>;
5447
5457
  /**
5448
5458
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5449
5459
  * @param vectors List of vectors that will be inserted.
@@ -2812,7 +2812,7 @@ declare abstract class SqlStorageCursor<
2812
2812
  toArray(): T[];
2813
2813
  one(): T;
2814
2814
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2815
- get columnNames(): string[];
2815
+ columnNames: string[];
2816
2816
  get rowsRead(): number;
2817
2817
  get rowsWritten(): number;
2818
2818
  [Symbol.iterator](): IterableIterator<T>;
@@ -5431,7 +5431,7 @@ interface VectorizeIndexDetails {
5431
5431
  */
5432
5432
  interface VectorizeIndexInfo {
5433
5433
  /** The number of records containing vectors within the index. */
5434
- vectorsCount: number;
5434
+ vectorCount: number;
5435
5435
  /** Number of dimensions the index has been configured for. */
5436
5436
  dimensions: number;
5437
5437
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5556,6 +5556,16 @@ declare abstract class Vectorize {
5556
5556
  vector: VectorFloatArray | number[],
5557
5557
  options?: VectorizeQueryOptions,
5558
5558
  ): Promise<VectorizeMatches>;
5559
+ /**
5560
+ * Use the provided vector-id to perform a similarity search across the index.
5561
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5562
+ * @param options Configuration options to massage the returned data.
5563
+ * @returns A promise that resolves with matched and scored vectors.
5564
+ */
5565
+ public queryById(
5566
+ vectorId: string,
5567
+ options?: VectorizeQueryOptions,
5568
+ ): Promise<VectorizeMatches>;
5559
5569
  /**
5560
5570
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5561
5571
  * @param vectors List of vectors that will be inserted.
@@ -2823,7 +2823,7 @@ export declare abstract class SqlStorageCursor<
2823
2823
  toArray(): T[];
2824
2824
  one(): T;
2825
2825
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2826
- get columnNames(): string[];
2826
+ columnNames: string[];
2827
2827
  get rowsRead(): number;
2828
2828
  get rowsWritten(): number;
2829
2829
  [Symbol.iterator](): IterableIterator<T>;
@@ -5343,7 +5343,7 @@ export interface VectorizeIndexDetails {
5343
5343
  */
5344
5344
  export interface VectorizeIndexInfo {
5345
5345
  /** The number of records containing vectors within the index. */
5346
- vectorsCount: number;
5346
+ vectorCount: number;
5347
5347
  /** Number of dimensions the index has been configured for. */
5348
5348
  dimensions: number;
5349
5349
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5468,6 +5468,16 @@ export declare abstract class Vectorize {
5468
5468
  vector: VectorFloatArray | number[],
5469
5469
  options?: VectorizeQueryOptions,
5470
5470
  ): Promise<VectorizeMatches>;
5471
+ /**
5472
+ * Use the provided vector-id to perform a similarity search across the index.
5473
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5474
+ * @param options Configuration options to massage the returned data.
5475
+ * @returns A promise that resolves with matched and scored vectors.
5476
+ */
5477
+ public queryById(
5478
+ vectorId: string,
5479
+ options?: VectorizeQueryOptions,
5480
+ ): Promise<VectorizeMatches>;
5471
5481
  /**
5472
5482
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5473
5483
  * @param vectors List of vectors that will be inserted.
@@ -2813,7 +2813,7 @@ declare abstract class SqlStorageCursor<
2813
2813
  toArray(): T[];
2814
2814
  one(): T;
2815
2815
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2816
- get columnNames(): string[];
2816
+ columnNames: string[];
2817
2817
  get rowsRead(): number;
2818
2818
  get rowsWritten(): number;
2819
2819
  [Symbol.iterator](): IterableIterator<T>;
@@ -5432,7 +5432,7 @@ interface VectorizeIndexDetails {
5432
5432
  */
5433
5433
  interface VectorizeIndexInfo {
5434
5434
  /** The number of records containing vectors within the index. */
5435
- vectorsCount: number;
5435
+ vectorCount: number;
5436
5436
  /** Number of dimensions the index has been configured for. */
5437
5437
  dimensions: number;
5438
5438
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5557,6 +5557,16 @@ declare abstract class Vectorize {
5557
5557
  vector: VectorFloatArray | number[],
5558
5558
  options?: VectorizeQueryOptions,
5559
5559
  ): Promise<VectorizeMatches>;
5560
+ /**
5561
+ * Use the provided vector-id to perform a similarity search across the index.
5562
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5563
+ * @param options Configuration options to massage the returned data.
5564
+ * @returns A promise that resolves with matched and scored vectors.
5565
+ */
5566
+ public queryById(
5567
+ vectorId: string,
5568
+ options?: VectorizeQueryOptions,
5569
+ ): Promise<VectorizeMatches>;
5560
5570
  /**
5561
5571
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5562
5572
  * @param vectors List of vectors that will be inserted.
@@ -2824,7 +2824,7 @@ export declare abstract class SqlStorageCursor<
2824
2824
  toArray(): T[];
2825
2825
  one(): T;
2826
2826
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2827
- get columnNames(): string[];
2827
+ columnNames: string[];
2828
2828
  get rowsRead(): number;
2829
2829
  get rowsWritten(): number;
2830
2830
  [Symbol.iterator](): IterableIterator<T>;
@@ -5344,7 +5344,7 @@ export interface VectorizeIndexDetails {
5344
5344
  */
5345
5345
  export interface VectorizeIndexInfo {
5346
5346
  /** The number of records containing vectors within the index. */
5347
- vectorsCount: number;
5347
+ vectorCount: number;
5348
5348
  /** Number of dimensions the index has been configured for. */
5349
5349
  dimensions: number;
5350
5350
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5469,6 +5469,16 @@ export declare abstract class Vectorize {
5469
5469
  vector: VectorFloatArray | number[],
5470
5470
  options?: VectorizeQueryOptions,
5471
5471
  ): Promise<VectorizeMatches>;
5472
+ /**
5473
+ * Use the provided vector-id to perform a similarity search across the index.
5474
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5475
+ * @param options Configuration options to massage the returned data.
5476
+ * @returns A promise that resolves with matched and scored vectors.
5477
+ */
5478
+ public queryById(
5479
+ vectorId: string,
5480
+ options?: VectorizeQueryOptions,
5481
+ ): Promise<VectorizeMatches>;
5472
5482
  /**
5473
5483
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5474
5484
  * @param vectors List of vectors that will be inserted.
@@ -2816,7 +2816,7 @@ declare abstract class SqlStorageCursor<
2816
2816
  toArray(): T[];
2817
2817
  one(): T;
2818
2818
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2819
- get columnNames(): string[];
2819
+ columnNames: string[];
2820
2820
  get rowsRead(): number;
2821
2821
  get rowsWritten(): number;
2822
2822
  [Symbol.iterator](): IterableIterator<T>;
@@ -5435,7 +5435,7 @@ interface VectorizeIndexDetails {
5435
5435
  */
5436
5436
  interface VectorizeIndexInfo {
5437
5437
  /** The number of records containing vectors within the index. */
5438
- vectorsCount: number;
5438
+ vectorCount: number;
5439
5439
  /** Number of dimensions the index has been configured for. */
5440
5440
  dimensions: number;
5441
5441
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5560,6 +5560,16 @@ declare abstract class Vectorize {
5560
5560
  vector: VectorFloatArray | number[],
5561
5561
  options?: VectorizeQueryOptions,
5562
5562
  ): Promise<VectorizeMatches>;
5563
+ /**
5564
+ * Use the provided vector-id to perform a similarity search across the index.
5565
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5566
+ * @param options Configuration options to massage the returned data.
5567
+ * @returns A promise that resolves with matched and scored vectors.
5568
+ */
5569
+ public queryById(
5570
+ vectorId: string,
5571
+ options?: VectorizeQueryOptions,
5572
+ ): Promise<VectorizeMatches>;
5563
5573
  /**
5564
5574
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5565
5575
  * @param vectors List of vectors that will be inserted.
@@ -2827,7 +2827,7 @@ export declare abstract class SqlStorageCursor<
2827
2827
  toArray(): T[];
2828
2828
  one(): T;
2829
2829
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2830
- get columnNames(): string[];
2830
+ columnNames: string[];
2831
2831
  get rowsRead(): number;
2832
2832
  get rowsWritten(): number;
2833
2833
  [Symbol.iterator](): IterableIterator<T>;
@@ -5347,7 +5347,7 @@ export interface VectorizeIndexDetails {
5347
5347
  */
5348
5348
  export interface VectorizeIndexInfo {
5349
5349
  /** The number of records containing vectors within the index. */
5350
- vectorsCount: number;
5350
+ vectorCount: number;
5351
5351
  /** Number of dimensions the index has been configured for. */
5352
5352
  dimensions: number;
5353
5353
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5472,6 +5472,16 @@ export declare abstract class Vectorize {
5472
5472
  vector: VectorFloatArray | number[],
5473
5473
  options?: VectorizeQueryOptions,
5474
5474
  ): Promise<VectorizeMatches>;
5475
+ /**
5476
+ * Use the provided vector-id to perform a similarity search across the index.
5477
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5478
+ * @param options Configuration options to massage the returned data.
5479
+ * @returns A promise that resolves with matched and scored vectors.
5480
+ */
5481
+ public queryById(
5482
+ vectorId: string,
5483
+ options?: VectorizeQueryOptions,
5484
+ ): Promise<VectorizeMatches>;
5475
5485
  /**
5476
5486
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5477
5487
  * @param vectors List of vectors that will be inserted.
@@ -2821,7 +2821,7 @@ declare abstract class SqlStorageCursor<
2821
2821
  toArray(): T[];
2822
2822
  one(): T;
2823
2823
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2824
- get columnNames(): string[];
2824
+ columnNames: string[];
2825
2825
  get rowsRead(): number;
2826
2826
  get rowsWritten(): number;
2827
2827
  [Symbol.iterator](): IterableIterator<T>;
@@ -5440,7 +5440,7 @@ interface VectorizeIndexDetails {
5440
5440
  */
5441
5441
  interface VectorizeIndexInfo {
5442
5442
  /** The number of records containing vectors within the index. */
5443
- vectorsCount: number;
5443
+ vectorCount: number;
5444
5444
  /** Number of dimensions the index has been configured for. */
5445
5445
  dimensions: number;
5446
5446
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5565,6 +5565,16 @@ declare abstract class Vectorize {
5565
5565
  vector: VectorFloatArray | number[],
5566
5566
  options?: VectorizeQueryOptions,
5567
5567
  ): Promise<VectorizeMatches>;
5568
+ /**
5569
+ * Use the provided vector-id to perform a similarity search across the index.
5570
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5571
+ * @param options Configuration options to massage the returned data.
5572
+ * @returns A promise that resolves with matched and scored vectors.
5573
+ */
5574
+ public queryById(
5575
+ vectorId: string,
5576
+ options?: VectorizeQueryOptions,
5577
+ ): Promise<VectorizeMatches>;
5568
5578
  /**
5569
5579
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5570
5580
  * @param vectors List of vectors that will be inserted.
@@ -2832,7 +2832,7 @@ export declare abstract class SqlStorageCursor<
2832
2832
  toArray(): T[];
2833
2833
  one(): T;
2834
2834
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2835
- get columnNames(): string[];
2835
+ columnNames: string[];
2836
2836
  get rowsRead(): number;
2837
2837
  get rowsWritten(): number;
2838
2838
  [Symbol.iterator](): IterableIterator<T>;
@@ -5352,7 +5352,7 @@ export interface VectorizeIndexDetails {
5352
5352
  */
5353
5353
  export interface VectorizeIndexInfo {
5354
5354
  /** The number of records containing vectors within the index. */
5355
- vectorsCount: number;
5355
+ vectorCount: number;
5356
5356
  /** Number of dimensions the index has been configured for. */
5357
5357
  dimensions: number;
5358
5358
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5477,6 +5477,16 @@ export declare abstract class Vectorize {
5477
5477
  vector: VectorFloatArray | number[],
5478
5478
  options?: VectorizeQueryOptions,
5479
5479
  ): Promise<VectorizeMatches>;
5480
+ /**
5481
+ * Use the provided vector-id to perform a similarity search across the index.
5482
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5483
+ * @param options Configuration options to massage the returned data.
5484
+ * @returns A promise that resolves with matched and scored vectors.
5485
+ */
5486
+ public queryById(
5487
+ vectorId: string,
5488
+ options?: VectorizeQueryOptions,
5489
+ ): Promise<VectorizeMatches>;
5480
5490
  /**
5481
5491
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5482
5492
  * @param vectors List of vectors that will be inserted.
@@ -2823,7 +2823,7 @@ declare abstract class SqlStorageCursor<
2823
2823
  toArray(): T[];
2824
2824
  one(): T;
2825
2825
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2826
- get columnNames(): string[];
2826
+ columnNames: string[];
2827
2827
  get rowsRead(): number;
2828
2828
  get rowsWritten(): number;
2829
2829
  [Symbol.iterator](): IterableIterator<T>;
@@ -5442,7 +5442,7 @@ interface VectorizeIndexDetails {
5442
5442
  */
5443
5443
  interface VectorizeIndexInfo {
5444
5444
  /** The number of records containing vectors within the index. */
5445
- vectorsCount: number;
5445
+ vectorCount: number;
5446
5446
  /** Number of dimensions the index has been configured for. */
5447
5447
  dimensions: number;
5448
5448
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5567,6 +5567,16 @@ declare abstract class Vectorize {
5567
5567
  vector: VectorFloatArray | number[],
5568
5568
  options?: VectorizeQueryOptions,
5569
5569
  ): Promise<VectorizeMatches>;
5570
+ /**
5571
+ * Use the provided vector-id to perform a similarity search across the index.
5572
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5573
+ * @param options Configuration options to massage the returned data.
5574
+ * @returns A promise that resolves with matched and scored vectors.
5575
+ */
5576
+ public queryById(
5577
+ vectorId: string,
5578
+ options?: VectorizeQueryOptions,
5579
+ ): Promise<VectorizeMatches>;
5570
5580
  /**
5571
5581
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5572
5582
  * @param vectors List of vectors that will be inserted.
@@ -2834,7 +2834,7 @@ export declare abstract class SqlStorageCursor<
2834
2834
  toArray(): T[];
2835
2835
  one(): T;
2836
2836
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2837
- get columnNames(): string[];
2837
+ columnNames: string[];
2838
2838
  get rowsRead(): number;
2839
2839
  get rowsWritten(): number;
2840
2840
  [Symbol.iterator](): IterableIterator<T>;
@@ -5354,7 +5354,7 @@ export interface VectorizeIndexDetails {
5354
5354
  */
5355
5355
  export interface VectorizeIndexInfo {
5356
5356
  /** The number of records containing vectors within the index. */
5357
- vectorsCount: number;
5357
+ vectorCount: number;
5358
5358
  /** Number of dimensions the index has been configured for. */
5359
5359
  dimensions: number;
5360
5360
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5479,6 +5479,16 @@ export declare abstract class Vectorize {
5479
5479
  vector: VectorFloatArray | number[],
5480
5480
  options?: VectorizeQueryOptions,
5481
5481
  ): Promise<VectorizeMatches>;
5482
+ /**
5483
+ * Use the provided vector-id to perform a similarity search across the index.
5484
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5485
+ * @param options Configuration options to massage the returned data.
5486
+ * @returns A promise that resolves with matched and scored vectors.
5487
+ */
5488
+ public queryById(
5489
+ vectorId: string,
5490
+ options?: VectorizeQueryOptions,
5491
+ ): Promise<VectorizeMatches>;
5482
5492
  /**
5483
5493
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5484
5494
  * @param vectors List of vectors that will be inserted.
@@ -2823,7 +2823,7 @@ declare abstract class SqlStorageCursor<
2823
2823
  toArray(): T[];
2824
2824
  one(): T;
2825
2825
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2826
- get columnNames(): string[];
2826
+ columnNames: string[];
2827
2827
  get rowsRead(): number;
2828
2828
  get rowsWritten(): number;
2829
2829
  [Symbol.iterator](): IterableIterator<T>;
@@ -5442,7 +5442,7 @@ interface VectorizeIndexDetails {
5442
5442
  */
5443
5443
  interface VectorizeIndexInfo {
5444
5444
  /** The number of records containing vectors within the index. */
5445
- vectorsCount: number;
5445
+ vectorCount: number;
5446
5446
  /** Number of dimensions the index has been configured for. */
5447
5447
  dimensions: number;
5448
5448
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5567,6 +5567,16 @@ declare abstract class Vectorize {
5567
5567
  vector: VectorFloatArray | number[],
5568
5568
  options?: VectorizeQueryOptions,
5569
5569
  ): Promise<VectorizeMatches>;
5570
+ /**
5571
+ * Use the provided vector-id to perform a similarity search across the index.
5572
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5573
+ * @param options Configuration options to massage the returned data.
5574
+ * @returns A promise that resolves with matched and scored vectors.
5575
+ */
5576
+ public queryById(
5577
+ vectorId: string,
5578
+ options?: VectorizeQueryOptions,
5579
+ ): Promise<VectorizeMatches>;
5570
5580
  /**
5571
5581
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5572
5582
  * @param vectors List of vectors that will be inserted.
@@ -2834,7 +2834,7 @@ export declare abstract class SqlStorageCursor<
2834
2834
  toArray(): T[];
2835
2835
  one(): T;
2836
2836
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2837
- get columnNames(): string[];
2837
+ columnNames: string[];
2838
2838
  get rowsRead(): number;
2839
2839
  get rowsWritten(): number;
2840
2840
  [Symbol.iterator](): IterableIterator<T>;
@@ -5354,7 +5354,7 @@ export interface VectorizeIndexDetails {
5354
5354
  */
5355
5355
  export interface VectorizeIndexInfo {
5356
5356
  /** The number of records containing vectors within the index. */
5357
- vectorsCount: number;
5357
+ vectorCount: number;
5358
5358
  /** Number of dimensions the index has been configured for. */
5359
5359
  dimensions: number;
5360
5360
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5479,6 +5479,16 @@ export declare abstract class Vectorize {
5479
5479
  vector: VectorFloatArray | number[],
5480
5480
  options?: VectorizeQueryOptions,
5481
5481
  ): Promise<VectorizeMatches>;
5482
+ /**
5483
+ * Use the provided vector-id to perform a similarity search across the index.
5484
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5485
+ * @param options Configuration options to massage the returned data.
5486
+ * @returns A promise that resolves with matched and scored vectors.
5487
+ */
5488
+ public queryById(
5489
+ vectorId: string,
5490
+ options?: VectorizeQueryOptions,
5491
+ ): Promise<VectorizeMatches>;
5482
5492
  /**
5483
5493
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5484
5494
  * @param vectors List of vectors that will be inserted.
@@ -2880,7 +2880,7 @@ declare abstract class SqlStorageCursor<
2880
2880
  toArray(): T[];
2881
2881
  one(): T;
2882
2882
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2883
- get columnNames(): string[];
2883
+ columnNames: string[];
2884
2884
  get rowsRead(): number;
2885
2885
  get rowsWritten(): number;
2886
2886
  [Symbol.iterator](): IterableIterator<T>;
@@ -5505,7 +5505,7 @@ interface VectorizeIndexDetails {
5505
5505
  */
5506
5506
  interface VectorizeIndexInfo {
5507
5507
  /** The number of records containing vectors within the index. */
5508
- vectorsCount: number;
5508
+ vectorCount: number;
5509
5509
  /** Number of dimensions the index has been configured for. */
5510
5510
  dimensions: number;
5511
5511
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5630,6 +5630,16 @@ declare abstract class Vectorize {
5630
5630
  vector: VectorFloatArray | number[],
5631
5631
  options?: VectorizeQueryOptions,
5632
5632
  ): Promise<VectorizeMatches>;
5633
+ /**
5634
+ * Use the provided vector-id to perform a similarity search across the index.
5635
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5636
+ * @param options Configuration options to massage the returned data.
5637
+ * @returns A promise that resolves with matched and scored vectors.
5638
+ */
5639
+ public queryById(
5640
+ vectorId: string,
5641
+ options?: VectorizeQueryOptions,
5642
+ ): Promise<VectorizeMatches>;
5633
5643
  /**
5634
5644
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5635
5645
  * @param vectors List of vectors that will be inserted.
@@ -2891,7 +2891,7 @@ export declare abstract class SqlStorageCursor<
2891
2891
  toArray(): T[];
2892
2892
  one(): T;
2893
2893
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2894
- get columnNames(): string[];
2894
+ columnNames: string[];
2895
2895
  get rowsRead(): number;
2896
2896
  get rowsWritten(): number;
2897
2897
  [Symbol.iterator](): IterableIterator<T>;
@@ -5417,7 +5417,7 @@ export interface VectorizeIndexDetails {
5417
5417
  */
5418
5418
  export interface VectorizeIndexInfo {
5419
5419
  /** The number of records containing vectors within the index. */
5420
- vectorsCount: number;
5420
+ vectorCount: number;
5421
5421
  /** Number of dimensions the index has been configured for. */
5422
5422
  dimensions: number;
5423
5423
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5542,6 +5542,16 @@ export declare abstract class Vectorize {
5542
5542
  vector: VectorFloatArray | number[],
5543
5543
  options?: VectorizeQueryOptions,
5544
5544
  ): Promise<VectorizeMatches>;
5545
+ /**
5546
+ * Use the provided vector-id to perform a similarity search across the index.
5547
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5548
+ * @param options Configuration options to massage the returned data.
5549
+ * @returns A promise that resolves with matched and scored vectors.
5550
+ */
5551
+ public queryById(
5552
+ vectorId: string,
5553
+ options?: VectorizeQueryOptions,
5554
+ ): Promise<VectorizeMatches>;
5545
5555
  /**
5546
5556
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5547
5557
  * @param vectors List of vectors that will be inserted.
package/index.d.ts CHANGED
@@ -2769,7 +2769,7 @@ declare abstract class SqlStorageCursor<
2769
2769
  toArray(): T[];
2770
2770
  one(): T;
2771
2771
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2772
- get columnNames(): string[];
2772
+ columnNames: string[];
2773
2773
  get rowsRead(): number;
2774
2774
  get rowsWritten(): number;
2775
2775
  [Symbol.iterator](): IterableIterator<T>;
@@ -5381,7 +5381,7 @@ interface VectorizeIndexDetails {
5381
5381
  */
5382
5382
  interface VectorizeIndexInfo {
5383
5383
  /** The number of records containing vectors within the index. */
5384
- vectorsCount: number;
5384
+ vectorCount: number;
5385
5385
  /** Number of dimensions the index has been configured for. */
5386
5386
  dimensions: number;
5387
5387
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5506,6 +5506,16 @@ declare abstract class Vectorize {
5506
5506
  vector: VectorFloatArray | number[],
5507
5507
  options?: VectorizeQueryOptions,
5508
5508
  ): Promise<VectorizeMatches>;
5509
+ /**
5510
+ * Use the provided vector-id to perform a similarity search across the index.
5511
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5512
+ * @param options Configuration options to massage the returned data.
5513
+ * @returns A promise that resolves with matched and scored vectors.
5514
+ */
5515
+ public queryById(
5516
+ vectorId: string,
5517
+ options?: VectorizeQueryOptions,
5518
+ ): Promise<VectorizeMatches>;
5509
5519
  /**
5510
5520
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5511
5521
  * @param vectors List of vectors that will be inserted.
package/index.ts CHANGED
@@ -2780,7 +2780,7 @@ export declare abstract class SqlStorageCursor<
2780
2780
  toArray(): T[];
2781
2781
  one(): T;
2782
2782
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2783
- get columnNames(): string[];
2783
+ columnNames: string[];
2784
2784
  get rowsRead(): number;
2785
2785
  get rowsWritten(): number;
2786
2786
  [Symbol.iterator](): IterableIterator<T>;
@@ -5293,7 +5293,7 @@ export interface VectorizeIndexDetails {
5293
5293
  */
5294
5294
  export interface VectorizeIndexInfo {
5295
5295
  /** The number of records containing vectors within the index. */
5296
- vectorsCount: number;
5296
+ vectorCount: number;
5297
5297
  /** Number of dimensions the index has been configured for. */
5298
5298
  dimensions: number;
5299
5299
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5418,6 +5418,16 @@ export declare abstract class Vectorize {
5418
5418
  vector: VectorFloatArray | number[],
5419
5419
  options?: VectorizeQueryOptions,
5420
5420
  ): Promise<VectorizeMatches>;
5421
+ /**
5422
+ * Use the provided vector-id to perform a similarity search across the index.
5423
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5424
+ * @param options Configuration options to massage the returned data.
5425
+ * @returns A promise that resolves with matched and scored vectors.
5426
+ */
5427
+ public queryById(
5428
+ vectorId: string,
5429
+ options?: VectorizeQueryOptions,
5430
+ ): Promise<VectorizeMatches>;
5421
5431
  /**
5422
5432
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5423
5433
  * @param vectors List of vectors that will be inserted.
package/oldest/index.d.ts CHANGED
@@ -2769,7 +2769,7 @@ declare abstract class SqlStorageCursor<
2769
2769
  toArray(): T[];
2770
2770
  one(): T;
2771
2771
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2772
- get columnNames(): string[];
2772
+ columnNames: string[];
2773
2773
  get rowsRead(): number;
2774
2774
  get rowsWritten(): number;
2775
2775
  [Symbol.iterator](): IterableIterator<T>;
@@ -5381,7 +5381,7 @@ interface VectorizeIndexDetails {
5381
5381
  */
5382
5382
  interface VectorizeIndexInfo {
5383
5383
  /** The number of records containing vectors within the index. */
5384
- vectorsCount: number;
5384
+ vectorCount: number;
5385
5385
  /** Number of dimensions the index has been configured for. */
5386
5386
  dimensions: number;
5387
5387
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5506,6 +5506,16 @@ declare abstract class Vectorize {
5506
5506
  vector: VectorFloatArray | number[],
5507
5507
  options?: VectorizeQueryOptions,
5508
5508
  ): Promise<VectorizeMatches>;
5509
+ /**
5510
+ * Use the provided vector-id to perform a similarity search across the index.
5511
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5512
+ * @param options Configuration options to massage the returned data.
5513
+ * @returns A promise that resolves with matched and scored vectors.
5514
+ */
5515
+ public queryById(
5516
+ vectorId: string,
5517
+ options?: VectorizeQueryOptions,
5518
+ ): Promise<VectorizeMatches>;
5509
5519
  /**
5510
5520
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5511
5521
  * @param vectors List of vectors that will be inserted.
package/oldest/index.ts CHANGED
@@ -2780,7 +2780,7 @@ export declare abstract class SqlStorageCursor<
2780
2780
  toArray(): T[];
2781
2781
  one(): T;
2782
2782
  raw<U extends SqlStorageValue[]>(): IterableIterator<U>;
2783
- get columnNames(): string[];
2783
+ columnNames: string[];
2784
2784
  get rowsRead(): number;
2785
2785
  get rowsWritten(): number;
2786
2786
  [Symbol.iterator](): IterableIterator<T>;
@@ -5293,7 +5293,7 @@ export interface VectorizeIndexDetails {
5293
5293
  */
5294
5294
  export interface VectorizeIndexInfo {
5295
5295
  /** The number of records containing vectors within the index. */
5296
- vectorsCount: number;
5296
+ vectorCount: number;
5297
5297
  /** Number of dimensions the index has been configured for. */
5298
5298
  dimensions: number;
5299
5299
  /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */
@@ -5418,6 +5418,16 @@ export declare abstract class Vectorize {
5418
5418
  vector: VectorFloatArray | number[],
5419
5419
  options?: VectorizeQueryOptions,
5420
5420
  ): Promise<VectorizeMatches>;
5421
+ /**
5422
+ * Use the provided vector-id to perform a similarity search across the index.
5423
+ * @param vectorId Id for a vector in the index against which the index should be queried.
5424
+ * @param options Configuration options to massage the returned data.
5425
+ * @returns A promise that resolves with matched and scored vectors.
5426
+ */
5427
+ public queryById(
5428
+ vectorId: string,
5429
+ options?: VectorizeQueryOptions,
5430
+ ): Promise<VectorizeMatches>;
5421
5431
  /**
5422
5432
  * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
5423
5433
  * @param vectors List of vectors that will be inserted.
package/package.json CHANGED
@@ -7,5 +7,5 @@
7
7
  },
8
8
  "author": "Cloudflare Workers DevProd Team <workers-devprod@cloudflare.com> (https://workers.cloudflare.com)",
9
9
  "license": "MIT OR Apache-2.0",
10
- "version": "4.20241022.0"
10
+ "version": "4.20241106.0"
11
11
  }