azure_openai_client 0.0.1 → 0.0.2

data/docs/CompletionsCreateRequest.md

@@ -0,0 +1,52 @@
+# AzureOpenaiClient::CompletionsCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt** | [**CompletionsCreateRequestPrompt**](CompletionsCreateRequestPrompt.md) |  | [optional] |
+| **max_tokens** | **Integer** | The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). Has minimum of 0. | [optional][default to 16] |
+| **temperature** | **Float** | What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. We generally recommend altering this or top_p but not both. | [optional][default to 1] |
+| **top_p** | **Float** | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. | [optional][default to 1] |
+| **logit_bias** | **Object** | Defaults to null. Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass {\"50256\" : -100} to prevent the <|endoftext|> token from being generated. | [optional] |
+| **user** | **String** | A unique identifier representing your end-user, which can help monitoring and detecting abuse | [optional] |
+| **n** | **Integer** | How many completions to generate for each prompt. Minimum of 1 and maximum of 128 allowed. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. | [optional][default to 1] |
+| **stream** | **Boolean** | Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. | [optional][default to false] |
+| **logprobs** | **Integer** | Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response. Minimum of 0 and maximum of 5 allowed. | [optional] |
+| **model** | **String** | ID of the model to use. You can use the Models_List operation to see all of your available models, or see our Models_Get overview for descriptions of them. | [optional] |
+| **suffix** | **String** | The suffix that comes after a completion of inserted text. | [optional] |
+| **echo** | **Boolean** | Echo back the prompt in addition to the completion | [optional][default to false] |
+| **stop** | [**CompletionsCreateRequestStop**](CompletionsCreateRequestStop.md) |  | [optional] |
+| **completion_config** | **String** |  | [optional] |
+| **cache_level** | **Integer** | can be used to disable any server-side caching, 0=no cache, 1=prompt prefix enabled, 2=full cache | [optional] |
+| **presence_penalty** | **Float** | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. | [optional][default to 0] |
+| **frequency_penalty** | **Float** | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | [optional][default to 0] |
+| **best_of** | **Integer** | Generates best_of completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed. When used with n, best_of controls the number of candidate completions and n specifies how many to return – best_of must be greater than n. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. Has maximum value of 128. | [optional] |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::CompletionsCreateRequest.new(
+  prompt: null,
+  max_tokens: 16,
+  temperature: 1,
+  top_p: 1,
+  logit_bias: null,
+  user: null,
+  n: 1,
+  stream: null,
+  logprobs: null,
+  model: davinci,
+  suffix: null,
+  echo: null,
+  stop: null,
+  completion_config: null,
+  cache_level: null,
+  presence_penalty: null,
+  frequency_penalty: null,
+  best_of: null
+)
+```
+

data/docs/CompletionsCreateRequestPrompt.md

@@ -0,0 +1,49 @@
+# AzureOpenaiClient::CompletionsCreateRequestPrompt
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'azure_openai_client'
+
+AzureOpenaiClient::CompletionsCreateRequestPrompt.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'azure_openai_client'
+
+AzureOpenaiClient::CompletionsCreateRequestPrompt.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+AzureOpenaiClient::CompletionsCreateRequestPrompt.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `String`
+- `nil` (if no type matches)
+

data/docs/CompletionsCreateRequestStop.md

@@ -0,0 +1,49 @@
+# AzureOpenaiClient::CompletionsCreateRequestStop
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'azure_openai_client'
+
+AzureOpenaiClient::CompletionsCreateRequestStop.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'azure_openai_client'
+
+AzureOpenaiClient::CompletionsCreateRequestStop.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+AzureOpenaiClient::CompletionsCreateRequestStop.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `String`
+- `nil` (if no type matches)
+

data/docs/DefaultApi.md

@@ -0,0 +1,238 @@
+# AzureOpenaiClient::DefaultApi
+
+All URIs are relative to *https://your-resource-name.openai.azure.com/openai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**chat_completions_create**](DefaultApi.md#chat_completions_create) | **POST** /deployments/{deployment-id}/chat/completions | Creates a completion for the chat message |
+| [**completions_create**](DefaultApi.md#completions_create) | **POST** /deployments/{deployment-id}/completions | Creates a completion for the provided prompt, parameters and chosen model. |
+| [**embeddings_create**](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. |
+
+
+## chat_completions_create
+
+> <ChatCompletionsCreate200Response> chat_completions_create(deployment_id, api_version, chat_completions_create_request)
+
+Creates a completion for the chat message
+
+### Examples
+
+```ruby
+require 'time'
+require 'azure_openai_client'
+# setup authorization
+AzureOpenaiClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['apiKey'] = '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['apiKey'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: bearer
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AzureOpenaiClient::DefaultApi.new
+deployment_id = 'deployment_id_example' # String | 
+api_version = '2023-05-15' # String | 
+chat_completions_create_request = AzureOpenaiClient::ChatCompletionsCreateRequest.new({messages: [AzureOpenaiClient::ChatCompletionsCreateRequestMessagesInner.new({role: 'system', content: 'content_example'})]}) # ChatCompletionsCreateRequest | 
+
+begin
+  # Creates a completion for the chat message
+  result = api_instance.chat_completions_create(deployment_id, api_version, chat_completions_create_request)
+  p result
+rescue AzureOpenaiClient::ApiError => e
+  puts "Error when calling DefaultApi->chat_completions_create: #{e}"
+end
+```
+
+#### Using the chat_completions_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChatCompletionsCreate200Response>, Integer, Hash)> chat_completions_create_with_http_info(deployment_id, api_version, chat_completions_create_request)
+
+```ruby
+begin
+  # Creates a completion for the chat message
+  data, status_code, headers = api_instance.chat_completions_create_with_http_info(deployment_id, api_version, chat_completions_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChatCompletionsCreate200Response>
+rescue AzureOpenaiClient::ApiError => e
+  puts "Error when calling DefaultApi->chat_completions_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deployment_id** | **String** |  |  |
+| **api_version** | **String** |  |  |
+| **chat_completions_create_request** | [**ChatCompletionsCreateRequest**](ChatCompletionsCreateRequest.md) |  |  |
+
+### Return type
+
+[**ChatCompletionsCreate200Response**](ChatCompletionsCreate200Response.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## completions_create
+
+> <CompletionsCreate200Response> completions_create(deployment_id, api_version, completions_create_request)
+
+Creates a completion for the provided prompt, parameters and chosen model.
+
+### Examples
+
+```ruby
+require 'time'
+require 'azure_openai_client'
+# setup authorization
+AzureOpenaiClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['apiKey'] = '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['apiKey'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: bearer
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AzureOpenaiClient::DefaultApi.new
+deployment_id = 'davinci' # String | 
+api_version = '2023-05-15' # String | 
+completions_create_request = AzureOpenaiClient::CompletionsCreateRequest.new # CompletionsCreateRequest | 
+
+begin
+  # Creates a completion for the provided prompt, parameters and chosen model.
+  result = api_instance.completions_create(deployment_id, api_version, completions_create_request)
+  p result
+rescue AzureOpenaiClient::ApiError => e
+  puts "Error when calling DefaultApi->completions_create: #{e}"
+end
+```
+
+#### Using the completions_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompletionsCreate200Response>, Integer, Hash)> completions_create_with_http_info(deployment_id, api_version, completions_create_request)
+
+```ruby
+begin
+  # Creates a completion for the provided prompt, parameters and chosen model.
+  data, status_code, headers = api_instance.completions_create_with_http_info(deployment_id, api_version, completions_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompletionsCreate200Response>
+rescue AzureOpenaiClient::ApiError => e
+  puts "Error when calling DefaultApi->completions_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deployment_id** | **String** |  |  |
+| **api_version** | **String** |  |  |
+| **completions_create_request** | [**CompletionsCreateRequest**](CompletionsCreateRequest.md) |  |  |
+
+### Return type
+
+[**CompletionsCreate200Response**](CompletionsCreate200Response.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## embeddings_create
+
+> <EmbeddingsCreate200Response> embeddings_create(deployment_id, api_version, request_body)
+
+Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+
+### Examples
+
+```ruby
+require 'time'
+require 'azure_openai_client'
+# setup authorization
+AzureOpenaiClient.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['apiKey'] = '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['apiKey'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: bearer
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AzureOpenaiClient::DefaultApi.new
+deployment_id = 'ada-search-index-v1' # String | The deployment id of the model which was deployed.
+api_version = '2023-05-15' # String | 
+request_body = { key: 3.56} # Hash<String, Object> | 
+
+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(deployment_id, api_version, request_body)
+  p result
+rescue AzureOpenaiClient::ApiError => e
+  puts "Error when calling DefaultApi->embeddings_create: #{e}"
+end
+```
+
+#### Using the embeddings_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmbeddingsCreate200Response>, Integer, Hash)> embeddings_create_with_http_info(deployment_id, api_version, request_body)
+
+```ruby
+begin
+  # Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+  data, status_code, headers = api_instance.embeddings_create_with_http_info(deployment_id, api_version, request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmbeddingsCreate200Response>
+rescue AzureOpenaiClient::ApiError => e
+  puts "Error when calling DefaultApi->embeddings_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deployment_id** | **String** | The deployment id of the model which was deployed. |  |
+| **api_version** | **String** |  |  |
+| **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) |  |  |
+
+### Return type
+
+[**EmbeddingsCreate200Response**](EmbeddingsCreate200Response.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmbeddingsCreate200Response.md

@@ -0,0 +1,24 @@
+# AzureOpenaiClient::EmbeddingsCreate200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **model** | **String** |  |  |
+| **data** | [**Array<EmbeddingsCreate200ResponseDataInner>**](EmbeddingsCreate200ResponseDataInner.md) |  |  |
+| **usage** | [**EmbeddingsCreate200ResponseUsage**](EmbeddingsCreate200ResponseUsage.md) |  |  |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::EmbeddingsCreate200Response.new(
+  object: null,
+  model: null,
+  data: null,
+  usage: null
+)
+```
+

data/docs/EmbeddingsCreate200ResponseDataInner.md

@@ -0,0 +1,22 @@
+# AzureOpenaiClient::EmbeddingsCreate200ResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** |  |  |
+| **object** | **String** |  |  |
+| **embedding** | **Array<Float>** |  |  |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::EmbeddingsCreate200ResponseDataInner.new(
+  index: null,
+  object: null,
+  embedding: null
+)
+```
+

data/docs/EmbeddingsCreate200ResponseUsage.md

@@ -0,0 +1,20 @@
+# AzureOpenaiClient::EmbeddingsCreate200ResponseUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt_tokens** | **Integer** |  |  |
+| **total_tokens** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::EmbeddingsCreate200ResponseUsage.new(
+  prompt_tokens: null,
+  total_tokens: null
+)
+```
+

data/docs/EmbeddingsCreateRequest.md

@@ -0,0 +1,24 @@
+# AzureOpenaiClient::EmbeddingsCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | [**EmbeddingsCreateRequestInput**](EmbeddingsCreateRequestInput.md) |  |  |
+| **user** | **String** | A unique identifier representing your end-user, which can help monitoring and detecting abuse. | [optional] |
+| **input_type** | **String** | input type of embedding search to use | [optional] |
+| **model** | **String** | ID of the model to use. You can use the Models_List operation to see all of your available models, or see our Models_Get overview for descriptions of them. | [optional] |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::EmbeddingsCreateRequest.new(
+  input: null,
+  user: null,
+  input_type: query,
+  model: null
+)
+```
+

data/docs/EmbeddingsCreateRequestInput.md

@@ -0,0 +1,49 @@
+# AzureOpenaiClient::EmbeddingsCreateRequestInput
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'azure_openai_client'
+
+AzureOpenaiClient::EmbeddingsCreateRequestInput.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'azure_openai_client'
+
+AzureOpenaiClient::EmbeddingsCreateRequestInput.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+AzureOpenaiClient::EmbeddingsCreateRequestInput.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `String`
+- `nil` (if no type matches)
+

data/docs/ErrorResponse.md

@@ -0,0 +1,18 @@
+# AzureOpenaiClient::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorResponseError**](ErrorResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::ErrorResponse.new(
+  error: null
+)
+```
+

data/docs/ErrorResponseError.md

@@ -0,0 +1,24 @@
+# AzureOpenaiClient::ErrorResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **param** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'azure_openai_client'
+
+instance = AzureOpenaiClient::ErrorResponseError.new(
+  code: null,
+  message: null,
+  param: null,
+  type: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="etsenake"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="azure-openai-client"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Moving to openapi generator"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'