Skip to main content

suggestBidRiskTags

Requires permission biddesk:bid:update.

Reads a bid's requirements (the customer's terms among them) in the background and leaves AI suggestions for a person to accept, edit or reject: a risk tag (penalty, liability, guarantee, warranty or payment) on a requirement, with the exact words that state the risk. Accepting adds the tag to the requirement; nothing is tagged until accepted. Follow progress with bidAiRuns and read the cards with bidAiSuggestions (skillKey clause-risk). A second call while one runs for the bid returns its run ids and starts nothing. Refused with TOO_MANY_REQUIREMENTS above 500 requirements, NOTHING_TO_PROPOSE for a bid with none, and not found for a bid the caller may not see. Requires Bid Desk and permission to update bids.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

mutation SuggestBidRiskTags($bidId: ID!) {
  suggestBidRiskTags(bidId: $bidId) {
    runIds
    started
  }
}

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "suggestBidRiskTags": {
      "runIds": [
        "id"
      ],
      "started": true
    }
  }
}
suggestBidRiskTags(
  bidId: ID!
): BidRiskTagRun!

Arguments​

suggestBidRiskTags.bidId ● ID! non-null scalar​

The bid.

Type​

BidRiskTagRun object​

Whether a risk-tag suggestion run started, and the AI runs already in progress.