How to set keywords and/or redactions with guard?

[cesekova]

I am not able to specify keyword (or redactions) and set up a guard for that.

res=c.apex.scan(message, keywords=['filling'],  redactions=['filling'], guard_config=[Guard.create('keyword_detector')])
...
ValueError: Cannot specify keywords or redactions in scan args when using guard config. Please use only one.

Can we add some examples how keyword and redaction arguments should be used ? Are they supposed to work only with default config (which does not include keyword detector)? Or should they be passed directly to guard itself ?

[abhijitherekar]

as the error mentions:

ValueError: Cannot specify keywords or redactions in scan args when using guard config. Please use only one.

1. We can either set keywords/redactions as standalone args.
2. Or set the keywords/redactions in guardconfig.

Basically, the guard_config args can't be used with keywords or redactions args.

Please let me know what the error should be so its clear.

[cesekova]

So standalone arguments is used when we want to add keywords or reductions to extraction in scan_response which will be also shown in UI. But if we want to use guardconfig we need to specify those inside a Guard object. But there is no way to "log" the keywords and having a guard for them at the same time ?

I think this need to be explained in scan response doc then we can close both of these issues.

[abhijitherekar]

@cesekova , I have updated the args, I think we can close this too. Please check.

[cesekova]

Yes, I saw the docs, just still not sure if for first time users is going to be clear when to use keywords/redactions separately and when as part of the guardconfig. We can discuss on sync up today and then I can close it

[cesekova]

@abhijitherekar Should we keep this open as tracker to create two separate functions (one for reduction/keywords and one for guarconfig) ?

[abhijitherekar]

We already a function called

res = acuvity.apex.scan_request(request={
"messages": ["What do you know about project bluefin?"]
"keywords": ["Bluefin"]
})

which doesn't take in guard config, we can think of using this if we just want the plain request to go in.

[cesekova]

@abhijitherekar since scan_request is a no go based on yesterdays meeting. Can we at least modified the function that if keywords or reductions are provided there would be no default config, because currently this is contradicting

:param redactions: the redactions that need to be redacted if detected. This arg cannot be used with guard_config.
:param keywords: the keywords that need to be detected. This arg cannot be used with guard_config.
:param guard_config: the guard config used to do the response eval for matches. If not provided, the default guard config will be used.

We can change the doc to somtehing like:
:param keywords: the keywords that need to be detected. This arg cannot be used with guard_config and will be visible in scan_reponse

and result.matches() would return None