AI Assistants API, REST: Assistant.List

Field

Description

folderId

string

Required field. Folder ID from which to list assistants.

pageSize

string (int64)

Maximum number of assistants to return per page.

pageToken

string

Token to retrieve the next page of results.

Field

Description

assistants[]

Assistant

List of assistants in the specified folder.

nextPageToken

string

Token to retrieve the next page of results.

Field

Description

id

string

Unique identifier of the assistant.

folderId

string

ID of the folder that the assistant belongs to.

name

string

Name of the assistant.

description

string

Description of the assistant.

createdBy

string

Identifier of the subject who created this assistant.

createdAt

string (date-time)

Timestamp representing when the assistant was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

updatedBy

string

Identifier of the subject who last updated this assistant.

updatedAt

string (date-time)

Timestamp representing the last time this assistant was updated.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

expirationConfig

ExpirationConfig

Configuration for the expiration of the assistant, defining when and how the assistant will expire.

expiresAt

string (date-time)

Timestamp representing when the assistant will expire.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

labels

object (map<string, string>)

Set of key-value pairs that can be used to organize and categorize the assistant.

modelUri

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.
These instructions can help guide the assistant's behavior and responses.

promptTruncationOptions

PromptTruncationOptions

Configuration options for truncating the prompt when the token count exceeds a specified limit.

completionOptions

CompletionOptions

Configuration options for completion generation.

tools[]

Tool

List of tools that the assistant can use to perform additional tasks.
One example is the SearchIndexTool, which is used for Retrieval-Augmented Generation (RAG).

Field

Description

expirationPolicy

enum (ExpirationPolicy)

• EXPIRATION_POLICY_UNSPECIFIED
• STATIC
• SINCE_LAST_ACTIVE

ttlDays

string (int64)

Field

Description

maxPromptTokens

string (int64)

The maximum number of tokens allowed in the prompt.
If the prompt exceeds this limit, the thread messages will be truncated.
Default max_prompt_tokens: 7000

autoStrategy

object

Includes only one of the fields autoStrategy, lastMessagesStrategy.

Specifies the truncation strategy to use when the prompt exceeds the token limit.

lastMessagesStrategy

LastMessagesStrategy

Retains only the last num_messages messages in the thread.
If these messages exceed max_prompt_tokens, older messages will be further truncated to fit the limit.

Includes only one of the fields autoStrategy, lastMessagesStrategy.

Specifies the truncation strategy to use when the prompt exceeds the token limit.

Field

Description

numMessages

string (int64)

The number of most recent messages to retain in the prompt.
If these messages exceed max_prompt_tokens, older messages will be further truncated to fit the limit.

Field

Description

maxTokens

string (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.

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

Field

Description

searchIndex

SearchIndexTool

SearchIndexTool tool that performs search across specified indexes.

Includes only one of the fields searchIndex, function.

function

FunctionTool

Function tool that can be invoked by the assistant.

Includes only one of the fields searchIndex, function.

Field

Description

searchIndexIds[]

string

A list of search index IDs that this tool will query. Currently, only a single index ID is supported.

maxNumResults

string (int64)

The maximum number of results to return from the search.
Fewer results may be returned if necessary to fit within the prompt's token limit.
This ensures that the combined prompt and search results do not exceed the token constraints.

rephraserOptions

RephraserOptions

Options for rephrasing user queries.
Used to rewrite the last user message for search,
incorporating context from the previous conversation.

Field

Description

rephraserUri

string

Required field. The ID of the model used to rephrase the last user message for search.

Field

Description

name

string

The name of the function.

description

string

A description of the function's purpose or behavior.

parameters

object

A JSON Schema that defines the expected parameters for the function.
The schema should describe the required fields, their types, and any constraints or default values.