YandexGPT API, gRPC: TextGenerationAsyncService.Instruct

Статья создана

Yandex Cloud

Обновлена 17 октября 2024 г.

gRPC request
InstructRequest
GenerationOptions
operation.Operation
InstructResponse
Alternative

RPC method for instructing the model to generate text.

gRPC request

rpc Instruct (InstructRequest) returns (operation.Operation)

InstructRequest

{
  "model": "string",
  "generationOptions": {
    "partialResults": "bool",
    "temperature": "google.protobuf.DoubleValue",
    "maxTokens": "google.protobuf.Int64Value"
  },
  // Includes only one of the fields `instructionText`, `instructionUri`
  "instructionText": "string",
  "instructionUri": "string",
  // end of the list of possible fields
  // Includes only one of the fields `requestText`
  "requestText": "string"
  // end of the list of possible fields
}

Request for instructing the model to generate text.

Field	Description
model	string The name or identifier of the model to be used for text generation. Possible value for now: `general`.
generationOptions	GenerationOptions Configuration options for text generation.
instructionText	string The text-based instruction for text generation. Includes only one of the fields `instructionText`, `instructionUri`. Text precondition or context of the request. For example, if the instruction is "You are the youngest Nobel laureate", the request text might be "Tell us about your daily routine".
instructionUri	string A URI containing instructions for text generation. Includes only one of the fields `instructionText`, `instructionUri`. Text precondition or context of the request. For example, if the instruction is "You are the youngest Nobel laureate", the request text might be "Tell us about your daily routine".
requestText	string The text-based request for text generation. Includes only one of the fields `requestText`. Request for text generation.

GenerationOptions

Defines the options for text generation.

Field	Description
partialResults	bool Enables streaming of partially generated text.
temperature	google.protobuf.DoubleValue 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.
maxTokens	google.protobuf.Int64Value Sets the maximum limit on the total number of tokens used for both the input prompt and the generated response. Must be greater than zero and not exceed 7400 tokens.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "alternatives": [
      {
        "text": "string",
        "score": "double",
        "numTokens": "int64"
      }
    ],
    "numPromptTokens": "int64"
  }
  // 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	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any 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	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	InstructResponse 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. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

InstructResponse

Response containing generated text alternatives and token count.

Field

Description

alternatives[]

Alternative

A list of alternative text responses.

numPromptTokens

int64

The number of tokens used in the prompt, including both the instructionText and requestText.

Alternative

Represents an alternative generated response, including its score and token count.

Field	Description
text	string The generated text response.
score	double The score or confidence of the generated text.
numTokens	int64 The number of tokens in the generated response.

YandexGPT API, gRPC: TextGenerationAsyncService.Instruct

gRPC requestgRPC request

InstructRequestInstructRequest

GenerationOptionsGenerationOptions

operation.Operationoperation.Operation

InstructResponseInstructResponse

AlternativeAlternative