Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rasa X Configuration API Calls #4290

Closed
rgstephens opened this issue Aug 20, 2019 · 6 comments
Closed

Rasa X Configuration API Calls #4290

rgstephens opened this issue Aug 20, 2019 · 6 comments
Labels
type:enhancement ✨ Additions of new features or changes to existing ones, should be doable in a single PR

Comments

@rgstephens
Copy link
Contributor

Description of Problem:
There is no API call to get the Rasa X model configuration like there is for environments.

Overview of the Solution:
Add GET and PUT calls for configuration similar to environments.

Definition of Done:

@rgstephens rgstephens added the type:enhancement ✨ Additions of new features or changes to existing ones, should be doable in a single PR label Aug 20, 2019
@sara-tagger
Copy link
Collaborator

Thanks for submitting this feature request 🚀@akelad will get back to you about it soon!✨

@akelad
Copy link
Contributor

akelad commented Aug 21, 2019

@wochinge do you think something like this would make sense to add?

@wochinge
Copy link
Contributor

@rgstephens Great idea! Thanks for helping us to progress with the API. To my knowledge @ricwo has already been working on that.

@ricwo
Copy link
Contributor

ricwo commented Aug 25, 2019

hi @rgstephens, do you mean the NLU / Core model config?

That endpoint exists at GET/PUT /api/projects/<project_id>/settings. I'm not sure why it isn't documented at the moment - we'll be sure to add it again. In the meantime, the schema is the following:

  /projects/{project_id}/settings:
    get:
      tags:
        - Settings
      summary: Fetch model config
      operationId: getConfig
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/api_token'
      responses:
        200:
          description: Model configuration
          content:
            application/json:
              schema:
                type: object
                properties:
                  nlu_config:
                    description: YAML string
                    type: string
        400:
          description: could not find settings
        401:
          $ref: '#/components/responses/UnauthorizedError'
    put:
      tags:
        - Settings
      summary: Save model config
      operationId: saveConfig
      parameters:
        - $ref: '#/components/parameters/projectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                nlu_config:
                  description: YAML string
                  type: string
      responses:
        200:
          description: Saved configuration
          content:
            application/json:
              schema:
                type: object
                properties:
                  nlu_config:
                    description: YAML string
                    type: string
        400:
          description: Could not parse config file
        401:
          description: Config missing mandatory keys
        402:
          description: Could not save config file

@rgstephens
Copy link
Contributor Author

Yes, that's what I was looking for. Thanks!

@stale
Copy link

stale bot commented Feb 3, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the status:stale label Feb 3, 2020
@tmbo tmbo closed this as completed Feb 3, 2020
@tmbo tmbo removed the status:stale label Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement ✨ Additions of new features or changes to existing ones, should be doable in a single PR
Projects
None yet
Development

No branches or pull requests

6 participants