Foundation Models Text Generation API, REST: TextGenerationAsync.completion
A method for generating text completions in asynchronous mode.
HTTP request
POST https://llm.api.cloud.yandex.net/foundationModels/v1/completionAsync
Body parameters
{
"modelUri": "string",
"completionOptions": {
"stream": true,
"temperature": "number",
"maxTokens": "integer"
},
"messages": [
{
"role": "string",
"text": "string"
}
]
}
Request for the service to generate text completion.
Field | Description |
---|---|
modelUri | string The ID of the model to be used for completion generation. |
completionOptions | object Configuration options for completion generation. Defines the options for completion generation. |
completionOptions. stream |
boolean (boolean) Enables streaming of partially generated text. |
completionOptions. temperature |
number (double) Affects creativity and randomness of responses. Should be a double number between 0 (inclusive) and 1 (inclusive). Lower values produce more straightforward responses while higher values lead to increased creativity and randomness. Default temperature: 0.3 |
completionOptions. maxTokens |
integer (int64) The limit on the number of tokens used for single completion generation. Must be greater than zero. This maximum allowed parameter value may depend on the model being used. |
messages[] | object A list of messages representing the context for the completion model. |
messages[]. role |
string The ID of the message sender. Supported roles:
|
messages[]. text |
string Textual content of the message. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |