Class ResponseFileSearchToolCall
-
- All Implemented Interfaces:
public final class ResponseFileSearchToolCall
The 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 class
ResponseFileSearchToolCall.Builder
A builder for ResponseFileSearchToolCall.
public final class
ResponseFileSearchToolCall.Status
The status of the file search tool call. One of
in_progress
,searching
,incomplete
orfailed
,public final class
ResponseFileSearchToolCall.Result
-
Method Summary
Modifier and Type Method Description final String
id()
The unique ID of the file search tool call. final List<String>
queries()
The queries used to search for files. final ResponseFileSearchToolCall.Status
status()
The status of the file search tool call. final JsonValue
_type()
The type of the file search tool call. final Optional<List<ResponseFileSearchToolCall.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<ResponseFileSearchToolCall.Status>
_status()
Returns the raw JSON value of status. final JsonField<List<ResponseFileSearchToolCall.Result>>
_results()
Returns the raw JSON value of results. final Map<String, JsonValue>
_additionalProperties()
final ResponseFileSearchToolCall.Builder
toBuilder()
final ResponseFileSearchToolCall
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFileSearchToolCall.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFileSearchToolCall. -
-
Method Detail
-
status
final ResponseFileSearchToolCall.Status status()
The status of the file search tool call. One of
in_progress
,searching
,incomplete
orfailed
,
-
_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).
-
results
final Optional<List<ResponseFileSearchToolCall.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<ResponseFileSearchToolCall.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_results
final JsonField<List<ResponseFileSearchToolCall.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 ResponseFileSearchToolCall.Builder toBuilder()
-
validate
final ResponseFileSearchToolCall validate()
-
builder
final static ResponseFileSearchToolCall.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFileSearchToolCall.
The following fields are required:
.id() .queries() .status()
-
-
-
-