Text Generation

AI Text Generation

Generating text for an object description

post

Generates a text based on a prompt. Currently, the supported AI engine for the text generation is https://platform.openai.com/.

---

Prerequisite: Using the AI service requires an API token, you have to either configure your own OpenAI account, or use the Emporix one. To configure your own OpenAI token, use the configuration service by storing the token under openAiApiToken key.

If you don't provide your own OpenAI token, the Emporix one is used with the following limits: 3 mln input tokens and 1 mln output tokens. When you reach the limit, the next requests are rejected and you have to provide your own OpenAI token. Emporix uses the gpt-4o-mini model by default. If you want to use your own OpenAI account with a different AI model please contact our Emporix Support Team to negotiate the model and usage.

Required scopes

This endpoint requires the following scopes:

• : Needed to execute actions related to the text generation.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Body

application/json

Represents a request body for a text generation operation.

idstringOptional

Identifier of the request. The value is not mandatory - if provided, the ID is returned in the text generation response.

promptstringRequired

A prompt to AI engine. A desired text content is generated based on the prompt.

maxTokensintegerOptional

Maximum number of tokens that should be used during text generation. If not provided, then 4097 is used.

Responses

200Success

application/json

Object represents the text generation response.

idstringOptional

Identifier of the text generation request. The value is populated only if the ID was provided in the request.

resultstringOptional

Text generation result.

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

500

A server-side error occurred.

application/json

post

/ai-service/{tenant}/texts

HTTPcURLJavaScriptPython

POST /ai-service/{tenant}/texts HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "id": "en",
  "prompt": "Generate a long description for product 'pipe cutter' in language EN ",
  "maxTokens": 2048
}

{
  "id": "en",
  "result": "Mini pipe cutters are small cutting tools that are designed to precisely and effectively cut through pipes ranging in size from 3 to 16 millimeters. Unlike some larger pipe cutters, these mini versions are conveniently small and light enough to be carried around easily and used in places where a standard-sized cutter may not be able to fit. They are typically made of hardened steel and are designed to work on most types of tubing and thin-walled plastic piping. The continuous interlocking jaws hold the pipe securely while the cutting blade smoothly and accurately creates a precise and neat cutting edge. Mini pipe cutters are the perfect tool for plumbers and those tackling smaller scale pipe work in hard-to-reach places."
}