Class BetaResponseFileSearchToolCall
-
- All Implemented Interfaces:
public final class BetaResponseFileSearchToolCallThe results of a file search tool call. See the file search guide for more information.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseFileSearchToolCall.BuilderA builder for BetaResponseFileSearchToolCall.
public final classBetaResponseFileSearchToolCall.StatusThe status of the file search tool call. One of
in_progress,searching,incompleteorfailed,public final classBetaResponseFileSearchToolCall.AgentThe agent that produced this item.
public final classBetaResponseFileSearchToolCall.Result
-
Method Summary
Modifier and Type Method Description final Stringid()The unique ID of the file search tool call. final List<String>queries()The queries used to search for files. final BetaResponseFileSearchToolCall.Statusstatus()The status of the file search tool call. final JsonValue_type()The type of the file search tool call. final Optional<BetaResponseFileSearchToolCall.Agent>agent()The agent that produced this item. final Optional<List<BetaResponseFileSearchToolCall.Result>>results()The results of the file search tool call. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<List<String>>_queries()Returns the raw JSON value of queries. final JsonField<BetaResponseFileSearchToolCall.Status>_status()Returns the raw JSON value of status. final JsonField<BetaResponseFileSearchToolCall.Agent>_agent()Returns the raw JSON value of agent. final JsonField<List<BetaResponseFileSearchToolCall.Result>>_results()Returns the raw JSON value of results. final Map<String, JsonValue>_additionalProperties()final BetaResponseFileSearchToolCall.BuildertoBuilder()final BetaResponseFileSearchToolCallvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseFileSearchToolCall.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseFileSearchToolCall. -
-
Method Detail
-
status
final BetaResponseFileSearchToolCall.Status status()
The status of the file search tool call. One of
in_progress,searching,incompleteorfailed,
-
_type
final JsonValue _type()
The type of the file search tool call. Always
file_search_call.Expected to always return the following:
JsonValue.from("file_search_call")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseFileSearchToolCall.Agent> agent()
The agent that produced this item.
-
results
final Optional<List<BetaResponseFileSearchToolCall.Result>> results()
The results of the file search tool call.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_queries
final JsonField<List<String>> _queries()
Returns the raw JSON value of queries.
Unlike queries, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<BetaResponseFileSearchToolCall.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_agent
final JsonField<BetaResponseFileSearchToolCall.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_results
final JsonField<List<BetaResponseFileSearchToolCall.Result>> _results()
Returns the raw JSON value of results.
Unlike results, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseFileSearchToolCall.Builder toBuilder()
-
validate
final BetaResponseFileSearchToolCall validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaResponseFileSearchToolCall.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseFileSearchToolCall.
The following fields are required:
.id() .queries() .status()
-
-
-
-