Foundation Models Text Generation API, gRPC: TokenizerService.TokenizeCompletion
RPC method for tokenizing content of CompletionRequest
gRPC request
rpc TokenizeCompletion (CompletionRequest) returns (TokenizeResponse)
CompletionRequest
{
"model_uri": "string",
"completion_options": {
"stream": "bool",
"temperature": "google.protobuf.DoubleValue",
"max_tokens": "google.protobuf.Int64Value",
"reasoning_options": {
"mode": "ReasoningMode"
}
},
"messages": [
{
"role": "string",
// Includes only one of the fields `text`, `tool_call_list`, `tool_result_list`
"text": "string",
"tool_call_list": {
"tool_calls": [
{
// Includes only one of the fields `function_call`
"function_call": {
"name": "string",
"arguments": "google.protobuf.Struct"
}
// end of the list of possible fields
}
]
},
"tool_result_list": {
"tool_results": [
{
// Includes only one of the fields `function_result`
"function_result": {
"name": "string",
// Includes only one of the fields `content`
"content": "string"
// end of the list of possible fields
}
// end of the list of possible fields
}
]
}
// end of the list of possible fields
}
],
"tools": [
{
// Includes only one of the fields `function`
"function": {
"name": "string",
"description": "string",
"parameters": "google.protobuf.Struct"
}
// end of the list of possible fields
}
],
// Includes only one of the fields `json_object`, `json_schema`
"json_object": "bool",
"json_schema": {
"schema": "google.protobuf.Struct"
}
// end of the list of possible fields
}
Request for the service to generate text completion.
|
Field |
Description |
|
model_uri |
string The ID of the model to be used for completion generation. |
|
completion_options |
Configuration options for completion generation. |
|
messages[] |
A list of messages representing the context for the completion model. |
|
tools[] |
List of tools that are available for the model to invoke during the completion generation. |
|
json_object |
bool When set to true, the model will respond with a valid JSON object. Includes only one of the fields Specifies the format of the model's response. |
|
json_schema |
Enforces a specific JSON structure for the model's response based on a provided schema. Includes only one of the fields Specifies the format of the model's response. |
CompletionOptions
Defines the options for completion generation.
|
Field |
Description |
|
stream |
bool Enables streaming of partially generated text. |
|
temperature |
Affects creativity and randomness of responses. Should be a double number between 0 (inclusive) and 1 (inclusive). |
|
max_tokens |
The limit on the number of tokens used for single completion generation. |
|
reasoning_options |
Configures reasoning capabilities for the model, allowing it to perform internal reasoning before responding. |
ReasoningOptions
Represents reasoning options that enable the model's ability to perform internal reasoning before generating a response.
|
Field |
Description |
|
mode |
enum ReasoningMode Specifies the reasoning mode to be used.
|
Message
A message object representing a wrapper over the inputs and outputs of the completion model.
|
Field |
Description |
|
role |
string The ID of the message sender. Supported roles:
|
|
text |
string Textual content of the message. Includes only one of the fields Message content. |
|
tool_call_list |
List of tool calls made by the model as part of the response generation. Includes only one of the fields Message content. |
|
tool_result_list |
List of tool results returned from external tools that were invoked by the model. Includes only one of the fields Message content. |
ToolCallList
Represents a list of tool calls.
|
Field |
Description |
|
tool_calls[] |
A list of tool calls to be executed. |
ToolCall
Represents a call to a tool.
|
Field |
Description |
|
function_call |
Represents a call to a function. Includes only one of the fields |
FunctionCall
Represents the invocation of a function with specific arguments.
|
Field |
Description |
|
name |
string The name of the function being called. |
|
arguments |
The structured arguments passed to the function. |
ToolResultList
Represents a list of tool results.
|
Field |
Description |
|
tool_results[] |
A list of tool results. |
ToolResult
Represents the result of a tool call.
|
Field |
Description |
|
function_result |
Represents the result of a function call. Includes only one of the fields |
FunctionResult
Represents the result of a function call.
|
Field |
Description |
|
name |
string The name of the function that was executed. |
|
content |
string The result of the function call, represented as a string. Includes only one of the fields |
Tool
Represents a tool that can be invoked during completion generation.
|
Field |
Description |
|
function |
Represents a function that can be called. Includes only one of the fields |
FunctionTool
Represents a function tool that can be invoked during completion generation.
|
Field |
Description |
|
name |
string The name of the function. |
|
description |
string A description of the function's purpose or behavior. |
|
parameters |
A JSON Schema that defines the expected parameters for the function. |
JsonSchema
Represents the expected structure of the model's response using a JSON Schema.
|
Field |
Description |
|
schema |
The JSON Schema that the model's output must conform to. |
TokenizeResponse
{
"tokens": [
{
"id": "int64",
"text": "string",
"special": "bool"
}
],
"model_version": "string"
}
Response containing tokenized content from request.
|
Field |
Description |
|
tokens[] |
A list of tokens obtained from tokenization. |
|
model_version |
string Model version (changes with model releases). |
Token
Represents a token, the basic unit of content, used by the foundation model.
|
Field |
Description |
|
id |
int64 An internal token identifier. |
|
text |
string The textual representation of the token. |
|
special |
bool Indicates whether the token is special or not. Special tokens may define the model's behavior and are not visible to users. |