Highschool Teacher

Aerospace Engineer

Response

AIToolResponse

AIToolsEndpointName

**Define examples for teh {0} endpoint.**

**Atrributes:**
- examples: List of examples for the {0} endpoint. Can post these examples to the {0} endpoint without
    modification.

Inherit from ExamplesResponse:

**Base Response for all examples endpoints.**

**Attributes:**
- example_names: The names of the examples. This is to be used as parallel list 
    to the examples defined in child classes.

Examplenames

**Define the model for the request body for {0} endpoint.**

**Atrributes:**
- text: The text to generate a catchy title for.

**AI Instructions:**


**Base for all AI Instructions.**

- tone: The tone of the AI. This is used to determine the tone of the AI's instructions. Each
    class that inherits from this class should define the default tone for the AI and 
    provide instructions on what the tone should impact in the the response.

CatchyTitleCreatorRequest

Examples

CatchyTitleCreatorExamplesResponse

The creativity of the titles. More creativity may be more inspiring but less accurate while less creativity may be more accurate but less inspiring.

Creativity (0 = Least Creative, 100 = Most Creative)

The number of titles that you want to generate.

Number of Titles/Names to Generate

These can help your title perform better for SEO (e.g. 'how to', 'best', 'top', 'ultimate', 'ultimate guide', etc.).

Keywords to Include

The target audience for the title (e.g. children, adults, teenagers, public, superiors, etc.)

Target Audience

This can be the text you are generating titles for (article, notes, etc.), or if you are generating names for something (pet, company name, etc.), you can describe what the name is for.

Text or Description

Tone

The expected tone of the generated titles.

Tone of the Titles/Names

This can literally be anything. (eg. company, coffee shop, song, documentary, social media post, etc.)

What's the Titles/Names For?

**Define the model for the response body for {0} examples endpoint.**

Inherits from ExamplesResponse:

**Base Response for all examples endpoints.**

**Attributes:**
- example_names: The names of the examples. This is to be used as parallel list 
    to the examples defined in child classes.

**Define the model for the request body for {0} endpoint.**

**Atrributes:**
- resume: The resume to generate a cover letter for.
- job_posting: The job posting to generate a cover letter for.
- skills_to_highlight_from_resume: The skills to highlight from the resume.

**AI Instructions:**

CoverLetterWriterRequest

CoverLetterWriterExamplesResponse

The name of the company you are applying to.

Company Name

The job posting to generate a cover letter for.

Job Posting

Your resume. Don't worry too much if the formatting isn't perfect.

Resume

What are your strengths? What skills do you have that are most relevant to the job posting?

Skills to Highlight from Resume

The tone used when writing the cover letter.

Tone of the Cover Letter

**Define the model for the request body for the feedback endpoint.**

**Atrributes:**
- user_prompt_feedback_context: The context of the user prompt that the feedback is for.
    Any of the AI tool request models can be used here. (templates or sandbox)
- ai_response_feedback_context: The context of the AI response that the feedback is for.
    Any of the AI tool response models can be used here. (templates or sandbox)
- star_rating: The star rating left by the user.
- written_feedback: Any written feedback left by the user.

Airesponsefeedbackcontext

Rating

Userpromptfeedbackcontext

Writtenfeedback

FeedbackRequest

ValidationError

Detail

HTTPValidationError

RevisionType

**Define example starter prompts for sandbox-chatgpt endpoint.**

**Example:**
* example_names: ["How to Cook Ramen"] 


* examples: ["I want to cook ramen. What ingredients do I need?"]

**Attributes:**
**example_names:** List of example names. 


**examples:** List of corresponding example prompts.

SandBoxChatGPTExamplesResponse

## Define the request body for sandbox-chatgpt endpoint.

When a conversation is started, the client should send a request with a conversation_id and an empty prompt.
The response will contain the initial prompt from the model. The client should then send a request with the 
conversation_id for each subsequent prompt. The prompt should only include the user's response to the model's 
prompt.

### Example Conversation:
* Request 1: {"conversation_id": "id", "prompt": ""}


