weaviate-client
Preparing search index...
Collections
Interface Collections
interface
Collections
{
create
<
TProperties
extends
Properties
|
undefined
=
undefined
,
TName
=
string
,
TVectors
extends
Vectors
|
undefined
=
undefined
,
>
(
config
:
CollectionConfigCreate
<
TProperties
,
TName
,
TVectors
>
,
)
:
Promise
<
Collection
<
TProperties
,
TName
,
TVectors
>
>
;
createFromJson
(
schemaJson
:
WeaviateClass
,
)
:
Promise
<
Collection
<
Properties
,
string
,
undefined
>
>
;
createFromSchema
(
config
:
WeaviateClass
,
)
:
Promise
<
Collection
<
Properties
,
string
,
undefined
>
>
;
delete
(
collection
:
string
)
:
Promise
<
void
>
;
deleteAll
()
:
Promise
<
void
[]
>
;
exists
(
name
:
string
)
:
Promise
<
boolean
>
;
export
(
name
:
string
)
:
Promise
<
CollectionConfig
>
;
exportToJson
(
name
:
string
)
:
Promise
<
WeaviateClass
>
;
get
<
TProperties
extends
Properties
|
undefined
=
undefined
,
TName
extends
string
=
string
,
>
(
name
:
TName
,
)
:
Collection
<
TProperties
,
TName
>
;
listAll
()
:
Promise
<
CollectionConfig
[]
>
;
use
<
TName
extends
string
=
string
,
TProperties
extends
Properties
|
undefined
=
undefined
,
TVectors
extends
Vectors
|
undefined
=
undefined
,
>
(
name
:
TName
,
)
:
Collection
<
TProperties
,
TName
,
TVectors
>
;
}
Index
Methods
create
create
From
Json
create
From
Schema
delete
delete
All
exists
export
export
To
Json
get
list
All
use
Methods
create
create
<
TProperties
extends
Properties
|
undefined
=
undefined
,
TName
=
string
,
TVectors
extends
Vectors
|
undefined
=
undefined
,
>
(
config
:
CollectionConfigCreate
<
TProperties
,
TName
,
TVectors
>
,
)
:
Promise
<
Collection
<
TProperties
,
TName
,
TVectors
>
>
Type Parameters
TProperties
extends
Properties
|
undefined
=
undefined
TName
=
string
TVectors
extends
Vectors
|
undefined
=
undefined
Parameters
config
:
CollectionConfigCreate
<
TProperties
,
TName
,
TVectors
>
Returns
Promise
<
Collection
<
TProperties
,
TName
,
TVectors
>
>
create
From
Json
createFromJson
(
schemaJson
:
WeaviateClass
,
)
:
Promise
<
Collection
<
Properties
,
string
,
undefined
>
>
Parameters
schemaJson
:
WeaviateClass
Returns
Promise
<
Collection
<
Properties
,
string
,
undefined
>
>
create
From
Schema
createFromSchema
(
config
:
WeaviateClass
,
)
:
Promise
<
Collection
<
Properties
,
string
,
undefined
>
>
Parameters
config
:
WeaviateClass
Returns
Promise
<
Collection
<
Properties
,
string
,
undefined
>
>
delete
delete
(
collection
:
string
)
:
Promise
<
void
>
Parameters
collection
:
string
Returns
Promise
<
void
>
delete
All
deleteAll
()
:
Promise
<
void
[]
>
Returns
Promise
<
void
[]
>
exists
exists
(
name
:
string
)
:
Promise
<
boolean
>
Parameters
name
:
string
Returns
Promise
<
boolean
>
export
export
(
name
:
string
)
:
Promise
<
CollectionConfig
>
Parameters
name
:
string
Returns
Promise
<
CollectionConfig
>
export
To
Json
exportToJson
(
name
:
string
)
:
Promise
<
WeaviateClass
>
Parameters
name
:
string
Returns
Promise
<
WeaviateClass
>
get
get
<
TProperties
extends
Properties
|
undefined
=
undefined
,
TName
extends
string
=
string
,
>
(
name
:
TName
,
)
:
Collection
<
TProperties
,
TName
>
Type Parameters
TProperties
extends
Properties
|
undefined
=
undefined
TName
extends
string
=
string
Parameters
name
:
TName
Returns
Collection
<
TProperties
,
TName
>
list
All
listAll
()
:
Promise
<
CollectionConfig
[]
>
Returns
Promise
<
CollectionConfig
[]
>
use
use
<
TName
extends
string
=
string
,
TProperties
extends
Properties
|
undefined
=
undefined
,
TVectors
extends
Vectors
|
undefined
=
undefined
,
>
(
name
:
TName
,
)
:
Collection
<
TProperties
,
TName
,
TVectors
>
Type Parameters
TName
extends
string
=
string
TProperties
extends
Properties
|
undefined
=
undefined
TVectors
extends
Vectors
|
undefined
=
undefined
Parameters
name
:
TName
Returns
Collection
<
TProperties
,
TName
,
TVectors
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
create
create
From
Json
create
From
Schema
delete
delete
All
exists
export
export
To
Json
get
list
All
use
weaviate-client
Loading...