Kg add vectorize doc (#42)

* Added VectorizeDoc

* api report + added couple public tags

Author: toptobes

etc/astra-db-ts.api.md

@@ -175,7 +175,6 @@ export type Caller = [name: string, version?: string];
 // @public
 export class Collection<Schema extends SomeDoc = SomeDoc> {
     // Warning: (ae-forgotten-export) The symbol "DataAPIHttpClient" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "CollectionSpawnOptions" needs to be exported by the entry point index.d.ts
     //
     // @internal
     constructor(db: Db, httpClient: DataAPIHttpClient, name: string, opts: CollectionSpawnOptions | undefined);
@@ -232,6 +231,12 @@ export interface CollectionOptions<Schema extends SomeDoc> {
     vector?: VectorOptions;
 }
 
+// @public
+export interface CollectionSpawnOptions extends WithNamespace {
+    defaultMaxTimeMS?: number;
+    embeddingApiKey?: string;
+}
+
 // @public
 export abstract class CommandEvent {
     // Warning: (ae-forgotten-export) The symbol "DataAPIRequestInfo" needs to be exported by the entry point index.d.ts
@@ -1170,6 +1175,11 @@ export interface VectorDoc {
     $vector?: number[];
 }
 
+// @public
+export interface VectorizeDoc {
+    $vectorize: string;
+}
+
 // @alpha
 export interface VectorizeServiceOptions {
     authentication?: Record<string, string | undefined>;

src/data-api/errors.ts

@@ -17,7 +17,7 @@ import type { DeleteManyResult } from '@/src/data-api/types/delete/delete-many';
 import type { UpdateManyResult } from '@/src/data-api/types/update/update-many';
 import type { BulkWriteResult } from '@/src/data-api/types/misc/bulk-write';
 import type { CuratedAPIResponse, RawDataAPIResponse, ResponseInfo } from '@/src/api';
-import { SomeDoc } from '@/src/data-api/document';
+import { SomeDoc } from '@/src/data-api/types/document';
 
 /**
  * An object representing a single "soft" (2XX) error returned from the Data API, typically with an error code and a

src/data-api/index.ts

@@ -15,7 +15,6 @@
 
 export * from './collection';
 export * from './cursor';
-export * from './document';
 export { Db } from './db';
 export {
   DataAPITimeoutError,

src/data-api/types/collections/spawn-collection.ts

@@ -16,6 +16,8 @@ import { WithNamespace } from '@/src/data-api';
 
 /**
  * Options for spawning a new collection.
+ *
+ * @public
  */
 export interface CollectionSpawnOptions extends WithNamespace {
   /**

src/data-api/document.ts renamed to src/data-api/types/document.ts

@@ -24,15 +24,17 @@
 export type SomeDoc = Record<string, any>;
 
 /**
- * Base type for a document that wishes to leverage vector capabilities.
+ * Base type for a document that wishes to leverage raw vector capabilities.
  * 
  * @example
  * ```
  * export interface Idea extends VectorDoc {
+ *   category: string,
  *   idea: string,
  * }
  * 
  * db.collection<Idea>('ideas').insertOne({
+ *   category: 'doors',
  *   idea: 'Upside down doors',
  *   $vector: [.23, .05, .95, .83, .42],
  * });
@@ -46,3 +48,27 @@ export interface VectorDoc {
    */
   $vector?: number[],
 }
+
+/**
+ * Base type for a document that wishes to leverage automatic vectorization (assuming the collection is vectorize-enabled).
+ *
+ * @example
+ * ```
+ * export interface Idea extends VectorizeDoc {
+ *   category: string,
+ * }
+ *
+ * db.collection<Idea>('ideas').insertOne({
+ *   category: 'doors',
+ *   $vectorize: 'Upside down doors',
+ * });
+ * ```
+ *
+ * @public
+ */
+export interface VectorizeDoc {
+  /**
+   * A string field to be automatically vectorized
+   */
+  $vectorize: string,
+}

src/data-api/types/index.ts

@@ -18,6 +18,7 @@ export { CreateCollectionOptions } from './collections/create-collection';
 export { ListCollectionsOptions, FullCollectionInfo } from './collections/list-collection';
 export * from './collections/drop-collection';
 export * from './collections/command';
+export * from './collections/spawn-collection';
 export { DeleteManyResult } from './delete/delete-many';
 export { DeleteOneResult, DeleteOneOptions } from './delete/delete-one';
 export { FindOptions } from './find/find';
@@ -37,4 +38,5 @@ export * from './common';
 export * from './dot-notation';
 export * from './filter';
 export * from './update-filter';
+export * from './document';
 export { WithId, MaybeId, FoundDoc, NoId, Flatten, IdOf } from './utils';

tests/typing/collections/prelude.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 import { Collection, VectorDoc } from '@/src/data-api';
-import { SomeDoc } from '@/src/data-api/document';
+import { SomeDoc } from '@/src/data-api/types/document';
 import { Db } from '@/src/data-api/db';
 
 export interface TestSchema extends VectorDoc {