package instinct.assistant.v2

Get desktop application:
View/edit binary Protocol Buffers messages

============================================================== AssistantService ==============================================================

CreateAssistantRequest, GetAssistantResponse, ModifyAssistantResponse

Used in: ListAssistantsResponse

• string model = 1

• string name = 2

• string description = 3

• string instructions = 4

• optional google.protobuf.Struct metadata = 5

• optional float temperature = 6

• optional float top_p = 7

• string response_format = 8

  ResponseFormat response_format = 8;

• string id = 9

• repeated AssistantToolObject tools = 10

• optional AssistantToolResources tool_resources = 11

• int64 created_at = 12

• int64 modified_at = 13

• string object = 14

union of Code, FileSearch, Function

Used in: AssistantObject, CreateRunRequest, CreateThreadAndRunRequest, ModifyAssistantRequest, RunObject

• AssistantToolType type = 1

• optional llm.FunctionTool function = 2

Used in: AssistantObject, CreateThreadAndRunRequest, ModifyAssistantRequest, ModifyThreadRequest, ThreadObject

• optional AssistantToolResources.AssistantCodeToolResource code_interpreter = 1

• optional AssistantToolResources.AssistantFileSearchToolResource file_search = 2

Used in: AssistantToolResources

• repeated string file_ids = 1

  maxItems = 20

Used in: AssistantToolResources

• repeated string vector_store_ids = 1

  maxItem = 1

Used in: AssistantToolObject, MessageAttachment, RunStepObject.RunStepDetails.ToolCallDetail, ToolChoice

• unknown_assistant_tool_type = 0

• code_interpreter = 1

• file_search = 2

• function = 3

• string run_id = 1

  The ID of the run to cancel.

• string thread_id = 2

  The ID of the thread to which this run belongs.

• string batch_id = 1

  The ID of the file batch to cancel.

• string vector_store_id = 2

  The ID of the vector store that the file batch belongs to.

Used in: RunStepError, VectorStoreFileError

• unknown_error_type = 0

• server_error = 1

• rate_limit_exceeded = 2

• invalid_prompt = 3

• invalid_request_error = 4

Used in: RunObject, RunStepObject

• int32 completion_tokens = 1

• int32 prompt_tokens = 2

• int32 total_tokens = 3

• string vector_store_id = 1

• string file_batch_id = 2

Used in: CreateRunRequest, ThreadObject

• string thread_id = 1

  The ID of the [thread](/docs/api-reference/threads) to create a message for.

• MessageRole role = 2

• string content = 3

• repeated MessageAttachment attachments = 4

• optional google.protobuf.Struct metadata = 5

• string assistant_id = 6

  optional

• string run_id = 7

  for internal use

• string assistant_id = 1

• string instructions = 2

• string additional_instructions = 3

• repeated CreateMessageRequest additional_messages = 4

• repeated AssistantToolObject tools = 5

• optional google.protobuf.Struct metadata = 6

• float temperature = 7

• float top_p = 8

• bool stream = 9

• uint32 max_prompt_tokens = 15

• uint32 max_completion_tokens = 16

• optional TruncationStrategy truncation_strategy = 17

• string tool_choice = 18

  ToolChoice tool_choice = 18;

• string response_format = 19

  ResponseFormat response_format = 19;

• string thread_id = 20

============================================================== ThreadService - Run ==============================================================

• string assistant_id = 1

• optional ThreadObject thread = 2

• string model = 3

• string instructions = 4

• repeated AssistantToolObject tools = 5

• optional AssistantToolResources tool_resources = 6

• optional google.protobuf.Struct metadata = 7

• float temperature = 8

• float top_p = 9

• bool stream = 10

• uint32 max_prompt_tokens = 11

  >= 256

• uint32 max_completion_tokens = 12

  >= 256

• optional TruncationStrategy truncation_strategy = 13

  The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.

