3.1_External_interfaces - SofiAlfonso/Odissea GitHub Wiki

Input

Register form:

It is stored on SQL data base, here are going to be registered some basic information of the user. It contains name (String), origin language and country (String), email address (String), password (String). All data must be consistence and without any corruption, so then, the system could use the correct information, and users could get into the page without any problem. Response time needs to be at most of 1 minute. The register form is also related to:

  1. The login because both works together to allow users get into the page
  2. The visited country and language input because this information is added to the register form or changed when the user wants it.
  3. The exchange response, because the register form provides the information of origin currency.
  4. The text input, because the information of the language of this text comes from here.

It will appear as a usual register form. For example:

image

User needs to press register button and write valid information into the text boxes mentioned above. System is going to ask for this information via get request. When user end the registration process a java Script message will appear (“Registered Successfully”).

Login:

This interface will receive by users their email (string) and password (text) to allow them get into their accounts. The accuracy of this information needs to be as higher as possible. And also it needs to be processed at most in 1 minute. It will look as the register form but just with the fields specified above. As the next example:

image

It is related with the Register form cause of the users count access. At the end a Java Script message appear bringing welcome.

Text input:

This is where the user writes the input text that they want to translate. The input comes from the strings (text of any length) entered by the user, input should be get instantly and the software should process every well-written string. Text box for input. This interface is related to the selected language as input, and the translated text as output, it is also related with their formulary register where the users native language is defined. The end message is the translated text.

Interface Example:

image

Audio:

This will be the audio file the user wants to transcribe and translate. The app can recognize several audio file types, including MP3, WAV, and AAC. When the user initiates the recording by pushing a button on home page, a message on the screen will display, "Recording has started”. Its time of response needs to be of less than 30 seconds. It is related to text input because the audio will be converted to a text input.

Button example:

image

Image:

This is where the user uploads an image file that they want to scan and translate. The input comes from various image formats, including JPEG, PNG, BMP, TIFF, and GIF. The uploaded image should be processed instantly by the software to extract and translate any text within the image. The user can select their image file using an upload button. The interface includes a progress bar to indicate the status of the upload and processing. This interface is related to the user's selected language for translation and the extracted text from the image as output. It is also connected to the registration form where the user's native language is defined.

Interface Example:

image

Exchange Input:

If the user wishes to make a currency conversion, they can enter the amount they want to exchange. The app will allow them to select their native currency and will then calculate the exact amount in the destination currency based on up-to-date exchange rates. The information from the user's origin and visited country, stored in the SQL database, and the API responses will assist in this process.

API Request:

It contains all the information the AI’s API is going to give about suggestions (String), recommendations(String) and other data like places(String) and the value for some currency exchanges(Int). The information brinded by AI needs to be accurate because this will interact with user and its important to avoid misunderstandings and problems that this information could generate to the user stay on the visited country. Its response could be given at most on 5 minutes. Also, this interface is related with the AI output, the text translator cause of the information of the text and suggestions, and with the origin country and language input and Register form cause of the currency exchange information. To make the connection, the user will press the button that corresponds to the function he wants, and then the system will request the API function. It doesn’t have end message.

Buttons examples:

image
image
image
image

Visited country and language:

The user will fill both inputs whenever he (she) wants to change the data of the place being visited. So, then every time the user get into the page, the translations, suggestions and currency exchange will be configured with their last country and language selection. These fields are very tolerable, cause user can change them many times so its function isn’t delicate. To full fill these fields the user has to press a button on the home page and enter on the text boxes inside the dropdown interface the strings correspondent to visited country and language talked on that country. It is related to the text output cause it brings the language to be translated to, exchange response, and with register form because this data is going to be added or update frequently to the user information.

Interface Example:

image

Output

Text output:

Is going to be the translated text (String) the user will receive. It needs to be highly accurate because is the main function of the software. The access to this must be almost instant, it couldn’t delay more than 1 minute, because users need fast translations during a conversation or other situations. It is related to the register form cause of the origin information, also, to the visited country and language because it is the language in which this text is going to be written, and with the text input cause is the text that the system is translating. This is going to be visible on a text box in front of text input, for example:

image

Java Script Response:

It is a dropdown window that is going to appear on the user register or login, it will contain text (Strings) like “Your account has been successfully created” or “Welcome to Odissea translator”. User will receive it when he (she) get into the home page or complete his (her) registration, so it is related to registration form and login. It will appear almost immediately after the described actions. The format of this, is an alert from Java Script. It will look similar to this:

image

API Responses:

Are going to be the recommendations and suggestions (Strings) the user will receive of AI. Those will appear on a dropdown interface the user is going to request through a button. The information there needs to be highly accurate to avoid misunderstandings, but the answer doesn’t needs to be extremely fast, it could have a response time of around 1 minute. It is related to API request. t will looks like the next example:

image

Exchange response:

is going to be an int answer that the view interface is going to send for the currency exchange request made by a user. It needs to be accurate because user needs to know precisely the value of money he (she) is exchanging. Because of this the response time also needs to be fast, at most of 30 seconds. It is related to Visted country and language because of the information about the country that is being visited, and the API responses because it is in charge of give the exchange rate. The response will appear in a dropdown interface similar to this:

image