Class ZVecCollectionSchema

constructor

• new ZVecCollectionSchema(
      params: {
          name: string;
          vectors: ZVecVectorSchema | ZVecVectorSchema[];
          fields?: ZVecFieldSchema | ZVecFieldSchema[];
      },
  ): ZVecCollectionSchema

  Creates a new collection schema.

  Parameters

  • params: {
        name: string;
        vectors: ZVecVectorSchema | ZVecVectorSchema[];
        fields?: ZVecFieldSchema | ZVecFieldSchema[];
    }

    An object containing the name, vectors, and optional fields.

    • name: string

      The name of the collection.

    • vectors: ZVecVectorSchema | ZVecVectorSchema[]

      An array of vector schemas, or a single vector schema object.

    • Optionalfields?: ZVecFieldSchema | ZVecFieldSchema[]

      An optional array of scalar field schemas, or a single scalar field schema object.

  Returns ZVecCollectionSchema

field

• field(fieldName: string): ZVecFieldSchema

  Retrieves a scalar field schema by its name.

  Parameters

  • fieldName: string

    The name of the field to retrieve.

  Returns ZVecFieldSchema

  The ZVecFieldSchema object.

  Throws

  Error if the field with the given name is not found.

vector

• vector(vectorName: string): ZVecVectorSchema

  Retrieves a vector field schema by its name.

  Parameters

  • vectorName: string

    The name of the vector field to retrieve.

  Returns ZVecVectorSchema

  The ZVecVectorSchema object.

  Throws

  Error if the vector field with the given name is not found.

fields

• fields(): ZVecFieldSchema[]

  Gets the array of scalar field schemas.

  Returns ZVecFieldSchema[]

  The array of ZVecFieldSchema objects.

vectors

• vectors(): ZVecVectorSchema[]

  Gets the array of vector field schemas.

  Returns ZVecVectorSchema[]

  The array of ZVecVectorSchema objects.

toString

• toString(): string

  Returns string

  A formatted string representation of the collection schema.

Readonlyname