diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/README.md b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/README.md new file mode 100644 index 0000000..c9db97d --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/README.md @@ -0,0 +1,132 @@ +# Get required info with Azure OpenAI - custom connector + +## Summary + +This custom connector enables to create and send a POST request to the Azure OpenAI service to get required information. The output received from the Azure OpenAI service stored in JSON schema and can be used in different flows and apps. + +![General information of the custom connector](./assets/CustomConnector_GeneralInformation.png) +![Definition configuration of the custom connector](./assets/CustomConnector_Definition.png) + +## Applies to + +* [Microsoft Power Automate](https://docs.microsoft.com/power-automate/) +* [Azure OpenAI](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/) + +## Compatibility + +> Don't worry about this section, we'll take care of it. Unless you really want to... + +![Premium License](https://img.shields.io/badge/Premium%20License-Not%20Required-green.svg "Premium license not required") +![On-Premises Connectors](https://img.shields.io/badge/On--Premises%20Connectors-No-green.svg "Does not use on-premise connectors") +![Custom Connectors](https://img.shields.io/badge/Custom%20Connectors-Not%20Required-green.svg "Does not use custom connectors") + +## Authors + +Solution|Author(s) +--------|--------- +Get-required-info-with-AzureOpenAI_CustomConnector | [Katerina Chernevskaya](https://github.com/Katerina-Chernevskaya) ([LinkedIn](https://www.linkedin.com/in/katerinachernevskaya/)), Awara IT Academy + +## Version history + +Version|Date|Comments +-------|----|-------- +1.0|April 11, 2023|Initial release + +## Features + +This sample illustrates the following concepts: + +* Using variables to store information about Azure OpenAI service parameters for easy and straightforward parameter management +* Creating POST request to Azure OpenAI service to get information +* API response configuration to use received data in the future actions (flows, apps, etc.) + +## Prerequisites + +* Azure subscription +* Azure OpenAI resource created +* A model deployed using Azure OpenAI +* Saved Azure OpenAI service and model parameters + +Follow below steps to create an Azure OpenAI resource and deploy a model in advance. + +### Create Azure OpenAI resource + +*Currently, access to Azure OpenAI service is granted only by application. You can apply for access to Azure OpenAI by completing the form at [https://aka.ms/oai/access](https://aka.ms/oai/access).* + +1. In the browser open the page to create [Azure OpenAI service](https://portal.azure.com/?microsoft_azure_marketplace_ItemHideKey=microsoft_openai_tip#create/Microsoft.CognitiveServicesOpenAI) and login with your credentials +2. On the `Basics` page provide information described bellow and click `Next` button +* `Subscription`: Select the Azure subscription used in your OpenAI onboarding application +* `Resource group`: The Azure resource group that will contain your OpenAI resource. You can create a new group or add it to a pre-existing group. +* `Region`: The location of your instance. Different locations may introduce latency, but have no impact on the runtime availability of your resource. +* `Name`: A descriptive name for your cognitive services resource. For example, MyOpenAIResource. +* `Pricing Tier`: Only 1 pricing tier is available for the service currently +![Create Azure OpenAI service](./assets/AzureOpenAI_Basics.png) +3. On the `Tags` screen click the `Next` button +4. On the `Review + submit` screen click the `Create` button + +### Deploy a model +1. Open the Azure OpenAI resource created in the previous step +2. Go to the `Model deployments` tab and click the `Create` button +3. Provide information about the model you would like to create (for this custom connector select the `text-davinci-003` model) and click the `Save` button + +### Save parameters +To launch this custom connector you will need following information: host, base URL and API key. Save this information for later. +1. Go to the `Overview` tab of your Azure OpenAI service and copy `Endpoint` value +![Copy Endpoint value](./assets/AzureOpenAI_HostSave.png) +2. Go to the `Keys and Endpoint` tab and copy `KEY 1` value +![Copy api-key value](./assets/AzureOpenAI_ApiKeySave.png) +3. Go to the `Model deployments` tab, select your model and click on the `Go to Azure OpenAI Studio` button +![Go to Azure OpenAI Studio](./assets/AzureOpenAI_OpenStudio.png) +In the opened window click the `Completions playground` button +![Completions playground](./assets/AzureOpenAI_Playground.png) +In the Playground click the `View code` button +![View Code](./assets/AzureOpenAI_ViewCode.png) +In the pop-up window switch to the `json` format and copy Base URL (marked in yellow on the screenshot below) +![Save Base URL](./assets/AzureOpenAI_BaseUrlSave.png) + +## Minimal Path to Awesome + +* Download the `.zip` from the `solution` folder +* Go to [Power Automate Studio](https://make.powerautomate.com/), go to `Solutions` and click `Import solution` +![Import solution - step 1](./assets/Import_Step1.png) +* Select the solution by clicking `Brows` button and press the `Next` button +* Review all fields on the next screen and click `Next` button +![Import solution - step 2](./assets/Import_Step2.png) +* On the next screen provide information that you stored as prerequsines: +For the `BaseURL` field use the value that you copied from the Playground. +For the `Host` field use the value that you copied from the `Endpoint` field. +Once you are ready - click `Import` button. +![Import solution - step 3](./assets/Import_Step3.png) + +*After the solution will be imported successfully - you will see the notification and the solution will be available in the list.* +![Import solution - done](./assets/Import_Done.png) + +* Open the solution `AzureOpenAI_CustomConnector` and update Environmental Variables value. +![Update Environment Variable](./assets/UpdateVariable.png) + +*Once all steps will be completed you can use this custom connector to create connections and leverage its capabilities in your solutions.* + +## Disclaimer + +**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** + +## Help + +> Note: don't worry about this section, we'll update the links. + +We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues. + +If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/powerautomate-samples/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=YOURSAMPLENAME&authors=@YOURGITHUBUSERNAME&title=YOURSAMPLENAME%20-%20). + +For questions regarding this sample, [create a new question](https://github.com/pnp/powerautomate-samples/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=YOURSAMPLENAME&authors=@YOURGITHUBUSERNAME&title=YOURSAMPLENAME%20-%20). + +Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/powerautomate-samples/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=YOURSAMPLENAME&authors=@YOURGITHUBUSERNAME&title=YOURSAMPLENAME%20-%20). + +## For more information + +- [Create your first flow](https://docs.microsoft.com/en-us/power-automate/getting-started#create-your-first-flow) +- [Microsoft Power Automate documentation](https://docs.microsoft.com/en-us/power-automate/) + + + + diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_ApiKeySave.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_ApiKeySave.png new file mode 100644 index 0000000..79794ee Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_ApiKeySave.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_BaseUrlSave.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_BaseUrlSave.png new file mode 100644 index 0000000..ab17298 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_BaseUrlSave.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_Basics.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_Basics.png new file mode 100644 index 0000000..cbc1c9d Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_Basics.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_HostSave.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_HostSave.png new file mode 100644 index 0000000..431000b Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_HostSave.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_OpenStudio.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_OpenStudio.png new file mode 100644 index 0000000..7981426 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_OpenStudio.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_Playground.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_Playground.png new file mode 100644 index 0000000..dd2146f Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_Playground.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_ViewCode.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_ViewCode.png new file mode 100644 index 0000000..7a3a286 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/AzureOpenAI_ViewCode.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/CustomConnector_Definition.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/CustomConnector_Definition.png new file mode 100644 index 0000000..cfa4c7a Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/CustomConnector_Definition.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/CustomConnector_GeneralInformation.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/CustomConnector_GeneralInformation.png new file mode 100644 index 0000000..d4ca258 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/CustomConnector_GeneralInformation.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Done.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Done.png new file mode 100644 index 0000000..3496d0b Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Done.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step1.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step1.png new file mode 100644 index 0000000..9da1c3e Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step1.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step2.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step2.png new file mode 100644 index 0000000..5ef203e Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step2.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step3.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step3.png new file mode 100644 index 0000000..cdac718 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/Import_Step3.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/UpdateVariable.png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/UpdateVariable.png new file mode 100644 index 0000000..1a2b406 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/assets/UpdateVariable.png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_connectionparameters.json b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_connectionparameters.json new file mode 100644 index 0000000..ce871a8 --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_connectionparameters.json @@ -0,0 +1 @@ +{"api_key":{"type":"securestring","uiDefinition":{"displayName":"API key","description":"The API key for this api","tooltip":"Provide your API key","constraints":{"tabIndex":2,"clearText":false,"required":"true"}}}} \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_iconblob.Png b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_iconblob.Png new file mode 100644 index 0000000..f417fb8 Binary files /dev/null and b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_iconblob.Png differ diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_openapidefinition.json b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_openapidefinition.json new file mode 100644 index 0000000..27e2ba3 --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_openapidefinition.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"title":"Default title","description":"","version":"1.0"},"host":"@environmentVariables(\"kch_Host\")","basePath":"/@environmentVariables(\"kch_BaseURL\")","schemes":["https"],"consumes":[],"produces":[],"paths":{"/":{"post":{"responses":{"default":{"description":"default","schema":{"type":"object","properties":{"id":{"type":"string","description":"id"},"object":{"type":"string","description":"object"},"created":{"type":"integer","format":"int32","description":"created"},"model":{"type":"string","description":"model"},"choices":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","description":"text"},"index":{"type":"integer","format":"int32","description":"index"},"finish_reason":{"type":"string","description":"finish_reason"},"logprobs":{"type":"string","description":"logprobs"}}},"description":"choices"},"usage":{"type":"object","properties":{"completion_tokens":{"type":"integer","format":"int32","description":"completion_tokens"},"prompt_tokens":{"type":"integer","format":"int32","description":"prompt_tokens"},"total_tokens":{"type":"integer","format":"int32","description":"total_tokens"}},"description":"usage"}}}}},"summary":"POST request parameters","operationId":"GeneralParameters","parameters":[{"name":"api-version","in":"query","required":false,"type":"string"},{"name":"Content-Type","in":"header","required":false,"type":"string"},{"name":"api-key","in":"header","required":false,"type":"string"},{"name":"body","in":"body","required":false,"schema":{"type":"object","properties":{"prompt":{"type":"string","description":"prompt"},"max_tokens":{"type":"integer","format":"int32","description":"max_tokens"},"temperature":{"type":"integer","format":"int32","description":"temperature"},"frequency_penalty":{"type":"integer","format":"int32","description":"frequency_penalty"},"presence_penalty":{"type":"integer","format":"int32","description":"presence_penalty"},"top_p":{"type":"number","format":"float","description":"top_p"},"best_of":{"type":"integer","format":"int32","description":"best_of"},"stop":{"type":"string","description":"stop"}}}}]}}},"definitions":{},"parameters":{},"responses":{},"securityDefinitions":{"api_key":{"type":"apiKey","in":"header","name":"api-key"}},"security":[],"tags":[]} \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_policytemplateinstances.json b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_policytemplateinstances.json new file mode 100644 index 0000000..0637a08 --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/Connector/kch_5Fazure-20open-20ai-20for-20crm_policytemplateinstances.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/[Content_Types].xml b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/[Content_Types].xml new file mode 100644 index 0000000..34acefc --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/[Content_Types].xml @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/customizations.xml b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/customizations.xml new file mode 100644 index 0000000..15ff03a --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/customizations.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + a5b380c8-5874-4bf2-8f78-c579bd454f1e + + Azure Open AI for CRM + #007ee5 + kch_5Fazure-20open-20ai-20for-20crm + 1 + /Connector/kch_5Fazure-20open-20ai-20for-20crm_openapidefinition.json + /Connector/kch_5Fazure-20open-20ai-20for-20crm_connectionparameters.json + /Connector/kch_5Fazure-20open-20ai-20for-20crm_policytemplateinstances.json + /Connector/kch_5Fazure-20open-20ai-20for-20crm_iconblob.Png + + + + 1033 + + \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/environmentvariabledefinitions/kch_BaseURL/environmentvariabledefinition.xml b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/environmentvariabledefinitions/kch_BaseURL/environmentvariabledefinition.xml new file mode 100644 index 0000000..2ccd7d6 --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/environmentvariabledefinitions/kch_BaseURL/environmentvariabledefinition.xml @@ -0,0 +1,13 @@ + + + + + + 1.0.0.0 + 1 + 0 + 0 + 100000000 + \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/environmentvariabledefinitions/kch_Host/environmentvariabledefinition.xml b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/environmentvariabledefinitions/kch_Host/environmentvariabledefinition.xml new file mode 100644 index 0000000..1bab2a8 --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/environmentvariabledefinitions/kch_Host/environmentvariabledefinition.xml @@ -0,0 +1,13 @@ + + + + + + 1.0.0.0 + 1 + 0 + 0 + 100000000 + \ No newline at end of file diff --git a/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/solution.xml b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/solution.xml new file mode 100644 index 0000000..7ca1103 --- /dev/null +++ b/samples/Get-required-info-with-AzureOpenAI_CustomConnector/sourcecode/solution.xml @@ -0,0 +1,86 @@ + + + AzureOpenAI_CustomConnector + + + + + 1.0.0.1 + 0 + + KaterinaChernevskaya + + + + + + + katerina.chernevskaya@awara-it.com + https://www.linkedin.com/in/katerinachernevskaya/ + kch + 84224 + +
+ 1 + 1 + + + Bulgaria + + + + + + + + + + + + + 1 + + + + + + + + +
+
+ 2 + 1 + + + + + + + + + + + + + + + + 1 + + + + + + + + +
+ + + + + + + + \ No newline at end of file