Class RunSubmitToolOutputsParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") public final class RunSubmitToolOutputsParams implements Params
When a run has the
status: "requires_action"andrequired_action.typeissubmit_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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRunSubmitToolOutputsParams.BuilderA builder for RunSubmitToolOutputsParams.
public final classRunSubmitToolOutputsParams.Bodypublic final classRunSubmitToolOutputsParams.ToolOutput
-
Method Summary
Modifier and Type Method Description final StringthreadId()final Optional<String>runId()final List<RunSubmitToolOutputsParams.ToolOutput>toolOutputs()A list of tools for which the outputs are being submitted. final JsonField<List<RunSubmitToolOutputsParams.ToolOutput>>_toolOutputs()Returns the raw JSON value of toolOutputs. 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 RunSubmitToolOutputsParams.BuildertoBuilder()final RunSubmitToolOutputsParams.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 RunSubmitToolOutputsParams.Builderbuilder()Returns a mutable builder for constructing an instance of RunSubmitToolOutputsParams. -
-
Method Detail
-
toolOutputs
final List<RunSubmitToolOutputsParams.ToolOutput> toolOutputs()
A list of tools for which the outputs are being submitted.
-
_toolOutputs
final JsonField<List<RunSubmitToolOutputsParams.ToolOutput>> _toolOutputs()
Returns the raw JSON value of toolOutputs.
Unlike toolOutputs, 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 RunSubmitToolOutputsParams.Builder toBuilder()
-
_body
final RunSubmitToolOutputsParams.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.
-
builder
final static RunSubmitToolOutputsParams.Builder builder()
Returns a mutable builder for constructing an instance of RunSubmitToolOutputsParams.
The following fields are required:
.threadId() .toolOutputs()
-
-
-
-