You are on page 1of 3

openAPI: 3.0.

0
info:
title: MetaForge Scheduler API
description: This API allows for the creation of metallurgical engineering
support completions.
version: 1.0.0
servers:
- url: https://metaforge-scheduler.com/v1
description: MetaForge Scheduler API server
paths:
/schedulability:
post:
operationId: createSchedulabilitySupport
summary: Creates a schedulability support completion for metallurgical
engineering.
description: |
This endpoint allows you to create a schedulability support completion with
the MetaForge Scheduler API,
specifying the model and the engineering query.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
model:
type: string
example: metaforge-scheduler-v1
description: The model ID to use for the support completion.
query:
type: string
example: What is the optimal temperature for forging titanium
alloys?
description: The engineering query to use for generating the
support completion.
temperature:
type: number
format: float
example: 0.5
description: Controls randomness in the generation. Optional.
max_tokens:
type: number
example: 150
description: The maximum number of tokens to generate. Optional.
top_p:
type: number
format: float
example: 1
description: Nucleus sampling. Optional.
frequency_penalty:
type: number
format: float
example: 0.1
description: Penalty for frequency. Optional.
presence_penalty:
type: number
format: float
example: 0.1
description: Penalty for presence. Optional.
required:
- model
- query
responses:
"200":
description: Successfully created the schedulability support completion.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier of the support completion
request.
object:
type: string
description: Object type, which is
"engineering_support_completion".
created:
type: integer
format: int64
description: UNIX timestamp of when the support completion was
created.
model:
type: string
description: Model used for the support completion.
choices:
type: array
items:
type: object
properties:
text:
type: string
description: The generated engineering support
completion.
index:
type: integer
format: int32
description: Index of the choice.
logprobs:
type: object
description: Optional. The log probabilities of the
tokens.
finish_reason:
type: string
description: Reason why the generation was stopped.

{
"model": "gpt-4",
"prompt": "Create a single-page website with HTML, CSS, and JavaScript that
showcases various interactive features such as drop-down menus and dynamic
information display. Include inline comments explaining the code.",
"temperature": 0.7,
"max_tokens": 1024,
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"best_of": 1,
"n": 1,
"stop": ["<YOUR_STOP_SEQUENCE>"]
}

Please replace <YOUR_STOP_SEQUENCE> with the sequence at which you want the
generation to stop.

You might also like