OpenAI Functions

sdk/openai/azure-ai-openai/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/openai/azure-ai-openai",
-  "Tag": "java/openai/azure-ai-openai_2a6e71fe2e"
+  "Tag": "java/openai/azure-ai-openai_94811d7537"
 }

sdk/openai/azure-ai-openai/pom.xml

@@ -50,6 +50,7 @@
       --add-exports com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
       --add-opens com.azure.ai.openai/com.azure.ai.openai=ALL-UNNAMED
       --add-opens com.azure.ai.openai/com.azure.ai.openai.implementation=com.fasterxml.jackson.databind
+      --add-opens com.azure.ai.openai/com.azure.ai.openai.functions=com.fasterxml.jackson.databind
     </javaModulesSurefireArgLine>
     <jacoco.skip>true</jacoco.skip>
   </properties>

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/OpenAIServiceVersion.java

@@ -15,7 +15,10 @@ public enum OpenAIServiceVersion implements ServiceVersion {
     V2023_05_15("2023-05-15"),
 
     /** Enum value 2023-06-01-preview. */
-    V2023_06_01_PREVIEW("2023-06-01-preview");
+    V2023_06_01_PREVIEW("2023-06-01-preview"),
+
+    /** Enum value 2023-07-01-preview. */
+    V2023_07_01_PREVIEW("2023-07-01-preview");
 
     private final String version;
 
@@ -35,6 +38,6 @@ public String getVersion() {
      * @return The latest {@link OpenAIServiceVersion}.
      */
     public static OpenAIServiceVersion getLatest() {
-        return V2023_06_01_PREVIEW;
+        return V2023_07_01_PREVIEW;
     }
 }

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/implementation/FunctionCall.java

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.openai.implementation;
+
+import com.azure.core.annotation.Generated;
+import com.azure.core.annotation.Immutable;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** The name and arguments of a function that should be called, as generated by the model. */
+@Immutable
+public final class FunctionCall {
+    /*
+     * The name of the function to call.
+     */
+    @Generated
+    @JsonProperty(value = "name")
+    private String name;
+
+    /*
+     * The arguments to call the function with, as generated by the model in JSON format.
+     * Note that the model does not always generate valid JSON, and may hallucinate parameters
+     * not defined by your function schema. Validate the arguments in your code before calling
+     * your function.
+     */
+    @Generated
+    @JsonProperty(value = "arguments")
+    private String arguments;
+
+    /**
+     * Creates an instance of FunctionCall class.
+     *
+     * @param name the name value to set.
+     * @param arguments the arguments value to set.
+     */
+    @Generated
+    @JsonCreator
+    public FunctionCall(
+            @JsonProperty(value = "name") String name, @JsonProperty(value = "arguments") String arguments) {
+        this.name = name;
+        this.arguments = arguments;
+    }
+
+    /**
+     * Get the name property: The name of the function to call.
+     *
+     * @return the name value.
+     */
+    @Generated
+    public String getName() {
+        return this.name;
+    }
+
+    /**
+     * Get the arguments property: The arguments to call the function with, as generated by the model in JSON format.
+     * Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your
+     * function schema. Validate the arguments in your code before calling your function.
+     *
+     * @return the arguments value.
+     */
+    @Generated
+    public String getArguments() {
+        return this.arguments;
+    }
+}

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/implementation/FunctionCallModelBase.java

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.openai.implementation;
+
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+
+@JsonSubTypes({
+    @JsonSubTypes.Type(name="preset", value = FunctionCallPresetFunctionCallModel.class),
+    @JsonSubTypes.Type(name="custom", value = FunctionNameFunctionCallModel.class)
+})
+/** The FunctionCallModelBase model. */
+public class FunctionCallModelBase {
+    /** Creates an instance of FunctionCallModelBase class. */
+    protected FunctionCallModelBase() {}
+}

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/implementation/FunctionCallPreset.java

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.openai.implementation;
+
+import com.azure.core.annotation.Generated;
+import com.azure.core.util.ExpandableStringEnum;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import java.util.Collection;
+
+/** Preset values to control how the mode; responds to function calls. */
+public final class FunctionCallPreset extends ExpandableStringEnum<FunctionCallPreset> {
+    /** Means the model can pick between an end-user or calling a function. */
+    @Generated public static final FunctionCallPreset AUTO = fromString("auto");
+
+    /** Means the model does not call a function, and responds to the end-user. */
+    @Generated public static final FunctionCallPreset NONE = fromString("none");
+
+    /**
+     * Creates a new instance of FunctionCallPreset value.
+     *
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Generated
+    @Deprecated
+    public FunctionCallPreset() {}
+
+    /**
+     * Creates or finds a FunctionCallPreset from its string representation.
+     *
+     * @param name a name to look for.
+     * @return the corresponding FunctionCallPreset.
+     */
+    @Generated
+    @JsonCreator
+    public static FunctionCallPreset fromString(String name) {
+        return fromString(name, FunctionCallPreset.class);
+    }
+
+    /**
+     * Gets known FunctionCallPreset values.
+     *
+     * @return known FunctionCallPreset values.
+     */
+    @Generated
+    public static Collection<FunctionCallPreset> values() {
+        return values(FunctionCallPreset.class);
+    }
+}

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/implementation/FunctionCallPresetFunctionCallModel.java

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.openai.implementation;
+
+import com.azure.core.annotation.Immutable;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/** The FunctionCallPresetFunctionCallModel model. */
+@Immutable
+@JsonTypeName("preset")
+public final class FunctionCallPresetFunctionCallModel extends FunctionCallModelBase {
+    private final FunctionCallPreset value;
+
+    /**
+     * Creates an instance of FunctionCallPresetFunctionCallModel class.
+     *
+     * @param value the value.
+     */
+    public FunctionCallPresetFunctionCallModel(FunctionCallPreset value) {
+        this.value = value;
+    }
+
+    /**
+     * Gets the value.
+     *
+     * @return the value.
+     */
+    @JsonValue
+    public FunctionCallPreset getValue() {
+        return this.value;
+    }
+}

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/implementation/FunctionDefinition.java

@@ -0,0 +1,112 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.openai.implementation;
+
+import com.azure.core.annotation.Fluent;
+import com.azure.core.annotation.Generated;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * The definition of a function that can be called by the model. See the [guide](/docs/guides/gpt/function-calling) for
+ * examples.
+ */
+@Fluent
+public final class FunctionDefinition {
+    /*
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes,
+     * with a maximum length of 64.
+     */
+    @Generated
+    @JsonProperty(value = "name")
+    private String name;
+
+    /*
+     * The description of what the function does.
+     */
+    @Generated
+    @JsonProperty(value = "description")
+    private String description;
+
+    /*
+     * The parameters the functions accepts, described as a JSON Schema object.
+     * See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema
+     * reference](https://json-schema.org/understanding-json-schema/)
+     * for documentation about the format.
+     */
+    @Generated
+    @JsonProperty(value = "parameters")
+    private Object parameters;
+
+    /**
+     * Creates an instance of FunctionDefinition class.
+     *
+     * @param name the name value to set.
+     */
+    @Generated
+    @JsonCreator
+    public FunctionDefinition(@JsonProperty(value = "name") String name) {
+        this.name = name;
+    }
+
+    /**
+     * Get the name property: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and
+     * dashes, with a maximum length of 64.
+     *
+     * @return the name value.
+     */
+    @Generated
+    public String getName() {
+        return this.name;
+    }
+
+    /**
+     * Get the description property: The description of what the function does.
+     *
+     * @return the description value.
+     */
+    @Generated
+    public String getDescription() {
+        return this.description;
+    }
+
+    /**
+     * Set the description property: The description of what the function does.
+     *
+     * @param description the description value to set.
+     * @return the FunctionDefinition object itself.
+     */
+    @Generated
+    public FunctionDefinition setDescription(String description) {
+        this.description = description;
+        return this;
+    }
+
+    /**
+     * Get the parameters property: The parameters the functions accepts, described as a JSON Schema object. See the
+     * [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema
+     * reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
+     *
+     * @return the parameters value.
+     */
+    @Generated
+    public Object getParameters() {
+        return this.parameters;
+    }
+
+    /**
+     * Set the parameters property: The parameters the functions accepts, described as a JSON Schema object. See the
+     * [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema
+     * reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
+     *
+     * @param parameters the parameters value to set.
+     * @return the FunctionDefinition object itself.
+     */
+    @Generated
+    public FunctionDefinition setParameters(Object parameters) {
+        this.parameters = parameters;
+        return this;
+    }
+}

sdk/openai/azure-ai-openai/src/main/java/com/azure/ai/openai/implementation/FunctionNameFunctionCallModel.java

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.openai.implementation;
+
+import com.azure.ai.openai.models.FunctionName;
+import com.azure.core.annotation.Immutable;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * The FunctionNameFunctionCallModel model.
+ */
+@Immutable
+@JsonTypeName("custom")
+public final class FunctionNameFunctionCallModel extends FunctionCallModelBase {
+    private final FunctionName value;
+
+    /**
+     * Creates an instance of FunctionNameFunctionCallModel class.
+     *
+     * @param value the value.
+     */
+    public FunctionNameFunctionCallModel(FunctionName value) {
+        this.value = value;
+    }
+
+    /**
+     * Gets the value.
+     *
+     * @return the value.
+     */
+    @JsonValue
+    public FunctionName getValue() {
+        return this.value;
+    }
+}