# Configuration

```json
{
  "id": "io.infomaker.wingman",
  "name": "im-wingman",
  "style": "https://plugins.writer.infomaker.io/v1/infomaker/im-wingman/1.2.0/style.css",
  "url": "https://plugins.writer.infomaker.io/v1/infomaker/im-wingman/1.2.0/index.js",
  "mandatory": false,
  "enabled": true,
  "data": {
    "host": "https://ai-eu-west-1.saas-prod.infomaker.io",
    "contextLimit": 2,
    "encryptedKeyPhrase": "somePhrase",
    "widgets": [
      "generic",
      "headline",
      "summary"
    ],
    "widgetConfig": {
      "headline": {
        "digital": {
          "preText": "Generate a headline",
          "creativity": 5,
          "headlineCount": 10,
          "digitalHeadlineWordCount": 20,
          "checkBoxDefault": false,
          "providerAccessToken": "someToken",
          "serviceProvider": "openai",
          "modelId": "gpt-3.5-turbo"
        },
        "print": {
          "preText": "Suggest headlines for the article provided in XML tag. If the article has a strong local connection, reflect this in the headline.",
          "creativity": 5,
          "headlineCount": 10,
          "printHeadlineWordCount": 8,
          "checkBoxDefault": false,
          "providerAccessToken": "",
          "serviceProvider": "Bedrock",
          "modelId": "anthropic.claude-3-sonnet-20240229-v1:0"
        }
      },
      "summary": {
        "digital": {
          "preText": "Generate a summary",
          "creativity": 5,
          "summaryCount": 5,
          "digitalSummaryWordCount": 40,
          "checkBoxDefault": false,
          "providerAccessToken": "someToken",
          "serviceProvider": "openai",
          "modelId": "gpt-3.5-turbo"
        },
        "print": {
          "preText": "Suggest summaries for the article provided in XML tag. Act as a news editor and your task is to suggest a summary for the article.",
          "creativity": 5,
          "summaryCount": 5,
          "printSummaryWordCount": 100,
          "checkBoxDefault": false,
          "providerAccessToken": "",
          "serviceProvider": "Bedrock",
          "modelId": "anthropic.claude-v2:1"
        }
      },
      "generic": {
        "digital": {
          "preText": "Generate a headline",
          "creativity": 5,
          "checkBoxDefault": false,
          "providerAccessToken": "someToken",
          "serviceProvider": "openai",
          "modelId": "gpt-3.5-turbo"
        },
        "print": {
          "preText": "You are a News Editor of a News Firm and your task is to suggest headlines for the article provided in  XML tag.\n\nPlease use professional tone while generating headlines.",
          "creativity": 5,
          "checkBoxDefault": false,
          "providerAccessToken": "",
          "serviceProvider": "Bedrock",
          "modelId": "anthropic.claude-3-sonnet-20240229-v1:0"
        }
      }
    }
  }
}
```

Fields at the top level (data):

* contextLimit: Max. limit of context tags that can be sent in the prompt.
* encryptedKeyPhrase: Encryption Key Phrase for sending encrypted API Key.
* widgets: Widgets that should be enabled in the Wingman plugin.

***

## Headline Configuration Details

```json
"widgetConfig": {
  "headline": {
    "digital": {
      "preText": "Generate a headline",
      "creativity": 5,
      "headlineCount": 10,
      "digitalHeadlineWordCount": 20,
      "checkBoxDefault": false,
      "providerAccessToken": "someToken",
      "serviceProvider": "openai",
      "modelId": "gpt-3.5-turbo"
    },
    "print": {
      "preText": "Suggest headlines for the article provided in XML tag. If the article has a strong local connection, reflect this in the headline.",
      "creativity": 5,
      "headlineCount": 10,
      "printHeadlineWordCount": 8,
      "checkBoxDefault": false,
      "providerAccessToken": "",
      "serviceProvider": "Bedrock",
      "modelId": "anthropic.claude-3-sonnet-20240229-v1:0"
    }
  },
  ...
}
```

