azure_openai_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a16f8557725c03a595a0917831440f10db8b079067bff26f101db47ce55bfcf
+  data.tar.gz: d69ef18fd78150c8806034e6441028a4ac07a7c6ac0a01df023a1770673dd20f
+SHA512:
+  metadata.gz: ce73995a7ce5ac1488d3e41e9432cc55b2b2c6ab80008dbcaa3a0060ea3fb2e3ee263a93bcb1335fb2a428d64a8adeaad93b1764a4c2a1a38d596442e4417106
+  data.tar.gz: f56d3bf7714e0db8467f88788ed27df098461e98a509ad9c389dd30783d8abaa84d46276de5e8e02d2df51d4f385dbbffa9b5e0f54ed792cf3503d7a20d5aa81

data/README.md

@@ -0,0 +1,178 @@
+# azure_openai_client
+
+AzureOpenaiClient - the Ruby gem for the Azure OpenAI Service API
+
+Azure OpenAI APIs for completions and search
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 2023-05-15
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build azure_openai_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./azure_openai_client-1.0.0.gem
+```
+(for development, run `gem install --dev ./azure_openai_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'azure_openai_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'azure_openai_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'azure_openai_client'
+# Setup authorization
+AzureOpenaiClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: bearer
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AzureOpenaiClient::DefaultApi.new
+body = AzureOpenaiClient::ChatCompletionsBody.new # ChatCompletionsBody | 
+deployment_id = 'deployment_id_example' # String | 
+api_version = 'api_version_example' # String | 
+
+
+begin
+  #Creates a completion for the chat message
+  result = api_instance.chat_completions_create(body, deployment_id, api_version)
+  p result
+rescue AzureOpenaiClient::ApiError => e
+  puts "Exception when calling DefaultApi->chat_completions_create: #{e}"
+end
+# Setup authorization
+AzureOpenaiClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: bearer
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AzureOpenaiClient::DefaultApi.new
+body = AzureOpenaiClient::DeploymentidCompletionsBody.new # DeploymentidCompletionsBody | 
+deployment_id = 'deployment_id_example' # String | 
+api_version = 'api_version_example' # String | 
+
+
+begin
+  #Creates a completion for the provided prompt, parameters and chosen model.
+  result = api_instance.completions_create(body, deployment_id, api_version)
+  p result
+rescue AzureOpenaiClient::ApiError => e
+  puts "Exception when calling DefaultApi->completions_create: #{e}"
+end
+# Setup authorization
+AzureOpenaiClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: bearer
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AzureOpenaiClient::DefaultApi.new
+body = nil # Hash | 
+deployment_id = 'deployment_id_example' # String | The deployment id of the model which was deployed.
+api_version = 'api_version_example' # String | 
+
+
+begin
+  #Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+  result = api_instance.embeddings_create(body, deployment_id, api_version)
+  p result
+rescue AzureOpenaiClient::ApiError => e
+  puts "Exception when calling DefaultApi->embeddings_create: #{e}"
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://{endpoint}/openai*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AzureOpenaiClient::DefaultApi* | [**chat_completions_create**](docs/DefaultApi.md#chat_completions_create) | **POST** /deployments/{deployment-id}/chat/completions | Creates a completion for the chat message
+*AzureOpenaiClient::DefaultApi* | [**completions_create**](docs/DefaultApi.md#completions_create) | **POST** /deployments/{deployment-id}/completions | Creates a completion for the provided prompt, parameters and chosen model.
+*AzureOpenaiClient::DefaultApi* | [**embeddings_create**](docs/DefaultApi.md#embeddings_create) | **POST** /deployments/{deployment-id}/embeddings | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+
+## Documentation for Models
+
+ - [AzureOpenaiClient::ChatCompletionsBody](docs/ChatCompletionsBody.md)
+ - [AzureOpenaiClient::DeploymentidCompletionsBody](docs/DeploymentidCompletionsBody.md)
+ - [AzureOpenaiClient::DeploymentidEmbeddingsBody](docs/DeploymentidEmbeddingsBody.md)
+ - [AzureOpenaiClient::DeploymentsdeploymentidchatcompletionsMessages](docs/DeploymentsdeploymentidchatcompletionsMessages.md)
+ - [AzureOpenaiClient::ErrorResponse](docs/ErrorResponse.md)
+ - [AzureOpenaiClient::ErrorResponseError](docs/ErrorResponseError.md)
+ - [AzureOpenaiClient::InlineResponse200](docs/InlineResponse200.md)
+ - [AzureOpenaiClient::InlineResponse2001](docs/InlineResponse2001.md)
+ - [AzureOpenaiClient::InlineResponse2001Data](docs/InlineResponse2001Data.md)
+ - [AzureOpenaiClient::InlineResponse2001Usage](docs/InlineResponse2001Usage.md)
+ - [AzureOpenaiClient::InlineResponse2002](docs/InlineResponse2002.md)
+ - [AzureOpenaiClient::InlineResponse2002Choices](docs/InlineResponse2002Choices.md)
+ - [AzureOpenaiClient::InlineResponse2002Message](docs/InlineResponse2002Message.md)
+ - [AzureOpenaiClient::InlineResponse2002Usage](docs/InlineResponse2002Usage.md)
+ - [AzureOpenaiClient::InlineResponse200Choices](docs/InlineResponse200Choices.md)
+ - [AzureOpenaiClient::InlineResponse200Logprobs](docs/InlineResponse200Logprobs.md)
+ - [AzureOpenaiClient::InlineResponse200Usage](docs/InlineResponse200Usage.md)
+ - [AzureOpenaiClient::OneOfchatCompletionsBodyStop](docs/OneOfchatCompletionsBodyStop.md)
+ - [AzureOpenaiClient::OneOfdeploymentidCompletionsBodyPrompt](docs/OneOfdeploymentidCompletionsBodyPrompt.md)
+ - [AzureOpenaiClient::OneOfdeploymentidCompletionsBodyStop](docs/OneOfdeploymentidCompletionsBodyStop.md)
+
+## Documentation for Authorization
+
+
+### apiKey
+
+- **Type**: API key
+- **API key parameter name**: api-key
+- **Location**: HTTP header
+
+### bearer
+
+- **Type**: OAuth
+- **Flow**: implicit
+- **Authorization URL**: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
+- **Scopes**: 
+

data/lib/azure_openai_client/api/default_api.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+=begin
+#Azure OpenAI Service API
+
+#Azure OpenAI APIs for completions and search
+
+OpenAPI spec version: 2023-05-15
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.42
+=end
+
+module AzureOpenaiClient
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Creates a completion for the chat message
+    # @param body
+    # @param api_version
+    # @param deployment_id
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse2002]
+    def chat_completions_create(body, api_version, deployment_id, opts = {})
+      data, _status_code, _headers = chat_completions_create_with_http_info(body, api_version, deployment_id, opts)
+      data
+    end
+
+    # Creates a completion for the chat message
+    # @param body
+    # @param api_version
+    # @param deployment_id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse2002, Integer, Hash)>] InlineResponse2002 data, response status code and response headers
+    def chat_completions_create_with_http_info(body, api_version, deployment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.chat_completions_create ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling DefaultApi.chat_completions_create"
+      end
+      # verify the required parameter 'api_version' is set
+      if @api_client.config.client_side_validation && api_version.nil?
+        fail ArgumentError, "Missing the required parameter 'api_version' when calling DefaultApi.chat_completions_create"
+      end
+      # verify the required parameter 'deployment_id' is set
+      if @api_client.config.client_side_validation && deployment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DefaultApi.chat_completions_create"
+      end
+      # resource path
+      local_var_path = '/deployments/{deployment-id}/chat/completions'.sub('{' + 'deployment-id' + '}', deployment_id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'api-version'] = api_version
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body)
+
+      return_type = opts[:return_type] || 'InlineResponse2002'
+
+      auth_names = opts[:auth_names] || ['apiKey', 'bearer']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#chat_completions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Creates a completion for the provided prompt, parameters and chosen model.
+    # @param body
+    # @param api_version
+    # @param deployment_id
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse200]
+    def completions_create(body, api_version, deployment_id, opts = {})
+      data, _status_code, _headers = completions_create_with_http_info(body, api_version, deployment_id, opts)
+      data
+    end
+
+    # Creates a completion for the provided prompt, parameters and chosen model.
+    # @param body
+    # @param api_version
+    # @param deployment_id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
+    def completions_create_with_http_info(body, api_version, deployment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.completions_create ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling DefaultApi.completions_create"
+      end
+      # verify the required parameter 'api_version' is set
+      if @api_client.config.client_side_validation && api_version.nil?
+        fail ArgumentError, "Missing the required parameter 'api_version' when calling DefaultApi.completions_create"
+      end
+      # verify the required parameter 'deployment_id' is set
+      if @api_client.config.client_side_validation && deployment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DefaultApi.completions_create"
+      end
+      # resource path
+      local_var_path = '/deployments/{deployment-id}/completions'.sub('{' + 'deployment-id' + '}', deployment_id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'api-version'] = api_version
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body)
+
+      return_type = opts[:return_type] || 'InlineResponse200'
+
+      auth_names = opts[:auth_names] || ['apiKey', 'bearer']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#completions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+    # @param body
+    # @param api_version
+    # @param deployment_id The deployment id of the model which was deployed.
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse2001]
+    def embeddings_create(body, api_version, deployment_id, opts = {})
+      data, _status_code, _headers = embeddings_create_with_http_info(body, api_version, deployment_id, opts)
+      data
+    end
+
+    # Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+    # @param body
+    # @param api_version
+    # @param deployment_id The deployment id of the model which was deployed.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
+    def embeddings_create_with_http_info(body, api_version, deployment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.embeddings_create ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling DefaultApi.embeddings_create"
+      end
+      # verify the required parameter 'api_version' is set
+      if @api_client.config.client_side_validation && api_version.nil?
+        fail ArgumentError, "Missing the required parameter 'api_version' when calling DefaultApi.embeddings_create"
+      end
+      # verify the required parameter 'deployment_id' is set
+      if @api_client.config.client_side_validation && deployment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DefaultApi.embeddings_create"
+      end
+      # resource path
+      local_var_path = '/deployments/{deployment-id}/embeddings'.sub('{' + 'deployment-id' + '}', deployment_id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'api-version'] = api_version
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body)
+
+      return_type = opts[:return_type] || 'InlineResponse2001'
+
+      auth_names = opts[:auth_names] || ['apiKey', 'bearer']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#embeddings_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end