AI Assistants API, gRPC: AssistantService.Get
Retrieve details of a specific assistant by its ID.
gRPC request
rpc Get (GetAssistantRequest) returns (Assistant)
GetAssistantRequest
{
"assistant_id": "string"
}
Request message for retrieving an assistant by ID.
|
Field |
Description |
|
assistant_id |
string Required field. ID of the assistant to retrieve. |
Assistant
{
"id": "string",
"folder_id": "string",
"name": "string",
"description": "string",
"created_by": "string",
"created_at": "google.protobuf.Timestamp",
"updated_by": "string",
"updated_at": "google.protobuf.Timestamp",
"expiration_config": {
"expiration_policy": "ExpirationPolicy",
"ttl_days": "int64"
},
"expires_at": "google.protobuf.Timestamp",
"labels": "map<string, string>",
"model_uri": "string",
"instruction": "string",
"prompt_truncation_options": {
"max_prompt_tokens": "google.protobuf.Int64Value"
},
"completion_options": {
"max_tokens": "google.protobuf.Int64Value",
"temperature": "google.protobuf.DoubleValue"
},
"tools": [
{
// Includes only one of the fields `search_index`
"search_index": {
"search_index_ids": [
"string"
],
"max_num_results": "google.protobuf.Int64Value"
}
// end of the list of possible fields
}
]
}
Assistant represents an AI assistant configuration with various settings and metadata.
|
Field |
Description |
|
id |
string Unique identifier of the assistant. |
|
folder_id |
string ID of the folder that the assistant belongs to. |
|
name |
string Name of the assistant. |
|
description |
string Description of the assistant. |
|
created_by |
string Identifier of the subject who created this assistant. |
|
created_at |
Timestamp representing when the assistant was created. |
|
updated_by |
string Identifier of the subject who last updated this assistant. |
|
updated_at |
Timestamp representing the last time this assistant was updated. |
|
expiration_config |
Configuration for the expiration of the assistant, defining when and how the assistant will expire. |
|
expires_at |
Timestamp representing when the assistant will expire. |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the assistant. |
|
model_uri |
string The ID of the model to be used for completion generation. |
|
instruction |
string Instructions or guidelines that the assistant should follow when generating responses or performing tasks. |
|
prompt_truncation_options |
Configuration options for truncating the prompt when the token count exceeds a specified limit. |
|
completion_options |
Configuration options for completion generation. |
|
tools[] |
List of tools that the assistant can use to perform additional tasks. |
ExpirationConfig
|
Field |
Description |
|
expiration_policy |
enum ExpirationPolicy
|
|
ttl_days |
int64 |
PromptTruncationOptions
Defines the options for truncating thread messages within a prompt.
|
Field |
Description |
|
max_prompt_tokens |
The maximum number of tokens allowed in the prompt. |
CompletionOptions
Defines the options for completion generation.
|
Field |
Description |
|
max_tokens |
The limit on the number of tokens used for single completion generation. |
|
temperature |
Affects creativity and randomness of responses. Should be a double number between 0 (inclusive) and 1 (inclusive). |
Tool
Represents a general tool that can be one of several types.
|
Field |
Description |
|
search_index |
SearchIndexTool tool that performs search across specified indexes. Includes only one of the fields |
SearchIndexTool
Configures a tool that enables Retrieval-Augmented Generation (RAG) by allowing the assistant to search across a specified search index.
|
Field |
Description |
|
search_index_ids[] |
string A list of search index IDs that this tool will query. Currently, only a single index ID is supported. |
|
max_num_results |
The maximum number of results to return from the search. |