Skip to content

Commit

Permalink
Update CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
@mkht
mkht committed Nov 13, 2024
1 parent 3d8f683 commit 64259e5
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Changelog
### Unreleased
- Add `-All`, `-Limit` & `-Order` params for `Get-OpenAIFile`.

### 4.10.0
- Add `-Prediction` param for `Request-ChatCompletion`.
ref: [Use Predicted Outputs](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs)
Expand Down
82 changes: 82 additions & 0 deletions PSOpenAI-Help.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3879,6 +3879,45 @@ If not specified, it will try to use `$global:OPENAI_ORGANIZATION` or `$env:OPEN
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Limit</maml:name>
<maml:description>
<maml:para>A limit on the number of objects to be returned. Limit can range between 1 and 10000, and the default is 10000.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>10000</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>All</maml:name>
<maml:description>
<maml:para>When this switch is specified, all objects will be retrieved.</maml:para>
</maml:description>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Order</maml:name>
<maml:description>
<maml:para>Sort order by the created timestamp of the objects. `asc` for ascending order and `desc` for descending order. The default is `desc`</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" command:variableLength="false">asc</command:parameterValue>
<command:parameterValue required="false" command:variableLength="false">desc</command:parameterValue>
</command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>desc</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TimeoutSec</maml:name>
<maml:description>
Expand Down Expand Up @@ -3975,6 +4014,42 @@ If not specified, it will try to use `$global:OPENAI_ORGANIZATION` or `$env:OPEN
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Limit</maml:name>
<maml:description>
<maml:para>A limit on the number of objects to be returned. Limit can range between 1 and 10000, and the default is 10000.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>10000</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>All</maml:name>
<maml:description>
<maml:para>When this switch is specified, all objects will be retrieved.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Order</maml:name>
<maml:description>
<maml:para>Sort order by the created timestamp of the objects. `asc` for ascending order and `desc` for descending order. The default is `desc`</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>desc</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TimeoutSec</maml:name>
<maml:description>
Expand Down Expand Up @@ -4069,6 +4144,13 @@ If not specified, it will try to use `$global:OPENAI_ORGANIZATION` or `$env:OPEN
<maml:para>This command retrieves a file with the specified ID from OpenAI.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
<dev:code>PS C:\&gt; Get-OpenAIFile -Purpose "assistants" -All</dev:code>
<dev:remarks>
<maml:para>Lists all files where the purpose attribute is assistants.</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:relatedLinks>
<maml:navigationLink>
Expand Down

0 comments on commit 64259e5

Please sign in to comment.