• string tool_choice = 14

  Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling a tool. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool. due to language characteristics, we cannot make `tool_choice` as arbitrary type of `string` and `object`. So we choose to define `ToolChoice` as object type. ToolChoice tool_choice = 14;

  message ToolChoice { AssistantToolType type = 1; ToolChoiceFunction function = 2; message ToolChoiceFunction { string name = 1; } }

• string response_format = 15

  ResponseFormat response_format = 15;

============================================================== VectorStore - FileBatch ==============================================================

• string vector_store_id = 1

  The ID of the vector store for which to create a File Batch.

• repeated string file_ids = 2

• string vector_store_id = 1

  The ID of the vector store for which to create a File.

• string file_id = 2

• repeated string file_ids = 1

• string name = 2

• optional VectorStoreExpirationPolicy expires_after = 3

• optional google.protobuf.Struct metadata = 4

• string assistant_id = 1

  The ID of the assistant to delete.

• string id = 1

• bool deleted = 2

• string object = 3

• string file_id = 1

  The ID of the file to use for this request.

• string id = 1

• string object = 2

• bool deleted = 3

• string thread_id = 1

  The ID of the thread to delete.

• string id = 1

• bool deleted = 2

• string object = 3

• string file_id = 1

  The ID of the file to delete.

• string vector_store_id = 2

  The ID of the vector store that the file belongs to.

• string id = 1

• bool deleted = 2

• string object = 3

  always `vector_store.file.deleted`

• string vector_store_id = 1

  The ID of the vector store to delete.

• string id = 1

• bool deleted = 2

• string object = 3

DownloadFileResponse is type of string, thus it cannot be defined in proto files

• string file_id = 1

  The ID of the file to use for this request.

Used in: VectorStoreFileBatchObject, VectorStoreObject

• int32 in_progress = 1

• int32 completed = 2

• int32 failed = 3

• int32 cancelled = 4

• int32 total = 5

UploadFileResponse, RetrieveFileResponse

Used in: ListFilesResponse

• string id = 1

• string object = 2

• int64 created_at = 3

• int64 modified_at = 4

• int32 bytes = 5

• string filename = 6

• FileObjectPurpose purpose = 7

• string content_type = 8

Used in: FileObject, ListFilesRequest, UploadFileRequest

• unknown_file_object_purpose = 0

• assistants = 1

• assistants_output = 2

• string assistant_id = 1

  The ID of the assistant to retrieve.

• string message_id = 1

  The ID of the message to retrieve.

• string thread_id = 2

  The ID of the [thread](/docs/api-reference/threads) to which this message belongs.

• string run_id = 1

  The ID of the run to retrieve.

• string thread_id = 2

  The ID of the [thread](/docs/api-reference/threads) that was run.

• string run_id = 1

  The ID of the run to which the run step belongs.

• string step_id = 2

  The ID of the run step to retrieve.

• string thread_id = 3

  The ID of the thread to which the run and run step belongs.

• string thread_id = 1

  The ID of the thread to retrieve.

• string batch_id = 1

  The ID of the file batch being retrieved.

• string vector_store_id = 2

  The ID of the vector store that the file batch belongs to.

• string file_id = 1

  The ID of the file being retrieved.

• string vector_store_id = 2

  The ID of the vector store that the file belongs to.

• string vector_store_id = 1

  The ID of the vector store to retrieve.

Used in: MessageObject, RunObject

• IncompleteDetails.IncompleteReason reason = 1

Used in: IncompleteDetails

• unknown_incomplete_reason = 0

• content_filter = 1

• max_tokens = 2

• run_cancelled = 3

• run_expired = 4

• run_failed = 5

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string before = 2

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• int32 limit = 3

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 4

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string object = 1

• repeated AssistantObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string batch_id = 2

  The ID of the file batch that the files belong to.

• string before = 3

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• VectorStoreFileStatus filter = 4

  Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.

• int32 limit = 5

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 6

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string vector_store_id = 7

  The ID of the vector store that the files belong to.

• string object = 1

• repeated VectorStoreFileObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

============================================================== File ==============================================================

• FileObjectPurpose purpose = 1

  Only return files with the given purpose.

• string object = 1

  always `list`

• repeated FileObject data = 2

• string object = 1

• repeated MessageObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

============================================================== ThreadService - Message ==============================================================

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string before = 2

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• int32 limit = 3

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 4

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string run_id = 5

  Filter messages by the run ID that generated them.

• string thread_id = 6

  The ID of the [thread](/docs/api-reference/threads) the messages belong to.

• string vector_store_id = 1

• int32 limit = 2

Used in: ListAssistantsRequest, ListFilesInVectorStoreBatchRequest, ListMessagesRequest, ListRunStepsRequest, ListRunsRequest, ListVectorStoreFilesRequest, ListVectorStoresRequest

• unknown_list_request_order = 0

• desc = 1

  default

• asc = 2

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string before = 2

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• int32 limit = 3

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 4

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string run_id = 5

  The ID of the run the run steps belong to.

• string thread_id = 6

  The ID of the thread the run and run steps belong to.

• string object = 1

  always `list`

• repeated RunStepObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string before = 2

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• int32 limit = 3

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 4

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string thread_id = 5

  The ID of the thread the run belongs to.

• string object = 1

  always `list`

• repeated RunObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

============================================================== VectorStore - File ==============================================================

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string before = 2

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• VectorStoreFileStatus filter = 3

  Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.

• int32 limit = 4

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 5

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string vector_store_id = 6

  The ID of the vector store that the files belong to.

• string object = 1

• repeated VectorStoreFileObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

============================================================== VectorStore ==============================================================

• string after = 1

  A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• string before = 2

  A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• int32 limit = 3

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• ListRequestOrder order = 4

  Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

• string object = 1

• repeated VectorStoreObject data = 2

• string first_id = 3

• string last_id = 4

• bool has_more = 5

Used in: CreateMessageRequest, MessageObject

• string file_id = 1

• repeated AssistantToolType tools = 2

CreateMessageResponse, RetrieveMessageResponse, ModifyMessageResponse

Used in: ListMessageResponse

• string id = 1

• string object = 2

• int64 created_at = 3

• string thread_id = 4

• MessageObject.MessageStatus status = 5

• optional IncompleteDetails incomplete_details = 6

• int64 completed_at = 7

• int64 incompleted_at = 8

• MessageRole role = 9

• repeated MessageObject.MessageContent content = 10

• string assistant_id = 11

• string run_id = 12

• repeated MessageAttachment attachments = 13

• optional google.protobuf.Struct metadata = 14

• int64 modified_at = 15

Used in: MessageObject

• MessageContentType type = 1

• repeated MessageContent.MessageContentImageFile image_file = 2

  for image file only

• optional MessageContent.MessageContentText text = 3

  for text only

Used in: MessageContent

• string file_id = 1

Used in: MessageContent

• string value = 1

• repeated MessageContentText.MessageContentTextAnnotation annotations = 2

union of citation and file path

Used in: MessageContentText

• MessageContentTextAnnotationType type = 1

• string text = 2

• int32 start_index = 3

• int32 end_index = 4

• optional MessageContentTextAnnotation.MessageContentTextFileCitation file_citation = 5

  for citation only

• optional MessageContentTextAnnotation.MessageContentTextFilePath file_path = 6

Used in: MessageContentTextAnnotation

• string file_id = 1

• string quote = 2

for file path only

Used in: MessageContentTextAnnotation

• string file_id = 1

Used in: MessageContentText.MessageContentTextAnnotation

• unknown_content_text_annotation_type = 0

• file_citation = 1

  A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files.

• file_path = 2

  A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

Used in: MessageContent

• unknown_message_content_type = 0

• text = 1

• image_file = 2

Used in: MessageObject

