TypeSpec for Azure AI Inference

cSpell.json

@@ -1037,6 +1037,12 @@
                 "rrggbb"
             ]
         },
+        {
+            "filename": "**/specification/ai/data-plane/ModelClient/**/openapi.json",
+            "words": [
+                "ubinary"
+            ]
+        },
         {
             "filename": "**/specification/ai/data-plane/DocumentIntelligence/**/DocumentIntelligence.json",
             "words": [

specification/ai/ModelClient/client.tsp

@@ -0,0 +1,119 @@
+import "@azure-tools/typespec-client-generator-core";
+
+import "./main.tsp";
+
+using Azure.ClientGenerator.Core;
+using TypeSpec.Versioning;
+
+@useDependency(AI.Model.Versions.v2024_05_01_Preview)
+namespace Customizations; // The actual name here doesn't matter and is here for organization purposes only
+
+// Are these needed?
+@@usage(AI.Model.ChatCompletions, Usage.output);
+@@usage(AI.Model.ModelInfo, Usage.output);
+@@usage(AI.Model.StreamingChatCompletionsUpdate, Usage.output);
+@@usage(AI.Model.StreamingChatChoiceUpdate, Usage.output);
+@@usage(AI.Model.StreamingChatResponseMessageUpdate, Usage.output);
+@@usage(AI.Model.StreamingChatResponseToolCallUpdate, Usage.output);
+
+// Since we made all operator methods internal, we need to expliclty
+// say we still want the models they use to be public.
+@@access(AI.Model.ChatChoice, Access.public);
+@@access(AI.Model.ChatCompletions, Access.public);
+@@access(AI.Model.ChatCompletionsToolCall, Access.public);
+@@access(AI.Model.ChatCompletionsToolDefinition, Access.public);
+@@access(AI.Model.ChatCompletionsNamedToolChoice, Access.public);
+@@access(AI.Model.ChatCompletionsNamedToolChoiceFunction, Access.public);
+@@access(AI.Model.ChatCompletionsResponseFormat, Access.public);
+@@access(AI.Model.ChatCompletionsResponseFormatJSON, Access.public);
+@@access(AI.Model.ChatCompletionsResponseFormatText, Access.public);
+@@access(AI.Model.ChatCompletionsToolCall, Access.public);
+@@access(AI.Model.ChatCompletionsToolDefinition, Access.public);
+@@access(AI.Model.ChatCompletionsToolChoicePreset, Access.public);
+@@access(AI.Model.ChatRequestAssistantMessage, Access.public);
+@@access(AI.Model.ChatRequestMessage, Access.public);
+@@access(AI.Model.ChatRequestSystemMessage, Access.public);
+@@access(AI.Model.ChatRequestToolMessage, Access.public);
+@@access(AI.Model.ChatRequestUserMessage, Access.public);
+@@access(AI.Model.ChatResponseMessage, Access.public);
+@@access(AI.Model.ChatRole, Access.public);
+@@access(AI.Model.CompletionsFinishReason, Access.public);
+@@access(AI.Model.CompletionsUsage, Access.public);
+@@access(AI.Model.EmbeddingEncodingFormat, Access.public, "python");
+@@access(AI.Model.EmbeddingInput, Access.public, "python");
+@@access(AI.Model.EmbeddingInputType, Access.public, "python");
+@@access(AI.Model.EmbeddingItem, Access.public, "python");
+@@access(AI.Model.EmbeddingsResult, Access.public, "python");
+@@access(AI.Model.EmbeddingsUsage, Access.public, "python");
+@@access(AI.Model.FunctionCall, Access.public);
+@@access(AI.Model.FunctionDefinition, Access.public);
+@@access(AI.Model.ModelInfo, Access.public);
+@@access(AI.Model.ModelType, Access.public);
+@@access(AI.Model.ChatMessageContentItem, Access.public);
+@@access(AI.Model.ChatMessageTextContentItem, Access.public);
+@@access(AI.Model.ChatMessageImageContentItem, Access.public);
+@@access(AI.Model.ChatMessageImageUrl, Access.public);
+@@access(AI.Model.ChatMessageImageDetailLevel, Access.public);
+@@access(AI.Model.StreamingChatCompletionsUpdate, Access.public, "python");
+@@access(AI.Model.StreamingChatChoiceUpdate, Access.public, "python");
+@@access(AI.Model.StreamingChatResponseMessageUpdate, Access.public, "python");
+@@access(AI.Model.StreamingChatResponseToolCallUpdate, Access.public, "python");
+
+// The operators need to be hidden, since we hand-write the public versions of those
+@@access(AI.Model.getChatCompletions, Access.internal);
+@@access(AI.Model.getEmbeddings, Access.internal);
+@@access(AI.Model.getImageEmbeddings, Access.internal);
+@@access(AI.Model.getModelInfo, Access.internal, "python");
+
+// We use shorter names in the Python client library
+@@clientName(AI.Model.ChatRequestSystemMessage, "SystemMessage", "python");
+@@clientName(AI.Model.ChatRequestUserMessage, "UserMessage", "python");
+@@clientName(AI.Model.ChatRequestAssistantMessage,
+  "AssistantMessage",
+  "python"
+);
+@@clientName(AI.Model.ChatRequestToolMessage, "ToolMessage", "python");
+@@clientName(AI.Model.ChatMessageContentItem, "ContentItem", "python");
+@@clientName(AI.Model.ChatMessageTextContentItem, "TextContentItem", "python");
+@@clientName(AI.Model.ChatMessageImageContentItem,
+  "ImageContentItem",
+  "python"
+);
+@@clientName(AI.Model.ChatMessageImageUrl, "ImageUrl", "python");
+@@clientName(AI.Model.ChatMessageImageDetailLevel,
+  "ImageDetailLevel",
+  "python"
+);
+
+@client({
+  name: "ChatCompletionsClient",
+  service: AI.Model,
+})
+interface Client1 {
+  complete is AI.Model.getChatCompletions;
+  getModelInfo is AI.Model.getModelInfo;
+}
+
+@client(
+  {
+    name: "EmbeddingsClient",
+    service: AI.Model,
+  },
+  "python"
+)
+interface Client2 {
+  embed is AI.Model.getEmbeddings;
+  getModelInfo is AI.Model.getModelInfo;
+}
+
+@client(
+  {
+    name: "ImageEmbeddingsClient",
+    service: AI.Model,
+  },
+  "python"
+)
+interface Client3 {
+  embed is AI.Model.getImageEmbeddings;
+  getModelInfo is AI.Model.getModelInfo;
+}

specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json

@@ -0,0 +1,72 @@
+{
+  "title": "maximum set chat completion",
+  "operationId": "GetChatCompletions",
+  "parameters": {
+    "api-version": "2024-05-01-preview",
+    "extra-parameters": "error",
+    "body": {
+      "messages": [
+        {
+          "role": "ChatRequestMessage"
+        }
+      ],
+      "frequency_penalty": -2,
+      "stream": true,
+      "presence_penalty": -1,
+      "temperature": 0,
+      "top_p": 0,
+      "max_tokens": 0,
+      "response_format": {
+        "type": "ChatCompletionsResponseFormat"
+      },
+      "stop": [
+        "dcfnxrdeumnoytdaooqkbl"
+      ],
+      "tools": [
+        {
+          "type": "function",
+          "function": {
+            "name": "ikvkykzp",
+            "description": "gofxoftbpdi"
+          }
+        }
+      ],
+      "seed": 21,
+      "model": "askiizcjob"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "kgousajxgzyhugvqekuswuqbk",
+        "created": 18,
+        "model": "zjxvtpxhzhvgjrhit",
+        "usage": {
+          "completion_tokens": 19,
+          "prompt_tokens": 28,
+          "total_tokens": 16
+        },
+        "choices": [
+          {
+            "index": 7,
+            "finish_reason": "stop",
+            "message": {
+              "role": "system",
+              "content": "jnsnrwblpuokzbkrzdcwubpfz",
+              "tool_calls": [
+                {
+                  "id": "yrobmilsrugmbwukmzo",
+                  "type": "function",
+                  "function": {
+                    "name": "ikvkykzp",
+                    "arguments": "oqxvktuduomvckic"
+                  }
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  }
+}

specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json

@@ -0,0 +1,38 @@
+{
+  "title": "minimum set chat completion",
+  "operationId": "GetChatCompletions",
+  "parameters": {
+    "api-version": "2024-05-01-preview",
+    "body": {
+      "messages": [
+        {
+          "role": "ChatRequestMessage"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "kgousajxgzyhugvqekuswuqbk",
+        "created": 18,
+        "model": "zjxvtpxhzhvgjrhit",
+        "usage": {
+          "completion_tokens": 19,
+          "prompt_tokens": 28,
+          "total_tokens": 16
+        },
+        "choices": [
+          {
+            "index": 7,
+            "finish_reason": "stop",
+            "message": {
+              "role": "system",
+              "content": "jnsnrwblpuokzbkrzdcwubpfz"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json

@@ -0,0 +1,34 @@
+{
+  "title": "maximum set embeddings",
+  "operationId": "GetEmbeddings",
+  "parameters": {
+    "api-version": "2024-05-01-preview",
+    "extra-parameters": "error",
+    "body": {
+      "input": [
+        "p"
+      ],
+      "dimensions": 11,
+      "encoding_format": "base64",
+      "input_type": "text",
+      "model": "kwkpluujwiabfquhkaugttxut"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "cknxthfa",
+        "data": [
+          {
+            "index": 21
+          }
+        ],
+        "usage": {
+          "prompt_tokens": 4,
+          "total_tokens": 22
+        },
+        "model": "uvrmctbnze"
+      }
+    }
+  }
+}

specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json

@@ -0,0 +1,32 @@
+{
+  "title": "minimum set embeddings",
+  "operationId": "GetEmbeddings",
+  "parameters": {
+    "api-version": "2024-05-01-preview",
+    "body": {
+      "input": [
+        "ujbdzqgintkjjorqvgtyqxehwod"
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "kmclubpbyrjjrcihu",
+        "data": [
+          {
+            "embedding": [
+              3
+            ],
+            "index": 20
+          }
+        ],
+        "usage": {
+          "prompt_tokens": 17,
+          "total_tokens": 25
+        },
+        "model": "gg"
+      }
+    }
+  }
+}

specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json

@@ -0,0 +1,37 @@
+{
+  "title": "maximum set image embeddings",
+  "operationId": "GetImageEmbeddings",
+  "parameters": {
+    "api-version": "2024-05-01-preview",
+    "extra-parameters": "error",
+    "body": {
+      "input": [
+        {
+          "image": "puqkvvlvgcjyzughesnkena",
+          "text": "azrzyjsmnuefqpowpvfmyobeehqsni"
+        }
+      ],
+      "dimensions": 26,
+      "encoding_format": "base64",
+      "input_type": "text",
+      "model": "jyb"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "cknxthfa",
+        "data": [
+          {
+            "index": 21
+          }
+        ],
+        "usage": {
+          "prompt_tokens": 4,
+          "total_tokens": 22
+        },
+        "model": "uvrmctbnze"
+      }
+    }
+  }
+}

specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json

@@ -0,0 +1,34 @@
+{
+  "title": "minimum set image embeddings",
+  "operationId": "GetImageEmbeddings",
+  "parameters": {
+    "api-version": "2024-05-01-preview",
+    "body": {
+      "input": [
+        {
+          "image": "gvmojtfooxixxzayrditjlyymg"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "kmclubpbyrjjrcihu",
+        "data": [
+          {
+            "embedding": [
+              3
+            ],
+            "index": 20
+          }
+        ],
+        "usage": {
+          "prompt_tokens": 17,
+          "total_tokens": 25
+        },
+        "model": "gg"
+      }
+    }
+  }
+}