OpenAI client

eng/config.json

@@ -36,6 +36,10 @@
             "Name": "azfile",
             "CoverageGoal": 0.75
         },
+        {
+            "Name": "azopenai",
+            "CoverageGoal": 0.45
+        },
         {
             "Name": "aztemplate",
             "CoverageGoal": 0.50

sdk/cognitiveservices/azopenai/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History
+
+## 0.1.0 (unreleased)
+
+* Initial release of the `azopenai` library

sdk/cognitiveservices/azopenai/LICENSE.txt

@@ -0,0 +1,21 @@
+ MIT License
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE

sdk/cognitiveservices/azopenai/README.md

@@ -0,0 +1,107 @@
+# Azure OpenAI client module for Go
+
+Azure OpenAI is a managed service that allows developers to deploy, tune, and generate content from OpenAI models on Azure resources.
+
+The Azure OpenAI client library for GO is an adaptation of OpenAI's REST APIs that provides an idiomatic interface and rich integration with the rest of the Azure SDK ecosystem.
+
+[Source code][azopenai_repo] | [Package (pkg.go.dev)][azopenai_pkg_go] | [REST API documentation][openai_rest_docs] | [Product documentation][openai_docs]
+
+## Getting started
+
+### Prerequisites
+
+* Go, version 1.18 or higher - [Install Go](https://go.dev/doc/install)
+* [Azure subscription][azure_sub]
+* [Azure OpenAI access][azure_openai_access]
+
+### Install the packages
+
+Install the `azopenai` and `azidentity` modules with `go get`:
+
+```bash
+go get github.com/Azure/azure-sdk-for-go/sdk/cognitiveservices/azopenai
+go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
+```
+
+The [azidentity][azure_identity] module is used for authentication during client construction.
+
+### Authentication
+
+<!-- TODO: Add api-key authentication instructions -->
+
+#### Create a client
+
+Constructing the client requires your vault's URL, which you can get from the Azure CLI or the Azure Portal.
+
+```go
+import (
+	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
+	"github.com/Azure/azure-sdk-for-go/sdk/cognitiveservices/azopenai"
+)
+
+func main() {
+	endpoint     := "https://<TODO: OpenAI endpoint>"
+	apiKey       := "<TODO: OpenAI API key>"
+
+	var err error
+	cred := azopenai.KeyCredential{APIKey: apiKey}
+	client, err := azopenai.NewClientWithKeyCredential(endpoint, cred, &options)
+	if err != nil {
+		// TODO: handle error
+	}
+}
+```
+
+## Key concepts
+
+See [Key concepts][openai_key_concepts] in the product documentation for more details about general concepts.
+
+## Troubleshooting
+
+### Error Handling
+
+All methods that send HTTP requests return `*azcore.ResponseError` when these requests fail. `ResponseError` has error details and the raw response from the service.
+
+### Logging
+
+This module uses the logging implementation in `azcore`. To turn on logging for all Azure SDK modules, set `AZURE_SDK_GO_LOGGING` to `all`. By default, the logger writes to stderr. Use the `azcore/log` package to control log output. For example, logging only HTTP request and response events, and printing them to stdout:
+
+```go
+import azlog "github.com/Azure/azure-sdk-for-go/sdk/azcore/log"
+
+// Print log events to stdout
+azlog.SetListener(func(cls azlog.Event, msg string) {
+	fmt.Println(msg)
+})
+
+// Includes only requests and responses in credential logs
+azlog.SetEvents(azlog.EventRequest, azlog.EventResponse)
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to agree to a [Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights to use your contribution.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate
+the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to
+do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information, see
+the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or
+comments.
+
+<!-- LINKS -->
+<!-- https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/cognitiveservices/azopenai ->
+<!-- https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/cognitiveservices/azopenai -->
+[azure_openai_access]: https://learn.microsoft.com/azure/cognitive-services/openai/overview#how-do-i-get-access-to-azure-openai
+[azopenai_repo]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk
+[azopenai_pkg_go]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk
+[azure_identity]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity
+[azure_sub]: https://azure.microsoft.com/free/
+[openai_docs]: https://learn.microsoft.com/azure/cognitive-services/openai
+[openai_key_concepts]: https://learn.microsoft.com/azure/cognitive-services/openai/overview#key-concepts
+[openai_rest_docs]: https://learn.microsoft.com/azure/cognitive-services/openai/reference
+[cla]: https://cla.microsoft.com
+[coc]: https://opensource.microsoft.com/codeofconduct/
+[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
+[coc_contact]: mailto:opencode@microsoft.com

sdk/cognitiveservices/azopenai/assets.json

@@ -0,0 +1,6 @@
+{
+  "AssetsRepo": "Azure/azure-sdk-assets",
+  "AssetsRepoPrefixPath": "go",
+  "TagPrefix": "go/cognitiveservices/azopenai",
+  "Tag": "go/cognitiveservices/azopenai_0bc6dc4171"
+}

sdk/cognitiveservices/azopenai/autorest.md

@@ -0,0 +1,150 @@
+# Go
+
+These settings apply only when `--go` is specified on the command line.
+
+``` yaml
+input-file:
+- https://github.com/mikekistler/azure-rest-api-specs/blob/baed660fd853b4a387ca9f0b9491fd1414b66e9e/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-03-15-preview/inference.json
+output-folder: ../azopenai
+clear-output-folder: false
+module: github.com/Azure/azure-sdk-for-go/sdk/cognitiveservices/azopenai
+license-header: MICROSOFT_MIT_NO_VERSION
+openapi-type: data-plane
+go: true
+use: "@autorest/go@4.0.0-preview.50"
+```
+
+## Transformations
+
+``` yaml
+directive:
+  # Add x-ms-parameter-location to parameters in x-ms-parameterized-host
+  - from: openapi-document
+    where: $.servers.0.variables.endpoint
+    debug: true
+    transform: $["x-ms-parameter-location"] = "client";
+
+  # Make deploymentId a client parameter
+  # This must be done in each operation as the parameter is not defined in the components section
+  - from: openapi-document
+    where: $.paths..parameters..[?(@.name=='deploymentId')]
+    transform: $["x-ms-parameter-location"] = "client";
+
+  # Update operationIds to combine all operations into a single client
+  - rename-operation:
+      from: getCompletions
+      to: OpenAI_GetCompletions
+  - rename-operation:
+      from: getEmbeddings
+      to: OpenAI_GetEmbeddings
+  - rename-operation:
+      from: getChatCompletions
+      to: OpenAI_GetChatCompletions
+
+  # Mark request bodies as required (TypeSpec issue #1838)
+  - from: openapi-document
+    where: $.paths["/deployments/{deploymentId}/completions"].post.requestBody
+    transform: $["required"] = true;
+  - from: openapi-document
+    where: $.paths["/deployments/{deploymentId}/embeddings"].post.requestBody
+    transform: $["required"] = true;
+
+  # Remove stream property from CompletionsOptions and ChatCompletionsOptions
+  - from: openapi-document
+    where: $.components.schemas["CompletionsOptions"]
+    transform: delete $.properties.stream;
+  - from: openapi-document
+    where: $.components.schemas["ChatCompletionsOptions"]
+    transform: delete $.properties.stream; 
+
+  # Replace anyOf schemas with an empty schema (no type) to get an "any" type generated
+  - from: openapi-document
+    where: '$.components.schemas["EmbeddingsOptions"].properties["input"]'
+    transform: delete $.anyOf;
+
+  # Fix autorest bug
+  - from: openapi-document
+    where: $.components.schemas["ChatMessage"].properties.role
+    transform: >
+      delete $.allOf;
+      $["$ref"] = "#/components/schemas/ChatRole";
+
+  # Fix another autorest bug
+  - from: openapi-document
+    where: $.components.schemas["Choice"].properties.finish_reason
+    transform: >
+      delete $.oneOf;
+      $["$ref"] = "#/components/schemas/CompletionsFinishReason";
+  - from: openapi-document
+    where: $.components.schemas["ChatChoice"].properties.finish_reason
+    transform: >
+      delete $.oneOf;
+      $["$ref"] = "#/components/schemas/CompletionsFinishReason";
+
+  # Fix "AutoGenerated" models
+  - from: openapi-document
+    where: $.components.schemas["ChatCompletions"].properties.usage
+    transform: >
+      delete $.allOf;
+      $["$ref"] = "#/components/schemas/CompletionsUsage";
+  - from: openapi-document
+    where: $.components.schemas["Completions"].properties.usage
+    transform: >
+      delete $.allOf;
+      $["$ref"] = "#/components/schemas/CompletionsUsage";
+
+  #
+  # strip out the deploymentID validation code - we absorbed this into the endpoint.
+  #
+	# urlPath := "/deployments/{deploymentId}/embeddings"
+	# if client.deploymentID == "" {
+	# 	return nil, errors.New("parameter client.deploymentID cannot be empty")
+	# }
+	# urlPath = strings.ReplaceAll(urlPath, "{deploymentId}", url.PathEscape(client.deploymentID))
+  - from: client.go
+    where: $
+    transform: >-
+      return $.replace(
+        /(\s+)urlPath\s*:=\s*"\/deployments\/\{deploymentId\}\/([^"]+)".+?url\.PathEscape.+?\n/gs, 
+        "$1urlPath := \"$2\"\n")
+
+  # splice out the auto-generated `deploymentID` field from the client
+  - from: client.go
+    where: $
+    transform: >-
+      return $.replace(
+        /(type Client struct.+?)deploymentID string([^}]+})/s, 
+        "$1$2")
+
+  # delete unused error models
+  - from: models.go
+    where: $
+    transform: >-
+      return $.replace(
+        /\/\/ AzureCoreFoundations.*?type AzureCoreFoundations(Error|ErrorResponse|ErrorResponseError|InnerError|InnerErrorInnererror|ErrorInnererror) struct \{[^}]+\}/gs, 
+        "")
+  - from: models_serde.go
+    where: $
+    transform: >-
+      return $.replace(
+        /\/\/ (UnmarshalJSON|MarshalJSON) implements.*?AzureCoreFoundations.*?func.+?\n}/gs, 
+        "")
+  - from: models_serde.go
+    where: $
+    transform: return $.replace(/(?:\/\/.*\s)?func \(\w \*?(?:ErrorResponse|ErrorResponseError|InnerError|InnerErrorInnererror)\).*\{\s(?:.+\s)+\}\s/g, "");
+
+  - from: constants.go
+    where: $
+    transform: >-
+      return $.replace(
+        /type ServiceAPIVersions string.+PossibleServiceAPIVersionsValues.+?\n}/gs, 
+        "")
+
+  # delete client name prefix from method options and response types
+  - from:
+      - client.go
+      - models.go
+      - response_types.go
+    where: $
+    transform: return $.replace(/Client(\w+)((?:Options|Response))/g, "$1$2");
+```

sdk/cognitiveservices/azopenai/build.go

@@ -0,0 +1,11 @@
+//go:build go1.18
+// +build go1.18
+
+//go:generate autorest ./autorest.md
+//go:generate go mod tidy
+//go:generate goimports -w .
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package azopenai

sdk/cognitiveservices/azopenai/ci.yml

@@ -0,0 +1,28 @@
+# NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file.
+trigger:
+  branches:
+    include:
+      - main
+      - feature/*
+      - hotfix/*
+      - release/*
+  paths:
+    include:
+      - sdk/cognitiveservices/azopenai
+      - eng/
+
+pr:
+  branches:
+    include:
+      - main
+      - feature/*
+      - hotfix/*
+      - release/*
+  paths:
+    include:
+      - sdk/cognitiveservices/azopenai
+
+stages:
+  - template: /eng/pipelines/templates/jobs/archetype-sdk-client.yml
+    parameters:
+      ServiceDirectory: "cognitiveservices/azopenai"