Overview
Azure OpenAI
This CDK catalogue package is pinned to @activepieces/piece-azure-openai@0.2.0 and declares 2 declared actions and no declared triggers. Its definition is derived from the exact reviewed Activepieces source.
Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.
Technical guide
Technical reference
- Package:
@activepieces/piece-azure-openai@0.2.0 - Exact artifact digest:
sha256:da50aa65b7f29f3ca2c9c75f15e6b890060ef6fa7a773f8f9b9f580e0cdfb6bf - Source: the exact reviewed Activepieces source
- Authentication, action and trigger schemas are taken from the exact pinned package.
Capability summary
Authentication
Authentication method: custom
Authentication profiles
connection · custom
- Endpoint Required
- API Key Required · protected credential
Supported objects
| Object | Read | Write | Notes |
|---|---|---|---|
| Ask GPT | Yes | No | |
| Custom API Call | Yes | No |
Supported actions
Ask GPT · Read
Ask ChatGPT anything you want!
ask_gpt · Risk: low · Retry: safe
Inputs
deploymentId· string · Required, The name of your model deployment.prompt· string · Requiredtemperature· number · Optional, Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.maxTokens· number · Required, The maximum number of tokens to generate. Requests can use up to 2,048 or 4,096 tokens shared between prompt and completion depending on the model. Don't set the value to maximum and leave some tokens for the input. (One token is roughly 4 characters for normal English text)topP· number · Optional, 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.frequencyPenalty· number · Optional, 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.presencePenalty· number · Optional, Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the mode's likelihood to talk about new topics.memoryKey· string · Optional, A memory key that will keep the chat history shared across runs and flows. Keep it empty to leave ChatGPT without memory of previous messages.roles· object · Optional, Array of roles to specify more accurate response
Custom API Call · Read
Make a custom API call to a specific endpoint
custom_api_call · Risk: low · Retry: safe
Inputs
url· object · Requiredmethod· string · Requiredheaders· object · Optional, Authorization headers are injected automatically from your connection.queryParams· object · Optional, Appended to the URL as ?key=value.body_type· string · Optionalbody· object · Optionalresponse_is_binary· boolean · Optional, Enable for files like PDFs, images, etc.failsafe· boolean · Optional, On a failed request, output the error instead of failing the step.timeout· number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).followRedirects· boolean · Optional, Follow 3xx redirects instead of returning them as the response.
Setup
Setup
Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.
Limitations
The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.