ListWorkspaces

Lists workspaces in a namespace.

Query Parameters
namespace string

Namespace from which workspaces are listed.

Response Body
playbooks Playbook[]

Listed workspaces

namespace string

Namespace of the workspace.

id string

Unique identifier of the workspace generated by the server.

name string

User visible given name of the workspace.

conversation_sets ScopedReference[]

Optional list of conversation sets ids that are to be included inside conversations

namespace string

Namespace of the referenced object.

id string

Unique identifier of the referenced object.

base_language string

Base language of the workspace. If empty, 'en' is assumed. 2 letters ISO 639-1 or BCP47 locale format (ex: 'en-US')

active_languages string[]

Languages that can be used in the workspace, on top of the base language. 2 letters ISO 639-1 or BCP47 locale format (ex: 'en-US')

nlu NluSettings
id string

Unique identifier of the NLU engine in the workspace.

engine_version string

Version of the specified NLU engine. Since multiple deployments are feasible, this specifies the exact image which will be used when using an external NLU engine. This parameter has no impact for the internal engine.

is_default boolean

Internally managed flag to indicate that this is the default engine of the workspace. This should not be modified via the API as it is enforced by the backend.

seq_id uint32

Internally managed non-zero unique sequential number assigned to the engine. This should not be modified via the API as it is enforced by the backend.

on_demand boolean

Only use the NLU engine when it is explicitely triggered. Useful to prevent expensive NLU engines (ex: DialogFlow) from being triggered automatically.

max_retry UInt32Value

Wrapper message for uint32. The JSON representation for UInt32Value is JSON number.

value uint32

The uint32 value.

integration_id string

(Optional) Unique identifier of the integration if the NLU engine is linked to an external integration.

training_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

intent_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

internal NluEngineInternal
rasa NluEngineRasa
pipeline_config string

Contents of the config.yml to be used for training

dialogflow_cx NluEngineDialogflowCx
project_id string

GCP project of the agent.

location string

GCP location of the agent (ex: northamerica-northeast1) If empty, global is assumed.

credential_id string

The id of the GCP credential to use

huggingface NluEngineHuggingFace
base_model string

The base model to start from. See https://huggingface.co/models The model needs to use a supported architecture and support TensorFlow (currently) e.g bert-base-uncased

config_json string

(Optional) A json configuration to be merged with the base model's default configuration

training_args_json string

(Optional) A json object containing training (hyper-) parameters

other_nlus NluSettings[]

Settings of other NLU engines that the workspace can use.

id string

Unique identifier of the NLU engine in the workspace.

engine_version string

Version of the specified NLU engine. Since multiple deployments are feasible, this specifies the exact image which will be used when using an external NLU engine. This parameter has no impact for the internal engine.

is_default boolean

Internally managed flag to indicate that this is the default engine of the workspace. This should not be modified via the API as it is enforced by the backend.

seq_id uint32

Internally managed non-zero unique sequential number assigned to the engine. This should not be modified via the API as it is enforced by the backend.

on_demand boolean

Only use the NLU engine when it is explicitely triggered. Useful to prevent expensive NLU engines (ex: DialogFlow) from being triggered automatically.

max_retry UInt32Value

Wrapper message for uint32. The JSON representation for UInt32Value is JSON number.

value uint32

The uint32 value.

integration_id string

(Optional) Unique identifier of the integration if the NLU engine is linked to an external integration.

training_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

intent_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

internal NluEngineInternal
rasa NluEngineRasa
pipeline_config string

Contents of the config.yml to be used for training

dialogflow_cx NluEngineDialogflowCx
project_id string

GCP project of the agent.

location string

GCP location of the agent (ex: northamerica-northeast1) If empty, global is assumed.

credential_id string

The id of the GCP credential to use

huggingface NluEngineHuggingFace
base_model string

The base model to start from. See https://huggingface.co/models The model needs to use a supported architecture and support TensorFlow (currently) e.g bert-base-uncased

config_json string

(Optional) A json configuration to be merged with the base model's default configuration

training_args_json string

(Optional) A json object containing training (hyper-) parameters

evaluation EvaluationSettings
default_parameters EvaluationParameters
intent_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

k_fold KFold
num_folds uint32

Number of folds

phrase_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

test_set TestSet
phrase_tag_predicate TagPredicate
require_ids string[]

Only include objects with ALL of the given tag ids.

include_ids string[]

Only include objects with ANY of the given tag ids.

exclude_ids string[]

Exclude objects with ANY of the given tag ids.

nlu_id string

Optional unique identifier of the NLU engine to use in the workspace. If none specified, the workspace's default configured NLU engine will be used. See zia.ai.pipeline.v1alpha1.NluSettings.id

creation_time RFC3339

Time at which the playbook got created. Added in Feb 2021, so all playbook created before that won't have the field populated.