From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

OVID / OpenAPI-Client-OpenAI-0.20 / lib / OpenAPI / Client / OpenAI / Path / threads-thread_id-runs-run_id-steps-step_id.pod 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

              
=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps-step_id - Documentation for the /threads/{thread_id}/runs/{run_id}/steps/{step_id} path.
=head1 DESCRIPTION
This document describes the API endpoint at C</threads/{thread_id}/runs/{run_id}/steps/{step_id}>.
See the C<examples/> directory in the distribution for examples of how to use this.
=head2 C<GET /threads/{thread_id}/runs/{run_id}/steps/{step_id}>
Retrieves a run step.
=head3 Operation ID
C<getRunStep>
    $client->getRunStep( ... );
=head3 Parameters
=over 4
=item * C<thread_id> (in path) (Required) - The ID of the thread to which the run and run step belongs.
Type: C<string>
=item * C<run_id> (in path) (Required) - The ID of the run to which the run step belongs.
Type: C<string>
=item * C<step_id> (in path) (Required) - The ID of the run step to retrieve.
Type: C<string>
=item * C<include[]> (in query) (Optional) - A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.
See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.
Type: C<array>
=back
=head3 Responses
=head3 Status Code: C<200>
OK
Content Types:
=over 4
=item * C<application/json>
Example:
    {
       "usage" : null,
       "last_error" : null
    }
=back
=head1 SEE ALSO
L<OpenAPI::Client::OpenAI::Path>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.0 or,
at your option, any later version of Perl 5 you may have available.
=cut