# Configuration

```json
{
  "id": "io.infomaker.wingman",
  "name": "im-wingman",
  "style": "https://plugins.writer.infomaker.io/v1/infomaker/im-wingman/3.0.0/style.css",
  "url": "https://plugins.writer.infomaker.io/v1/infomaker/im-wingman/3.0.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"
        }
      }
    }
  }
}
```

## Top-level fields

* 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 (e.g., "generic", "headline", "summary").

***

## Headline configuration

```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\
  The custom prompt sent to generate the headline.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Note: For AWS Bedrock prompts, end your custom prompt with the words: ‘in the XML tag’. Do not add this phrase for ChatGPT models.</p></div>
* creativity\
  Determines randomness (temperature). Range: 1 (least) to 5 (most).
* headlineCount\
  Number of 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 (true/false).
* providerAccessToken\
  Applicable for ChatGPT when an organization wants to use its own API key instead of Naviga's (if available).
* serviceProvider\
  AI service provider: "openai" for ChatGPT, "Bedrock" for AWS.
* modelId\
  Model identifier for the selected provider.

***

## Summary configuration

```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\
  Custom prompt to generate the summary.

{% hint style="info" %}
Note: For AWS Bedrock prompts, it is recommended to end your custom prompt with the words: ‘in the XML tag’. Do not add this phrase for ChatGPT models.
{% endhint %}

* creativity\
  Determines randomness (temperature). Range: 1 (least) to 5 (most).
* summaryCount\
  Number of summary results to generate.
* digitalSummaryWordCount\
  Approximate word count for digital summaries.
* printSummaryWordCount\
  Approximate word count for print summaries.
* displayCount\
  Number of results displayed before the "show more" button (if applicable).
* checkBoxDefault\
  Whether the checkbox is checked by default (true/false).
* providerAccessToken\
  Applicable for ChatGPT when an organization wants to use its own API key instead of Naviga's (if available).
* serviceProvider\
  AI service provider: "openai" for ChatGPT, "Bedrock" for AWS.
* modelId\
  Model identifier for the selected provider.

***

## Generic configuration

```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\
  Custom prompt to generate generic results.

{% hint style="info" %}
Note: For AWS Bedrock prompts, it is recommended to end your custom prompt with the words: ‘in the XML tag’. Do not add this phrase for ChatGPT models.
{% endhint %}

* creativity\
  Determines randomness (temperature). Range: 1 (least) to 5 (most).
* checkBoxDefault\
  Whether the checkbox is checked by default (true/false).
* providerAccessToken\
  Applicable for ChatGPT when an organization wants to use its own API key instead of Naviga's (if available).
* serviceProvider\
  AI service provider: "openai" for ChatGPT, "Bedrock" for AWS.
* modelId\
  Model identifier for the selected provider.

***

Last updated: 2 months ago