Microsoft Copilot
Microsoft Copilot is an AI-powered tool that provides intelligent query execution and data analysis to enhance security operations.
Microsoft Copilot is an AI-driven platform that provides real-time, contextual insights and answers by leveraging advanced language models. The Microsoft Copilot connector for Swimlane Turbine allows users to execute queries and receive intelligent responses directly within their security workflows. This integration enhances decision-making and accelerates incident response by providing immediate access to AI-generated information and suggestions, tailored to the specific needs of security professionals.
Limitations
None to date.
Supported Versions
This connector supports the latest version of Microsoft Copilot.
Prerequisites
To effectively utilize the Microsoft Copilot connector within Swimlane Turbine, ensure you have the following:
- API Key Authentication with the necessary parameters:
- URL: Endpoint for the Microsoft Copilot service.
- API Key: A valid key to authenticate and authorize the integration.
Capabilities
This Connector provides the following capabilities:
- Ask Copilot
Ask Copilot
Generates output using the selected Model and the input text.
Microsoft Copilot's documentation for this action can be found here here.
Configurations
API Key Authentication
Authenticates using an API Key
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | Azure OpenAI endpoint URL. | string | Required |
api-key | OpenAI API key | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Ask Copilot
Executes a query with Microsoft Copilot using a specified prompt, deployment ID, and API version to retrieve relevant results.
Endpoint
- URL: /openai/deployments/{{deployment-id}}/chat/completions
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.api-version | string | Required | API version to use for the request. |
path_parameters.deployment-id | string | Required | Deployment ID of the model which was deployed. |
prompt | string | Optional | Prompt to send to the model. |
best_of | number | Optional | Generates best_of completions server-side and returns the "best". |
echo | boolean | Optional | Echo back the prompt in addition to the completion. |
frequency_penalty | number | Optional | 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. |
logit_bias | object | Optional | Modify the likelihood of specified tokens appearing in the completion. |
logprobs | number | Optional | Include the log probabilities on the logprobs most likely output tokens, as well the chosen tokens. |
max_tokens | number | Optional | The maximum number of tokens that can be generated in the completion. |
n | number | Optional | How many completions to generate for each prompt. |
presence_penalty | number | Optional | Positive values penalize new tokens based on whether they appear in the text so far, decreasing the model's likelihood to talk about new topics. |
seed | number | Optional | Random number seed. |
stop | string | Optional | Up to four sequences where the API will stop generating further tokens. |
stream | boolean | Optional | Whether to stream back partial progress. |
suffix | string | Optional | The suffix that comes after a completion of inserted text. |
temperature | number | Optional | What sampling temperature to use, between 0 and 2. |
top_p | number | Optional | What value to use for nucleus sampling. |
user | string | Optional | A unique identifier representing your end-user, which can help to monitor and detect abuse. |
Input Example
{"parameters":{"api-version":"2024-02-15-preview"},"json_body":{"prompt":"What is the capital of France?","best_of":1,"echo":false,"frequency_penalty":0,"logit_bias":{},"logprobs":5,"max_tokens":16,"n":1,"presence_penalty":0,"seed":42,"stop":"","stream":false,"suffix":"","temperature":1,"top_p":1,"user":"user-1234567890"},"path_parameters":{"deployment-id":"gpt-4o-mini"}}
Output
Parameter | Type | Description |
|---|---|---|
message | string | Response message |
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"message":"Paris is the capital and most populous city of France. \nSituated on the Seine Ri...","status_code":200,"headers":null,"reason":"OK"}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |