Modify thread

Deprecated

client.Beta.Threads.Update(ctx, threadID, body) (*Thread, error)

POST/threads/{thread_id}

Modifies a thread.

ParametersExpand Collapse

threadID string

body BetaThreadUpdateParams

Metadata param.Field[Metadata]optional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

ToolResources param.Field[BetaThreadUpdateParamsToolResources]optional

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

CodeInterpreter BetaThreadUpdateParamsToolResourcesCodeInterpreteroptional

FileIDs []stringoptional

A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.

FileSearch BetaThreadUpdateParamsToolResourcesFileSearchoptional

VectorStoreIDs []stringoptional

The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.

ReturnsExpand Collapse

type Thread struct{…}

Represents a thread that contains messages.

ID string

The identifier, which can be referenced in API endpoints.

CreatedAt int64

The Unix timestamp (in seconds) for when the thread was created.

Metadata Metadata

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Object Thread

The object type, which is always thread.

ToolResources ThreadToolResources

CodeInterpreter ThreadToolResourcesCodeInterpreteroptional

FileIDs []stringoptional

A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.

FileSearch ThreadToolResourcesFileSearchoptional

VectorStoreIDs []stringoptional

The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.

Modify thread

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  thread, err := client.Beta.Threads.Update(
    context.TODO(),
    "thread_id",
    openai.BetaThreadUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", thread.ID)
}

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {
    "modified": "true",
    "user": "abc123"
  },
  "tool_resources": {}
}

Returns Examples

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {
    "modified": "true",
    "user": "abc123"
  },
  "tool_resources": {}
}