weaviate-client
Preparing search index...
core/src
IWeaviateClient
Interface IWeaviateClient<TMedia>
interface
IWeaviateClient
<
TMedia
=
any
>
{
alias
:
Aliases
;
backup
:
Backup
;
close
:
()
=>
Promise
<
void
>
;
cluster
:
Cluster
;
collections
:
ICollections
<
TMedia
>
;
getConnectionDetails
:
()
=>
Promise
<
ConnectionDetails
>
;
getMeta
:
()
=>
Promise
<
{
grpcMaxMessageSize
?:
number
;
hostname
?:
string
;
modules
?:
{
[
key
:
string
]:
unknown
}
;
version
?:
string
;
}
,
>
;
getOpenIDConfig
?:
()
=>
Promise
<
any
>
;
getWeaviateVersion
:
()
=>
Promise
<
DbVersion
>
;
groups
:
Groups
;
isLive
:
()
=>
Promise
<
boolean
>
;
isReady
:
()
=>
Promise
<
boolean
>
;
oidcAuth
?:
OidcAuthenticator
;
roles
:
Roles
;
tokenize
:
Tokenize
;
users
:
Users
;
}
Type Parameters
TMedia
=
any
Index
Properties
alias
backup
close
cluster
collections
get
Connection
Details
get
Meta
get
Open
ID
Config?
get
Weaviate
Version
groups
is
Live
is
Ready
oidc
Auth?
roles
tokenize
users
Properties
alias
alias
:
Aliases
backup
backup
:
Backup
close
close
:
()
=>
Promise
<
void
>
cluster
cluster
:
Cluster
collections
collections
:
ICollections
<
TMedia
>
get
Connection
Details
getConnectionDetails
:
()
=>
Promise
<
ConnectionDetails
>
get
Meta
getMeta
:
()
=>
Promise
<
{
grpcMaxMessageSize
?:
number
;
hostname
?:
string
;
modules
?:
{
[
key
:
string
]:
unknown
}
;
version
?:
string
;
}
,
>
Optional
get
Open
ID
Config
getOpenIDConfig
?:
()
=>
Promise
<
any
>
get
Weaviate
Version
getWeaviateVersion
:
()
=>
Promise
<
DbVersion
>
groups
groups
:
Groups
is
Live
isLive
:
()
=>
Promise
<
boolean
>
is
Ready
isReady
:
()
=>
Promise
<
boolean
>
Optional
oidc
Auth
oidcAuth
?:
OidcAuthenticator
roles
roles
:
Roles
tokenize
tokenize
:
Tokenize
users
users
:
Users
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
alias
backup
close
cluster
collections
get
Connection
Details
get
Meta
get
Open
ID
Config
get
Weaviate
Version
groups
is
Live
is
Ready
oidc
Auth
roles
tokenize
users
weaviate-client
Loading...