• unknown_message_status = 0

• completed = 1

• in_progress = 2

• incomplete = 3

Used in: CreateMessageRequest, MessageObject

• unknown_message_role = 0

• user = 1

• assistant = 2

• string model = 1

• string name = 2

• string description = 3

• string instructions = 4

• optional google.protobuf.Struct metadata = 5

• float temperature = 6

• float top_p = 7

• string response_format = 8

  ResponseFormat response_format = 8;

• repeated AssistantToolObject tools = 10

• optional AssistantToolResources tool_resources = 11

• string assistant_id = 12

• string message_id = 1

  The ID of the message to modify.

• string thread_id = 2

  The ID of the thread to which this message belongs.

• optional google.protobuf.Struct metadata = 3

• string run_id = 1

  The ID of the run to modify.

• string thread_id = 2

  The ID of the [thread](/docs/api-reference/threads) that was run.

• optional google.protobuf.Struct metadata = 3

• RunObject.RunObjectStatus status = 4

  only used internally

• optional RunObject.RequiredAction required_action = 5

  only used internally

• int64 started_at = 6

• int64 expires_at = 7

• int64 cancelled_at = 8

• int64 failed_at = 9

• int64 completed_at = 10

• string run_id = 1

• string thread_id = 2

• string step_id = 3

• optional RunStepObject.RunStepDetails step_details = 4

• RunStepObject.RunStepStatus status = 5

• optional RunStepError last_error = 6

• int64 expired_at = 7

• int64 cancelled_at = 8

• int64 failed_at = 9

• int64 completed_at = 10

• string thread_id = 1

  The ID of the thread to modify. Only the `metadata` can be modified.

• optional AssistantToolResources tool_resources = 2

• optional google.protobuf.Struct metadata = 3

• string batch_id = 1

• string vector_store_id = 2

• VectorStoreFileBatchObject.VectorStoreFileBatchStatus status = 4

• optional VectorStoreFileError last_error = 5

• int64 sanity_check_at = 6

• string file_id = 1

  The ID of the file being retrieved.

• string vector_store_id = 2

  The ID of the vector store that the file belongs to.

• VectorStoreFileStatus status = 6

• optional VectorStoreFileError last_error = 7

• string summary = 8

• string vector_store_id = 1

  The ID of the vector store to modify.

• string name = 2

• optional VectorStoreExpirationPolicy expires_after = 3

• optional google.protobuf.Struct metadata = 4

• VectorStoreObject.VectorStoreStatus status = 5

• string summary = 6

• auto = 0

• none = 1

• string file_id = 1

  The ID of the file to use for this request.

custom detail data for AgentFinish

• optional RunStepError error = 5

CreateThreadAndRunResponse, CreateRunResponse, RetrieveRunObject, ModifyRunResponse, SubmitToolOutputsResponse, GetRunResponse

Used in: ListRunsResponse

• string id = 1

• string object = 2

  always `thread.run`

• int64 created_at = 3

• int64 modified_at = 4

• string thread_id = 5

• string assistant_id = 6

• RunObject.RunObjectStatus status = 7

• optional RunObject.RequiredAction required_action = 8

• optional RunStepError last_error = 9

• int64 expires_at = 10

• int64 cancelled_at = 11

• int64 failed_at = 12

• int64 completed_at = 13

• int64 incomplete_at = 14

• optional IncompleteDetails incomplete_details = 15

• string model = 16

• string instructions = 17

• repeated AssistantToolObject tools = 18

• optional google.protobuf.Struct metadata = 19

• optional CompletionUsage usage = 20

• optional float temperature = 21

  could be zero so it has be `optional`

• optional float top_p = 22

  could be zero so it has be `optional`

• int32 max_prompt_tokens = 23

• int32 max_completion_tokens = 24

• optional TruncationStrategy truncation_strategy = 25

• string tool_choice = 26

  "auto" or JSON string of ToolChoice