* Response 1: {"gpt_response": "Hi, how are you?"}


* Request 2: {"conversation_id": "id", "prompt": "I'm good, how are you?"}


* Response 2: {"gpt_response": "I'm good, thanks for asking."}



### Attributes:
    conversation_uuid: A unique identifier for the conversation (generated by the client)
    user_message: The prompt to send to the model. The prompt should only include the user's response to the model's prompt.

Conversationuuid

Usermessage

SandBoxChatGPTRequest

Gptresponse

SandBoxChatGPTResponse

**Define the model for the request body for the subscription endpoint.**

**Atrributes:**
- email: The user email address to subscribe.

Emailaddress

SubscriptionRequest

SummarySectionLength

**Define examples for the text-revisor endpoint.**

**Attributes:**
- examples: A list of TextRevisorRequest objects. Can post these examples to the text-revisor endpoint without
    modification.

Inherit from ExamplesResponse:

**Base Response for all examples endpoints.**

**Attributes:**
- example_names: The names of the examples. This is to be used as parallel list 
    to the examples defined in child classes.

**Define the model for the request body for {0} endpoint.**

**Attributes:**
* text_to_revise: The text to revise. This can literally be any block of text.

**AI Instructions:**

TextRevisorRequest

TextRevisorExamplesResponse

The creativity of the revision. Lower creativity tends to be more similar to the original text while higher creativity tends to be more different from the original text.

The types of revisions that you should make to the text. This is helpful if you don't want a ton of changes made to your writing.

Revision Types

The text to revise. This can literally be any block of text. (e.g. blog post, article, song lyrics, etc.)

Text to Revise

The tone that the revised text should have.

Tone of the Revision

**Define the model for the response body for the text-revisor endpoint.**

Revisedtext

TextRevisorResponse

**Base Response for all examples endpoints.**

**Attributes:**
- example_names: The names of the examples. This is to be used as parallel list 
    to the examples defined in child classes.

**Base for all AI Instructions.**

- tone: The tone of the AI. This is used to determine the tone of the AI's instructions. Each
    class that inherits from this class should define the default tone for the AI and 
    provide instructions on what the tone should impact in the the response.

TextSummarizerRequest

TextSummarizerExampleResponse

Whether or not to include a bullet points section in the response. Action items are often applicable for meeting notes, lectures, etc.

Include Action Items Section

Whether or not to include a bullet points section in the response.

Include Bullet Points Section

This controls the relative length of the summary paragraph.

Length of Summary Section

The text that you wanted summarized. (e.g. articles, notes, transcripts, etc.)

Text to Summarize

Tone of the Response

Define the model for the client error response.

Login

Message

TokensExhaustedResponse

Location

Error Type


This is the API for the AI for U project. It is a collection of endpoints that
use OpenAI's GPT-3 API to generate text. All requests must include a uuid header.
This uuid is used to check if the user is authenticated and to track usage of the API.


FastAPI

**Get examples for the {0} endpoint.**

This method returns a list of examples for the {0} endpoint. These examples can be posted to the {0} endpoint 
without modification.

**Generate a cover letter for a resume and job posting.**

This method takes a resume and job posting as input and generates a cover letter for the resume and job posting.

**POST User feedback for an AI tool.**

This method is used to record user feedback for the AI tools. This method 
returns an empty response with a 200 status code if the feedback is logged 
successfully.

Get response from openAI Turbo GPT-3 model.

Args:
    sandbox_chatgpt_request: Request containing conversation_id and prompt.

Returns:
    gpt_response: Response from openAI Turbo GPT-3 model.

Get examples for sandbox-chatgpt.

Returns:
    examples: Examples for sandbox-chatgpt.

**POST User subscription for the app.**

This method is used to record user subscriptions for the AI tools. This method 
returns an empty response with a 200 status code if the subscription is logged 
successfully.

**Get examples for the {0} endpoint.**

This method returns examples for the {0} endpoint. These examples can be posted to the {0} endpoint
without modification.

Return examples for the text summarizer endpoint.

Back to Templates

Examples