Class ThreadUpdateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") public final class ThreadUpdateParams implements Params
Modifies a thread.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classThreadUpdateParams.BuilderA builder for ThreadUpdateParams.
public final classThreadUpdateParams.Bodypublic final classThreadUpdateParams.MetadataSet 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.
public final classThreadUpdateParams.ToolResourcesA 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_interpretertool requires a list of file IDs, while thefile_searchtool requires a list of vector store IDs.
-
Method Summary
Modifier and Type Method Description final Optional<String>threadId()final Optional<ThreadUpdateParams.Metadata>metadata()Set of 16 key-value pairs that can be attached to an object. final Optional<ThreadUpdateParams.ToolResources>toolResources()A set of resources that are made available to the assistant's tools in this thread. final JsonField<ThreadUpdateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<ThreadUpdateParams.ToolResources>_toolResources()Returns the raw JSON value of toolResources. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final ThreadUpdateParams.BuildertoBuilder()final ThreadUpdateParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ThreadUpdateParamsnone()final static ThreadUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ThreadUpdateParams. -
-
Method Detail
-
metadata
final Optional<ThreadUpdateParams.Metadata> metadata()
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
final Optional<ThreadUpdateParams.ToolResources> toolResources()
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_interpretertool requires a list of file IDs, while thefile_searchtool requires a list of vector store IDs.
-
_metadata
final JsonField<ThreadUpdateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_toolResources
final JsonField<ThreadUpdateParams.ToolResources> _toolResources()
Returns the raw JSON value of toolResources.
Unlike toolResources, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final ThreadUpdateParams.Builder toBuilder()
-
_body
final ThreadUpdateParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static ThreadUpdateParams none()
-
builder
final static ThreadUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of ThreadUpdateParams.
-
-
-
-