• string response_format = 27

  "auto" or JSON string of ResponseFormat

• int64 started_at = 28

Used in: ModifyRunRequest, RunObject

• RequiredActionType type = 1

• optional RequiredAction.SubmitToolOutputs submit_tool_outputs = 2

Used in: RequiredAction

• repeated llm.ToolCallObject tool_calls = 2

Used in: RequiredAction

• unknown_required_action_type = 0

• submit_tool_outputs = 1

Used in: ModifyRunRequest, RunObject

• unknown_run_object_status = 0

• queued = 1

• in_progress = 2

• requires_action = 3

• cancelling = 4

• cancelled = 5

• failed = 6

• completed = 7

• expired = 8

Used in: TruncationStrategy

• unknown = 0

• auto = 1

• last_messages = 2

Used in: ModifyRunStepRequest, RunEarlyStopDetails, RunObject, RunStepObject

• CommonErrorType type = 1

• string message = 2

GetRunStepResponse

Used in: ListRunStepsResponse

• string id = 1

• string object = 2

• int64 created_at = 3

• string assistant_id = 4

• string thread_id = 5

• string run_id = 6

• RunStepObject.RunStepType type = 7

• RunStepObject.RunStepStatus status = 8

• optional RunStepObject.RunStepDetails step_details = 9

• optional RunStepError last_error = 10

• int64 expired_at = 11

• int64 cancelled_at = 12

• int64 failed_at = 13

• int64 completed_at = 14

• optional google.protobuf.Struct metadata = 15

• optional CompletionUsage usage = 16

• int64 modified_at = 17

union of RunStepDetailsMessageCreationObject and RunStepDetailsToolCallObject

Used in: ModifyRunStepRequest, RunStepObject

• RunStepType type = 1

• optional RunStepDetails.MessageCreationDetails message_creation = 2

  for message creation only

• repeated RunStepDetails.ToolCallDetail tool_calls = 3

  for tool calls only

• optional google.protobuf.Any custom = 4

Used in: RunStepDetails

• string message_id = 1

union of CodeInterpreterToolCall, FileSearchToolCall, FunctionToolCall

Used in: RunStepDetails

• string id = 1

• AssistantToolType type = 2

• optional ToolCallDetail.CodeInterpreter code_interpreter = 3

• optional ToolCallDetail.FileSearch file_search = 4

• optional ToolCallDetail.FunctionCall function = 5

• optional google.protobuf.Any custom = 6

Used in: ToolCallDetail

• string input = 1

• repeated CodeInterpreter.CodeInterpreterOutput outputs = 2

union of CodeOutputLogsObject and CodeOutputImageObject

Used in: CodeInterpreter

• CodeInterpreterOutputType type = 1

• string logs = 2

  only for CodeOutputLogsObject

• optional CodeInterpreterOutput.CodeInterpreterImageOutput image = 3

  only for CodeOutputImageObject

Used in: CodeInterpreterOutput

• string file_id = 1

Used in: CodeInterpreterOutput

• unknown_code_interpreter_output_type = 0

• logs = 1

• image = 2

Used in: ToolCallDetail

(message has no fields)

Used in: ToolCallDetail

• string name = 1

• string arguments = 2

• string output = 3

Used in: ModifyRunStepRequest, RunStepObject

• unknown_run_step_status = 0

• in_progress = 1

• cancelled = 2

• failed = 3

• completed = 4

• expired = 5

Used in: RunStepObject, RunStepDetails

• unknown_run_step_type = 0

• message_creation = 1

• tool_calls = 2

When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.

• string run_id = 1

  The ID of the run that requires the tool output submission.

• string thread_id = 2

  The ID of the [thread](/docs/api-reference/threads) to which this run belongs.

• repeated SubmitToolOutputsToRunRequest.ToolOutput tool_outputs = 3

• bool stream = 4

  If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.

Used in: SubmitToolOutputsToRunRequest

• string tool_call_id = 1

