Skip to content

Commit

Permalink
feat: Updated OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 12, 2024
1 parent ca9f4ca commit 32fd382
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ public sealed partial class UltravoxV1BaseToolDefinition
[global::System.Text.Json.Serialization.JsonPropertyName("requirements")]
public global::Ultravox.UltravoxV1ToolRequirements? Requirements { get; set; }

/// <summary>
/// The maximum amount of time the tool is allowed for execution. The conversation is frozen<br/>
/// while tools run, so prefer sticking to the default unless you're comfortable with that<br/>
/// consequence. If your tool is too slow for the default and can't be made faster, still try to<br/>
/// keep this timeout as low as possible.<br/>
/// Note: For read APIs, 0s actually means unset (i.e. use the default).
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("timeout")]
public string? Timeout { get; set; }

/// <summary>
/// Details for an HTTP tool.
/// </summary>
Expand Down Expand Up @@ -85,6 +95,13 @@ public sealed partial class UltravoxV1BaseToolDefinition
/// <param name="requirements">
/// Requirements that must be fulfilled when creating a call for the tool to be used.
/// </param>
/// <param name="timeout">
/// The maximum amount of time the tool is allowed for execution. The conversation is frozen<br/>
/// while tools run, so prefer sticking to the default unless you're comfortable with that<br/>
/// consequence. If your tool is too slow for the default and can't be made faster, still try to<br/>
/// keep this timeout as low as possible.<br/>
/// Note: For read APIs, 0s actually means unset (i.e. use the default).
/// </param>
/// <param name="http">
/// Details for an HTTP tool.
/// </param>
Expand All @@ -100,6 +117,7 @@ public UltravoxV1BaseToolDefinition(
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1StaticParameter>? staticParameters,
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1AutomaticParameter>? automaticParameters,
global::Ultravox.UltravoxV1ToolRequirements? requirements,
string? timeout,
global::Ultravox.UltravoxV1BaseHttpToolDetails? http,
object? client)
{
Expand All @@ -109,6 +127,7 @@ public UltravoxV1BaseToolDefinition(
this.StaticParameters = staticParameters;
this.AutomaticParameters = automaticParameters;
this.Requirements = requirements;
this.Timeout = timeout;
this.Http = http;
this.Client = client;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ public sealed partial class UltravoxV1CallTool
[global::System.Text.Json.Serialization.JsonPropertyName("automaticParameters")]
public global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1AutomaticParameter>? AutomaticParameters { get; set; }

/// <summary>
/// The maximum amount of time the tool is allowed for execution. The conversation is frozen<br/>
/// while tools run, so prefer sticking to the default unless you're comfortable with that<br/>
/// consequence. If your tool is too slow for the default and can't be made faster, still try to<br/>
/// keep this timeout as low as possible.<br/>
/// Note: For read APIs, 0s actually means unset (i.e. use the default).
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("timeout")]
public string? Timeout { get; set; }

/// <summary>
/// Details for an HTTP tool.
/// </summary>
Expand Down Expand Up @@ -66,6 +76,13 @@ public sealed partial class UltravoxV1CallTool
/// <param name="automaticParameters">
/// Parameters automatically set by the system.
/// </param>
/// <param name="timeout">
/// The maximum amount of time the tool is allowed for execution. The conversation is frozen<br/>
/// while tools run, so prefer sticking to the default unless you're comfortable with that<br/>
/// consequence. If your tool is too slow for the default and can't be made faster, still try to<br/>
/// keep this timeout as low as possible.<br/>
/// Note: For read APIs, 0s actually means unset (i.e. use the default).
/// </param>
/// <param name="http">
/// Details for an HTTP tool.
/// </param>
Expand All @@ -79,13 +96,15 @@ public UltravoxV1CallTool(
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1DynamicParameter>? dynamicParameters,
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1StaticParameter>? staticParameters,
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1AutomaticParameter>? automaticParameters,
string? timeout,
global::Ultravox.UltravoxV1HttpCallToolDetails? http,
object? client)
{
this.Description = description;
this.DynamicParameters = dynamicParameters;
this.StaticParameters = staticParameters;
this.AutomaticParameters = automaticParameters;
this.Timeout = timeout;
this.Http = http;
this.Client = client;
}
Expand Down
8 changes: 8 additions & 0 deletions src/libs/Ultravox/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1557,6 +1557,10 @@ components:
allOf:
- $ref: '#/components/schemas/ultravox.v1.ToolRequirements'
description: Requirements that must be fulfilled when creating a call for the tool to be used.
timeout:
pattern: '^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$'
type: string
description: "The maximum amount of time the tool is allowed for execution. The conversation is frozen\n while tools run, so prefer sticking to the default unless you're comfortable with that\n consequence. If your tool is too slow for the default and can't be made faster, still try to\n keep this timeout as low as possible.\n Note: For read APIs, 0s actually means unset (i.e. use the default)."
http:
allOf:
- $ref: '#/components/schemas/ultravox.v1.BaseHttpToolDetails'
Expand Down Expand Up @@ -1639,6 +1643,10 @@ components:
items:
$ref: '#/components/schemas/ultravox.v1.AutomaticParameter'
description: Parameters automatically set by the system.
timeout:
pattern: '^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$'
type: string
description: "The maximum amount of time the tool is allowed for execution. The conversation is frozen\n while tools run, so prefer sticking to the default unless you're comfortable with that\n consequence. If your tool is too slow for the default and can't be made faster, still try to\n keep this timeout as low as possible.\n Note: For read APIs, 0s actually means unset (i.e. use the default)."
http:
allOf:
- $ref: '#/components/schemas/ultravox.v1.HttpCallToolDetails'
Expand Down

0 comments on commit 32fd382

Please sign in to comment.