Threads, gRPC: ThreadService.Create
- gRPC request
- CreateThreadRequest
- MessageData
- Author
- MessageContent
- ContentPart
- Text
- ExpirationConfig
- Tool
- SearchIndexTool
- RephraserOptions
- CallStrategy
- AlwaysCall
- AutoCall
- FunctionTool
- GenSearchTool
- GenSearchOptions
- SiteOption
- HostOption
- UrlOption
- SearchFilter
- Thread
- ExpirationConfig
- Tool
- SearchIndexTool
- RephraserOptions
- CallStrategy
- AlwaysCall
- AutoCall
- FunctionTool
- GenSearchTool
- GenSearchOptions
- SiteOption
- HostOption
- UrlOption
- SearchFilter
Create a new thread.
gRPC request
rpc Create (CreateThreadRequest) returns (Thread)
CreateThreadRequest
{
"folder_id": "string",
"messages": [
{
"author": {
"id": "string",
"role": "string"
},
"labels": "map<string, string>",
"content": {
"content": [
{
// Includes only one of the fields `text`
"text": {
"content": "string"
}
// end of the list of possible fields
}
]
}
}
],
"name": "string",
"description": "string",
"default_message_author_id": "string",
"expiration_config": {
"expiration_policy": "ExpirationPolicy",
"ttl_days": "int64"
},
"labels": "map<string, string>",
"tools": [
{
// Includes only one of the fields `search_index`, `function`, `gen_search`
"search_index": {
"search_index_ids": [
"string"
],
"max_num_results": "google.protobuf.Int64Value",
"rephraser_options": {
"rephraser_uri": "string"
},
"call_strategy": {
// Includes only one of the fields `always_call`, `auto_call`
"always_call": "AlwaysCall",
"auto_call": {
"name": "string",
"instruction": "string"
}
// end of the list of possible fields
}
},
"function": {
"name": "string",
"description": "string",
"parameters": "google.protobuf.Struct"
},
"gen_search": {
"options": {
// Includes only one of the fields `site`, `host`, `url`
"site": {
"site": [
"string"
]
},
"host": {
"host": [
"string"
]
},
"url": {
"url": [
"string"
]
},
// end of the list of possible fields
"enable_nrfm_docs": "bool",
"search_filters": [
{
// Includes only one of the fields `date`, `lang`, `format`
"date": "string",
"lang": "string",
"format": "DocFormat"
// end of the list of possible fields
}
]
},
"description": "string"
}
// end of the list of possible fields
}
]
}
Request message for creating a new thread.
|
Field |
Description |
|
folder_id |
string Required field. |
|
messages[] |
List of messages to initialize the thread. |
|
name |
string Name of the thread. |
|
description |
string Description of the thread. |
|
default_message_author_id |
string Default user ID that will be used as the author for thread messages if no other author is specified. |
|
expiration_config |
Expiration configuration for the thread. |
|
labels |
object (map<string, string>) Set of key-value pairs to label the thread. |
|
tools[] |
List of tools that are available for assistants to use in this thread. |
MessageData
Represents the data required to create or initialize a message in a thread.
This message is used, for example, to initialize a thread with some messages upon its creation.
|
Field |
Description |
|
author |
Author of the message, containing details about the message's creator. |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the message. |
|
content |
Content of the message. |
Author
Author of the message, containing details about the message's creator.
|
Field |
Description |
|
id |
string Unique identifier of the author. This could be either the user's ID or the assistant's ID, depending on the role. |
|
role |
string Role of the author, indicating whether the message was created by a "user" or an "assistant". |
MessageContent
Represents the content of a message, which can consist of multiple parts.
|
Field |
Description |
|
content[] |
A list of content parts that make up the message. |
ContentPart
ContentPart represents an individual part of the message content, which can be of various types.
|
Field |
Description |
|
text |
Text content of the message part. Includes only one of the fields Specifies the type of content that the part contains. |
Text
Text represents a textual content part of a message.
|
Field |
Description |
|
content |
string Text content of the message. |
ExpirationConfig
|
Field |
Description |
|
expiration_policy |
enum ExpirationPolicy
|
|
ttl_days |
int64 |
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 |
|
function |
Function tool that can be invoked by the assistant. Includes only one of the fields |
|
gen_search |
Performs web retrieval and generative synthesis. 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. |
|
rephraser_options |
Options for rephrasing user queries. |
|
call_strategy |
Defines the strategy for triggering search. |
RephraserOptions
Options for configuring the rephrasing the last user message for search using context from previous conversation.
|
Field |
Description |
|
rephraser_uri |
string Required field. The ID of the model used to rephrase the last user message for search. |
CallStrategy
Defines when the assistant uses the search tool.
|
Field |
Description |
|
always_call |
Includes only one of the fields One of |
|
auto_call |
Includes only one of the fields One of |
AlwaysCall
Always includes retrieved search results in the prompt.
|
Field |
Description |
|
Empty |
|
AutoCall
Exposes the tool as a callable function.
The model decides when to trigger search based on the instruction.
|
Field |
Description |
|
name |
string The name of the tool as exposed to the model. |
|
instruction |
string Required field. Required instruction that helps the model decide when to call the tool. |
FunctionTool
Represents a function tool that can be invoked by the assistant.
|
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. |
GenSearchTool
|
Field |
Description |
|
options |
Scoping and filtering rules for the search query |
|
description |
string Required field. description of the purpose |
GenSearchOptions
|
Field |
Description |
|
site |
Includes only one of the fields Restricts the search to the specific websites, hosts or pages. |
|
host |
Includes only one of the fields Restricts the search to the specific websites, hosts or pages. |
|
url |
Includes only one of the fields Restricts the search to the specific websites, hosts or pages. |
|
enable_nrfm_docs |
bool Use the documents inaccessible from the front page. |
|
search_filters[] |
Restricts the search by date, document formats or language. |
SiteOption
Restricts the search to the specific websites.
|
Field |
Description |
|
site[] |
string |
HostOption
Restricts the search to the specific hosts.
|
Field |
Description |
|
host[] |
string |
UrlOption
Restricts the search to the specific pages.
|
Field |
Description |
|
url[] |
string |
SearchFilter
|
Field |
Description |
|
date |
string Restrict by document date Includes only one of the fields Includes only one of the fields date, lang, format. |
|
lang |
string Restrict by document language. Use ISO 639-1 language codes. Includes only one of the fields Includes only one of the fields date, lang, format. |
|
format |
enum DocFormat Restrict by document format. Includes only one of the fields Includes only one of the fields date, lang, format.
|
Thread
{
"id": "string",
"folder_id": "string",
"name": "string",
"description": "string",
"default_message_author_id": "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>",
"tools": [
{
// Includes only one of the fields `search_index`, `function`, `gen_search`
"search_index": {
"search_index_ids": [
"string"
],
"max_num_results": "google.protobuf.Int64Value",
"rephraser_options": {
"rephraser_uri": "string"
},
"call_strategy": {
// Includes only one of the fields `always_call`, `auto_call`
"always_call": "AlwaysCall",
"auto_call": {
"name": "string",
"instruction": "string"
}
// end of the list of possible fields
}
},
"function": {
"name": "string",
"description": "string",
"parameters": "google.protobuf.Struct"
},
"gen_search": {
"options": {
// Includes only one of the fields `site`, `host`, `url`
"site": {
"site": [
"string"
]
},
"host": {
"host": [
"string"
]
},
"url": {
"url": [
"string"
]
},
// end of the list of possible fields
"enable_nrfm_docs": "bool",
"search_filters": [
{
// Includes only one of the fields `date`, `lang`, `format`
"date": "string",
"lang": "string",
"format": "DocFormat"
// end of the list of possible fields
}
]
},
"description": "string"
}
// end of the list of possible fields
}
]
}
|
Field |
Description |
|
id |
string Unique identifier of the thread. |
|
folder_id |
string ID of the folder that the thread belongs to. |
|
name |
string Name of the thread. |
|
description |
string Description of the thread. |
|
default_message_author_id |
string Default user ID that will be used as the author for thread messages if no other author is specified. |
|
created_by |
string Identifier of the subject who created this thread. |
|
created_at |
Timestamp representing when the thread was created. |
|
updated_by |
string Identifier of the subject who last updated this thread. |
|
updated_at |
Timestamp representing the last time this thread was updated. |
|
expiration_config |
Configuration for the expiration of the thread, defining when and how the thread will expire. |
|
expires_at |
Timestamp representing when the thread will expire. |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the thread. |
|
tools[] |
List of tools that are available for assistants to use in this thread. |
ExpirationConfig
|
Field |
Description |
|
expiration_policy |
enum ExpirationPolicy
|
|
ttl_days |
int64 |
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 |
|
function |
Function tool that can be invoked by the assistant. Includes only one of the fields |
|
gen_search |
Performs web retrieval and generative synthesis. 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. |
|
rephraser_options |
Options for rephrasing user queries. |
|
call_strategy |
Defines the strategy for triggering search. |
RephraserOptions
Options for configuring the rephrasing the last user message for search using context from previous conversation.
|
Field |
Description |
|
rephraser_uri |
string Required field. The ID of the model used to rephrase the last user message for search. |
CallStrategy
Defines when the assistant uses the search tool.
|
Field |
Description |
|
always_call |
Includes only one of the fields One of |
|
auto_call |
Includes only one of the fields One of |
AlwaysCall
Always includes retrieved search results in the prompt.
|
Field |
Description |
|
Empty |
|
AutoCall
Exposes the tool as a callable function.
The model decides when to trigger search based on the instruction.
|
Field |
Description |
|
name |
string The name of the tool as exposed to the model. |
|
instruction |
string Required field. Required instruction that helps the model decide when to call the tool. |
FunctionTool
Represents a function tool that can be invoked by the assistant.
|
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. |
GenSearchTool
|
Field |
Description |
|
options |
Scoping and filtering rules for the search query |
|
description |
string Required field. description of the purpose |
GenSearchOptions
|
Field |
Description |
|
site |
Includes only one of the fields Restricts the search to the specific websites, hosts or pages. |
|
host |
Includes only one of the fields Restricts the search to the specific websites, hosts or pages. |
|
url |
Includes only one of the fields Restricts the search to the specific websites, hosts or pages. |
|
enable_nrfm_docs |
bool Use the documents inaccessible from the front page. |
|
search_filters[] |
Restricts the search by date, document formats or language. |
SiteOption
Restricts the search to the specific websites.
|
Field |
Description |
|
site[] |
string |
HostOption
Restricts the search to the specific hosts.
|
Field |
Description |
|
host[] |
string |
UrlOption
Restricts the search to the specific pages.
|
Field |
Description |
|
url[] |
string |
SearchFilter
|
Field |
Description |
|
date |
string Restrict by document date Includes only one of the fields Includes only one of the fields date, lang, format. |
|
lang |
string Restrict by document language. Use ISO 639-1 language codes. Includes only one of the fields Includes only one of the fields date, lang, format. |
|
format |
enum DocFormat Restrict by document format. Includes only one of the fields Includes only one of the fields date, lang, format.
|