• string output = 2

============================================================== ThreadService - Thread ==============================================================

CreateThreadRequest, GetThreadResponse, ModifyThreadResponse

Used in: CreateThreadAndRunRequest

• string id = 1

• string object = 2

• int64 created_at = 3

• int64 modified_at = 4

• repeated CreateMessageRequest messages = 5

• optional AssistantToolResources tool_resources = 6

• optional google.protobuf.Struct metadata = 7

• AssistantToolType type = 1

• optional ToolChoice.ToolChoiceFunction function = 2

Used in: ToolChoice

• string name = 1

Used in: CreateRunRequest, CreateThreadAndRunRequest, RunObject

• RunObject.TruncationStrategyType type = 1

• int32 last_messages = 2

• bytes file_content = 1

• string filename = 2

• FileObjectPurpose purpose = 3

  fine-tune, assistants

• string content_type = 4

Used in: CreateVectorStoreRequest, ModifyVectorStoreRequest, VectorStoreObject

• VectorStoreExpirationPolicy.VectorStoreExpirationAnchor anchor = 1

  Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

• uint32 days = 2

  The number of days after the anchor time that the vector store will expire.

Used in: VectorStoreExpirationPolicy

• unknown_vector_store_expiration_anchor = 0

• last_active_at = 1

CreateVectorStoreFileBatchResponse, GetVectorStoreFileBatchResponse, CancelVectorStoreFileBatchResponse

• string id = 1

• string object = 2

• int64 created_at = 3

• int64 modified_at = 4

• string vector_store_id = 6

• VectorStoreFileBatchObject.VectorStoreFileBatchStatus status = 7

• optional VectorStoreFileError last_error = 8

• int64 sanity_check_at = 9

• optional FileCounts file_counts = 10

Used in: ModifyVectorStoreFileBatchRequest, VectorStoreFileBatchObject

• unknown_vector_store_file_batch_status = 0

• in_progress = 1

• completed = 2

• cancelled = 3

• failed = 4

Used in: ModifyVectorStoreFileBatchRequest, ModifyVectorStoreFileRequest, VectorStoreFileBatchObject, VectorStoreFileObject

• CommonErrorType code = 1

• string message = 2

CreateVectorFileResponse

Used in: ListFilesInVectorStoreBatchResponse, ListVectorStoreFilesResponse

• string file_id = 1

• string object = 2

• int64 created_at = 3

• int64 modified_at = 4

• string vector_store_id = 5

• VectorStoreFileStatus status = 6

• optional VectorStoreFileError last_error = 7

• string file_batch_id = 8

• string summary = 9

  extra field for summary which doesn't exist in original API

Used in: ListFilesInVectorStoreBatchRequest, ListVectorStoreFilesRequest, ModifyVectorStoreFileRequest, VectorStoreFileObject

• unknown_vector_store_file_status = 0

• in_progress = 1

• completed = 2

• failed = 3

• cancelled = 4

CreateVectorStoreResponse, GetVectorStoreResponse, ModifyVectorStoreResponse

Used in: ListVectorStoresResponse

• string id = 1

• string object = 2

  always `vector_store`

• int64 created_at = 3

• string name = 4

• int32 usage_bytes = 5

• optional FileCounts file_counts = 6

• VectorStoreObject.VectorStoreStatus status = 7

• optional VectorStoreExpirationPolicy expires_after = 8

• int64 expires_at = 9

  The Unix timestamp (in seconds) for when the vector store will expire.

• int64 last_active_at = 10

  The Unix timestamp (in seconds) for when the vector store was last active.

• optional google.protobuf.Struct metadata = 11

• string summary = 12

  this is a extra field for storing text summary of containing documents. And it's not in the original OpenAI's API design.

• int64 modified_at = 13

Used in: ModifyVectorStoreRequest, VectorStoreObject

• unknown_vector_Store_status = 0

• expired = 1

• in_progress = 2

• completed = 3