Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:Update OpenAPI specification with precomputable property and apiKeyAuth scheme #18

Merged
merged 1 commit into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ public sealed partial class UltravoxV1BaseToolDefinition
[global::System.Text.Json.Serialization.JsonPropertyName("timeout")]
public string? Timeout { get; set; }

/// <summary>
/// The tool is guaranteed to be non-mutating, repeatable, and free of side-effects. Such tools<br/>
/// can safely be executed speculatively, reducing their effective latency. However, the fact they<br/>
/// were called may not be reflected in the call history if their result ends up unused.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("precomputable")]
public bool? Precomputable { get; set; }

/// <summary>
/// Details for an HTTP tool.
/// </summary>
Expand Down Expand Up @@ -100,6 +108,11 @@ public sealed partial class UltravoxV1BaseToolDefinition
/// 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.
/// </param>
/// <param name="precomputable">
/// The tool is guaranteed to be non-mutating, repeatable, and free of side-effects. Such tools<br/>
/// can safely be executed speculatively, reducing their effective latency. However, the fact they<br/>
/// were called may not be reflected in the call history if their result ends up unused.
/// </param>
/// <param name="http">
/// Details for an HTTP tool.
/// </param>
Expand All @@ -116,6 +129,7 @@ public UltravoxV1BaseToolDefinition(
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1AutomaticParameter>? automaticParameters,
global::Ultravox.UltravoxV1ToolRequirements? requirements,
string? timeout,
bool? precomputable,
global::Ultravox.UltravoxV1BaseHttpToolDetails? http,
object? client)
{
Expand All @@ -126,6 +140,7 @@ public UltravoxV1BaseToolDefinition(
this.AutomaticParameters = automaticParameters;
this.Requirements = requirements;
this.Timeout = timeout;
this.Precomputable = precomputable;
this.Http = http;
this.Client = client;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ public sealed partial class UltravoxV1CallTool
[global::System.Text.Json.Serialization.JsonPropertyName("timeout")]
public string? Timeout { get; set; }

/// <summary>
/// The tool is guaranteed to be non-mutating, repeatable, and free of side-effects. Such tools<br/>
/// can safely be executed speculatively, reducing their effective latency. However, the fact they<br/>
/// were called may not be reflected in the call history if their result ends up unused.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("precomputable")]
public bool? Precomputable { get; set; }

/// <summary>
/// Details for an HTTP tool.
/// </summary>
Expand Down Expand Up @@ -81,6 +89,11 @@ public sealed partial class UltravoxV1CallTool
/// 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.
/// </param>
/// <param name="precomputable">
/// The tool is guaranteed to be non-mutating, repeatable, and free of side-effects. Such tools<br/>
/// can safely be executed speculatively, reducing their effective latency. However, the fact they<br/>
/// were called may not be reflected in the call history if their result ends up unused.
/// </param>
/// <param name="http">
/// Details for an HTTP tool.
/// </param>
Expand All @@ -95,6 +108,7 @@ public UltravoxV1CallTool(
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1StaticParameter>? staticParameters,
global::System.Collections.Generic.IList<global::Ultravox.UltravoxV1AutomaticParameter>? automaticParameters,
string? timeout,
bool? precomputable,
global::Ultravox.UltravoxV1HttpCallToolDetails? http,
object? client)
{
Expand All @@ -103,6 +117,7 @@ public UltravoxV1CallTool(
this.StaticParameters = staticParameters;
this.AutomaticParameters = automaticParameters;
this.Timeout = timeout;
this.Precomputable = precomputable;
this.Http = http;
this.Client = client;
}
Expand Down
6 changes: 6 additions & 0 deletions src/libs/Ultravox/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1683,6 +1683,9 @@ components:
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."
precomputable:
type: boolean
description: "The tool is guaranteed to be non-mutating, repeatable, and free of side-effects. Such tools\n can safely be executed speculatively, reducing their effective latency. However, the fact they\n were called may not be reflected in the call history if their result ends up unused."
http:
allOf:
- $ref: '#/components/schemas/ultravox.v1.BaseHttpToolDetails'
Expand Down Expand Up @@ -1769,6 +1772,9 @@ components:
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."
precomputable:
type: boolean
description: "The tool is guaranteed to be non-mutating, repeatable, and free of side-effects. Such tools\n can safely be executed speculatively, reducing their effective latency. However, the fact they\n were called may not be reflected in the call history if their result ends up unused."
http:
allOf:
- $ref: '#/components/schemas/ultravox.v1.HttpCallToolDetails'
Expand Down
Loading