Skip to main content

@agentshelf/external-agents-sdk / PublicExternalAgentPolicy

Type Alias: PublicExternalAgentPolicy

type PublicExternalAgentPolicy = {
  capabilities: {
     approvals: boolean;
     artifacts: boolean;
     conversations: boolean;
     files: boolean;
     interactions: boolean;
     messages: boolean;
  };
  defaultStreamProfile: RuntimeStreamProfile;
  domainTools: PublicDomainTool[];
  filePolicy: {
     allowedMimeTypes: string[];
     maxUploadBytes: number;
     read: boolean;
     upload: boolean;
  };
  hostContextPolicy: {
     acceptedFields: string[];
     maxTotalBytes: number;
  };
  outputModuleTypes: string[];
  providerGroundingDisplay: boolean;
  publicErrorDetail:   | "minimal"
     | "standard"
     | "diagnostic"
     | string & {
   };
  rateLimits: JsonObject;
  sdk: {
     minVersion: string | null;
  };
  spendLimits: JsonObject;
  streamProfiles: RuntimeStreamProfile[];
};

Properties​

capabilities​

capabilities: {
  approvals: boolean;
  artifacts: boolean;
  conversations: boolean;
  files: boolean;
  interactions: boolean;
  messages: boolean;
};

approvals​

approvals: boolean;

artifacts​

artifacts: boolean;

conversations​

conversations: boolean;

files​

files: boolean;

interactions​

interactions: boolean;

messages​

messages: boolean;

defaultStreamProfile​

defaultStreamProfile: RuntimeStreamProfile;

domainTools​

domainTools: PublicDomainTool[];

filePolicy​

filePolicy: {
  allowedMimeTypes: string[];
  maxUploadBytes: number;
  read: boolean;
  upload: boolean;
};

allowedMimeTypes​

allowedMimeTypes: string[];

maxUploadBytes​

maxUploadBytes: number;

read​

read: boolean;

upload​

upload: boolean;

hostContextPolicy​

hostContextPolicy: {
  acceptedFields: string[];
  maxTotalBytes: number;
};

acceptedFields​

acceptedFields: string[];

maxTotalBytes​

maxTotalBytes: number;

outputModuleTypes​

outputModuleTypes: string[];

providerGroundingDisplay​

providerGroundingDisplay: boolean;

publicErrorDetail​

publicErrorDetail: 
  | "minimal"
  | "standard"
  | "diagnostic"
  | string & {
};

rateLimits​

rateLimits: JsonObject;

sdk​

sdk: {
  minVersion: string | null;
};

minVersion​

minVersion: string | null;

spendLimits​

spendLimits: JsonObject;

streamProfiles​

streamProfiles: RuntimeStreamProfile[];