* preText: Field where the user provides the custom prompt to generate the headline.
  * Note: For AWS Bedrock, end your custom prompt with the words: “in the XML tag”. Do not add these words for ChatGPT models.
* creativity: Determines temperature (1–5). 1 = least random, 5 = most random.
* headlineCount: Total headline results to generate.
* digitalHeadlineWordCount: Approximate word count for digital headlines.
* printHeadlineWordCount: Approximate word count for print headlines.
* checkBoxDefault: Whether the checkbox is checked by default (false/true).
* providerAccessToken: Currently applicable for ChatGPT when an organization wants to use their own API key instead of Naviga's (if available).
* serviceProvider: AI service provider to use (*openai* for ChatGPT, *Bedrock* for AWS).
* modelId: Model identifier for the chosen AI service provider.

***

## Summary Configuration Details

```json
"summary": {
  "digital": {
    "preText": "Generate a summary",
    "creativity": 5,
    "summaryCount": 5,
    "digitalSummaryWordCount": 40,
    "checkBoxDefault": false,
    "providerAccessToken": "someToken",
    "serviceProvider": "openai",
    "modelId": "gpt-3.5-turbo"
  },
  "print": {
    "preText": "Suggest summaries for the article provided in XML tag. Act as a news editor and your task is to suggest a summary for the article.",
    "creativity": 5,
    "summaryCount": 5,
    "printSummaryWordCount": 100,
    "checkBoxDefault": false,
    "providerAccessToken": "",
    "serviceProvider": "Bedrock",
    "modelId": "anthropic.claude-v2:1"
  }
}
```

* preText: Field where the user provides the custom prompt to generate the summary.
  * Note: For AWS Bedrock it is recommended to end your custom prompt with the words: “in the XML tag”. Do not add these words for ChatGPT models.
* creativity: Determines temperature (1–5). 1 = least random, 5 = most random.
* summaryCount: Total summary results to generate.
* digitalSummaryWordCount: Approximate word count for digital summaries.
* printSummaryWordCount: Approximate word count for print summaries.
* displayCount: Number of results to display before showing a "show more" button.
* checkBoxDefault: Whether the checkbox is checked by default (false/true).
* providerAccessToken: Currently applicable for ChatGPT when an organization wants to use their own API key instead of Naviga's (if available).
* serviceProvider: AI service provider to use (*openai* for ChatGPT, *Bedrock* for AWS).
* modelID: Model identifier for the chosen AI service provider.

***

## Generic Configuration Details

```json
"generic": {
  "digital": {
    "preText": "Generate a headline",
    "creativity": 5,
    "checkBoxDefault": false,
    "providerAccessToken": "someToken",
    "serviceProvider": "openai",
    "modelId": "gpt-3.5-turbo"
  },
  "print": {
    "preText": "You are a News Editor of a News Firm and your task is to suggest headlines for the article provided in  XML tag.\n\nPlease use professional tone while generating headlines.",
    "creativity": 5,
    "checkBoxDefault": false,
    "providerAccessToken": "",
    "serviceProvider": "Bedrock",
    "modelId": "anthropic.claude-3-sonnet-20240229-v1:0"
  }
}
```

* preText: Field where the user provides the custom prompt to generate generic results.
  * Note: For AWS Bedrock it is recommended to end your custom prompt with the words: “in the XML tag”. Do not add these words for ChatGPT models.
* creativity: Determines temperature (1–5). 1 = least random, 5 = most random.
* checkBoxDefault: Whether the checkbox is checked by default (false/true).
* providerAccessToken: Currently applicable for ChatGPT when an organization wants to use their own API key instead of Naviga's (if available).
* serviceProvider: AI service provider to use (*openai* for ChatGPT, *Bedrock* for AWS).
* modelID: Model identifier for the chosen AI service provider.

***

Previous functional details: <https://docs.navigaglobal.com/wingman/1.3.0-2/functional-details>

Service Provider & Model ID details: <https://docs.navigaglobal.com/wingman/1.3.0-2/configuration/service-provider-and-model-id-details>
