|
1285 | 1285 | "def": { |
1286 | 1286 | "name": "class Client", |
1287 | 1287 | "declaration": "Client(self, token: str, server_url: str = 'work.withpixie.ai', use_encryption: bool = False, channel_fn: Callable[[str], grpc.Channel] = None, conn_channel_fn: Callable[[str], grpc.aio._base_channel.Channel] = None )", |
1288 | | - "docstring": "Client is the main entry point to the Pixie API.\n\nTo setup the client, you need to generate an API token\nand pass it in as the first argument.\nSee: https://docs.px.dev/using-pixie/api-quick-start/\nfor more info." |
| 1288 | + "docstring": "Client is the main entry point to the Pixie API.\n\nTo setup the client, you need to generate an API token\nand pass it in as the first argument.\nSee: [https://docs.px.dev/using-pixie/api-quick-start/](https://docs.px.dev/using-pixie/api-quick-start/)\nfor more info." |
1289 | 1289 | }, |
1290 | 1290 | "methods": [ |
1291 | 1291 | { |
|
1389 | 1389 | "def": { |
1390 | 1390 | "name": "class Row", |
1391 | 1391 | "declaration": "Row(self, table: pxapi.data._TableStream, data: List[Any])", |
1392 | | - "docstring": "Row represents a row of data for a particular table. You can easily access\ndata in the row by using the column name from the associated table.\n\nSpecifically designed to avoid allocation memory for the relation for each row.\n\nExamples:\n \u003e\u003e\u003e tableA = Table(\"a\", relation=((\"cola\",int), (\"colb\", int), (\"colc\", string)))\n \u003e\u003e\u003e row = Row(tableA, [1,2,\"three\"])\n \u003e\u003e\u003e row[\"cola\"]\n 1\n \u003e\u003e\u003e row[\"colb\"]\n 2\n \u003e\u003e\u003e row[\"colc\"]\n \"three\"\n \u003e\u003e\u003e row\n { \"cola\": 1, \"colb\": 2, \"colc\": \"three\" }" |
| 1392 | + "docstring": "Row represents a row of data for a particular table. You can easily access\ndata in the row by using the column name from the associated table.\n\nSpecifically designed to avoid allocation memory for the relation for each row.\n\nExamples:\n \u003e\u003e\u003e tableA = Table(\"a\", relation=((\"cola\",int), (\"colb\", int), (\"colc\", string)))\n \u003e\u003e\u003e row = Row(tableA, [1,2,\"three\"])\n \u003e\u003e\u003e row[\"cola\"]\n 1\n \u003e\u003e\u003e row[\"colb\"]\n 2\n \u003e\u003e\u003e row[\"colc\"]\n \"three\"\n \u003e\u003e\u003e row\n {`{ \"cola\": 1, \"colb\": 2, \"colc\": \"three\" }`}" |
1393 | 1393 | }, |
1394 | 1394 | "methods": [] |
1395 | 1395 | }, |
|
5566 | 5566 | { |
5567 | 5567 | "name": "redact_pii_best_effort", |
5568 | 5568 | "brief": "Make a best effort to redact Personally Identifiable Information (PII).", |
5569 | | - "desc": "Replace instances of PII with '\u003cREDACTED_$TYPE\u003e' eg. '\u003cREDACTED_EMAIL\u003e' or '\u003cREDACTED_IPv4\u003e'. Currently, it will (on a best effort basis) redact IP addresses, email addresses, MAC addresses, IMEI numbers and credit card numbers. However, the redaction is not perfect, so it should not be used in a context where privacy needs to be guaranteed.", |
| 5569 | + "desc": "Replace instances of PII with {`'\u003cREDACTED_$TYPE\u003e'`} eg. {`'\u003cREDACTED_EMAIL\u003e'`} or {`'\u003cREDACTED_IPv4\u003e'`}. Currently, it will (on a best effort basis) redact IP addresses, email addresses, MAC addresses, IMEI numbers and credit card numbers. However, the redaction is not perfect, so it should not be used in a context where privacy needs to be guaranteed.", |
5570 | 5570 | "examples": [ |
5571 | 5571 | { |
5572 | 5572 | "value": "```\ndf.redacted = px.redact_pii_best_effort(df.req_body)\n```" |
|
0 commit comments