types

Documentation

Overview

Copyright © 2021 Rasa Technologies GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Rasa Technologies GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• type AuthEndpointResponse
• type DatabaseMigrationSpec
• type EnvironmentSpec
• type EnvironmentsConfigurationFile
• type EnvironmentsConfigurationSpec
• type EnvironmentsEndpointRequest
• type HealthEndpointsResponse
• type ModelSpec
• type ModelsListEndpointResponse
• type RasaSpec
• type RasaSpecEnvironments
• type VersionEndpointResponse

Constants

const (
	// RasaXKubernetesConfigMapName stores the config map name that stores configuration files for Rasa X deployment.
	RasaXKubernetesConfigMapName string = "rasa-x-configuration-files"
)

Types

type AuthEndpointResponse

type AuthEndpointResponse struct {
	AccessToken string `json:"access_token"`
}

type DatabaseMigrationSpec

type DatabaseMigrationSpec struct {
	Status            string  `json:"status"`
	ProgressInPercent float32 `json:"progress_in_percent"`
}

DatabaseMigrationSpec stores specification for a database migration response.

type EnvironmentSpec

type EnvironmentSpec struct {
	Version                  string `json:"version"`
	MinimumCompatibleVersion string `json:"minimum_compatible_version"`
	Status                   int    `json:"status"`
}

EnvironmentSpec stores specification for a Rasa X / Enterprise environment.

type EnvironmentsConfigurationFile

type EnvironmentsConfigurationFile struct {
	Rasa RasaSpecEnvironments `yaml:"rasa"`
}

EnvironmentConfigurationFile specifies the environment.yaml configuration file for Rasa OSS.

type EnvironmentsConfigurationSpec

type EnvironmentsConfigurationSpec struct {
	URL   string `yaml:"url"`
	Token string `yaml:"token"`
}

EnvironmentsConfugrationSpec stores specification or a given environment.

type EnvironmentsEndpointRequest

type EnvironmentsEndpointRequest struct {
	Name  string `json:"name"`
	URL   string `json:"url"`
	Token string `json:"token"`
}

EnvironmentsEndpointRequest stores a request specification for the environment's endpoint.

type HealthEndpointsResponse

type HealthEndpointsResponse struct {
	DatabaseMigration DatabaseMigrationSpec `json:"database_migration"`
	Worker            EnvironmentSpec       `json:"worker"`
	Production        EnvironmentSpec       `json:"production"`
}

HealthEndpointsResponse stores a response for the /api/health endpoint.

type ModelSpec

type ModelSpec struct {
	Model        string   `json:"model"`
	Hash         string   `json:"hash"`
	TrainedAt    float64  `json:"trained_at"`
	Version      string   `json:"version"`
	Tags         []string `json:"tags"`
	IsCompatible bool     `json:"is_compatible"`
}

type ModelsListEndpointResponse

type ModelsListEndpointResponse struct {
	Models []ModelSpec
}

type RasaSpec

type RasaSpec struct {
	Production string `json:"production"`
	Worker     string `json:"worker"`
}

RasaSpec stores specification for the production and worker version.

type RasaSpecEnvironments

type RasaSpecEnvironments struct {
	Production EnvironmentsConfigurationSpec `yaml:"production"`
	Worker     EnvironmentsConfigurationSpec `yaml:"worker"`
}

RasaSpecEnvironments stores specification for the production and worker environment.

type VersionEndpointResponse

type VersionEndpointResponse struct {
	Rasa       RasaSpec `json:"rasa"`
	RasaX      string   `json:"rasa-x"`
	Enterprise bool     `json:"enterprise"`
}

VersionEndpointResponse stores a response from the /api/version endpoint.