Algolia Ingestion

Feeding a search index. Push records in, run and watch import tasks, and manage the sources and transformations behind them.

Measured routing accuracy

69 golden cases replayed through the router over the whole index: measured over corpus ea4f12ad2948 (65 toolkits, 2283 tools indexed and 13 declared uncallable), 56 cases written by hand and 13 cases from the paraphrase pass. A case counts as top-1 when its gold tool ranked first and top-8 when it reached the slate at all.

The sweep is offline: the reranker is a deterministic identity fake that returns candidates in the order retrieval produced them, so top-1 measures retrieval order rather than a reranked slate. just eval-live measures the same cases through the live reranker.

Authentication

Connect an entity with ConnectionsService.InitiateConnection, naming this toolkit's slug. Credentials stay in the connections vault; callers hold connected-account ids only.

api_key

Submit the key with ConnectionsService rather than putting it in a request; it is sealed at rest and never returned.

Tools

56 action tools. The catalog-wide slug is algolia_ingestion.<tool>, which is what search_tools returns and call_tool takes.

algolia_ingestion.list_authentications

List the Algolia ingestion authentication resources: the saved credentials and login secrets used to connect the pipeline to external systems and providers. Calls GET /1/authentications.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/authentications.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the saved credentials for connecting to systems", "list the login secrets the pipeline uses", "which providers do we have credentials for".

algolia_ingestion.create_authentication

Create an Algolia ingestion authentication resource: save a new set of credentials or login secret so the pipeline can connect to an external system. Calls POST /1/authentications.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/authentications.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "save credentials for reaching a system", "store a new login secret for a provider", "add connection credentials for the pipeline".

algolia_ingestion.search_authentications

Search the Algolia ingestion authentication resources: filter the saved credentials and connection secrets by name, platform, or type instead of paging the whole list. Calls POST /1/authentications/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/authentications/search.

Arguments:

Also retrieved by: "find a saved credential by name", "filter connection secrets by platform", "which credentials match this provider".

algolia_ingestion.get_authentication

Get one Algolia ingestion authentication resource by its id: the saved credential used to connect to an external system, without its secret. Calls GET /1/authentications/{authenticationID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/authentications/{{params.authenticationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "pull up one saved credential by id", "show a single stored connection secret", "fetch the details of one credential".

algolia_ingestion.update_authentication

Update an Algolia ingestion authentication resource: change the stored credential's name, platform, or secret so the pipeline connects with new details. Calls PATCH /1/authentications/{authenticationID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /1/authentications/{{params.authenticationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "rotate the secret on a stored credential", "change how the pipeline logs in to a system", "fix the credential details for a provider".

algolia_ingestion.delete_authentication

Delete an Algolia ingestion authentication resource: remove a stored credential the pipeline no longer uses to connect to a system. Calls DELETE /1/authentications/{authenticationID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/authentications/{{params.authenticationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove a stored credential we no longer use", "drop a saved connection secret", "delete an unused provider credential".

algolia_ingestion.list_destinations

List the Algolia ingestion destinations: the target indices and places where imported and ingested data is written at the end of the pipeline. Calls GET /1/destinations.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/destinations.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "where does ingested data get written", "show the target indices data lands in", "list the write targets of the pipeline".

algolia_ingestion.create_destination

Create an Algolia ingestion destination: define a new target index or place to write imported records into at the end of the pipeline. Calls POST /1/destinations.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/destinations.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "define a new place to write records into", "add a target index for imported data", "set up where the pipeline writes".

algolia_ingestion.search_destinations

Search the Algolia ingestion destinations: filter the target indices data is written into by name or type instead of paging the whole list. Calls POST /1/destinations/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/destinations/search.

Arguments:

Also retrieved by: "find the target index by name", "which write targets match this filter", "filter the places records land in".

algolia_ingestion.get_destination

Get one Algolia ingestion destination by its id: the target index records are written into at the end of the pipeline, and how it is configured. Calls GET /1/destinations/{destinationID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/destinations/{{params.destinationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show one write target by id", "what index does this target write to", "details of a single ingestion output".

algolia_ingestion.update_destination

Update an Algolia ingestion destination: point it at a different target index or change how imported records are written at the end of the pipeline. Calls PATCH /1/destinations/{destinationID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /1/destinations/{{params.destinationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "point the pipeline at a different index", "change where imported records are written", "edit the output settings of a write target".

algolia_ingestion.delete_destination

Delete an Algolia ingestion destination: stop writing imported records into that target index and remove it from the pipeline. Calls DELETE /1/destinations/{destinationID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/destinations/{{params.destinationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "stop writing records into this index", "remove a write target from the pipeline", "drop an output we no longer load into".

algolia_ingestion.push

Push records straight into an Algolia index through the ingestion pipeline: send a batch of documents to be transformed and indexed without configuring a source first. Calls POST /1/push/{indexName}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/push/{{params.indexName}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "send a batch of documents to an index", "upload records through the pipeline now", "index some data without setting up a connector".

algolia_ingestion.list_runs

List the Algolia ingestion runs: the history of pipeline executions, each a past job that pulled and imported data, with status and timing. Calls GET /1/runs.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/runs.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the history of pipeline executions", "list past ingestion jobs and their status", "what pipeline runs have happened".

algolia_ingestion.get_run

Get one Algolia ingestion run by its id: the details of a single pipeline execution, its status, and how much data it moved. Calls GET /1/runs/{runID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/runs/{{params.runID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "look up one pipeline execution by id", "show the details of a single ingestion job", "how did one run go".

algolia_ingestion.list_events

List the events of one Algolia ingestion run: the log lines and step records emitted during a single pipeline execution, for debugging. Calls GET /1/runs/{runID}/events.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/runs/{{params.runID}}/events.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the log lines of a pipeline execution", "the step by step records of one run", "debug what happened during a job".

algolia_ingestion.get_event

Get one event of an Algolia ingestion run: a single log line or step record from a pipeline execution, with its message and timing, for debugging. Calls GET /1/runs/{runID}/events/{eventID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/runs/{{params.runID}}/events/{{params.eventID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "open one log line from a job", "what does this single step record say", "drill into one entry of a run's log".

algolia_ingestion.list_sources

List the Algolia ingestion sources: the upstream systems, databases, and connectors the pipeline pulls and draws data from. Calls GET /1/sources.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/sources.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which upstream systems do we pull from", "show the connectors we draw data from", "list the inputs feeding the pipeline".

algolia_ingestion.create_source

Create an Algolia ingestion source: connect a new upstream system, database, or connector to draw and pull data from into the pipeline. Calls POST /1/sources.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/sources.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "connect a new upstream system", "add a connector to draw data from", "hook up an input to the pipeline".

algolia_ingestion.search_sources

Search the Algolia ingestion sources: filter the upstream systems and connectors the pipeline pulls from by name or type instead of paging the whole list. Calls POST /1/sources/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/sources/search.

Arguments:

Also retrieved by: "find an upstream connector by name", "which inputs match this filter", "filter the systems we pull data from".

algolia_ingestion.validate_source

Check an Algolia ingestion source before saving it: confirm the connection details are usable and the upstream system can actually be reached. Calls POST /1/sources/validate.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/sources/validate.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "test a connection before saving it", "can the pipeline reach this system", "dry run the settings for a new input".

algolia_ingestion.get_source

Get one Algolia ingestion source by its id: the upstream system or connector the pipeline draws data from, and how it is configured. Calls GET /1/sources/{sourceID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/sources/{{params.sourceID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show one input connector by id", "how is this upstream system configured", "details of a single data feed".

algolia_ingestion.update_source

Update an Algolia ingestion source: change the upstream system's connection details, credentials, or settings so the pipeline pulls from it differently. Calls PATCH /1/sources/{sourceID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /1/sources/{{params.sourceID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "change the settings of an input connector", "repoint the feed at a different database", "edit how we pull from an upstream system".

algolia_ingestion.delete_source

Delete an Algolia ingestion source: disconnect an upstream system so the pipeline no longer pulls data from it. Calls DELETE /1/sources/{sourceID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/sources/{{params.sourceID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "disconnect an upstream system", "stop pulling data from this feed", "remove an input we no longer use".

algolia_ingestion.trigger_docker_source_discover

Ask an Algolia ingestion source to list what it can offer: run discovery against a connector so its available streams, tables, and collections come back. Calls POST /1/sources/{sourceID}/discover.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/sources/{{params.sourceID}}/discover.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "what tables can this connector see", "list the streams available from a feed", "run discovery against an upstream system".

algolia_ingestion.run_source

Run an Algolia ingestion source: kick off every task and job attached to one upstream connector so its data is pulled in now. Calls POST /1/sources/{sourceID}/run.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/sources/{{params.sourceID}}/run.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "kick off the jobs for one connector", "pull data from an upstream system now", "trigger everything attached to a source".

algolia_ingestion.validate_source_before_update

Check a change to an Algolia ingestion source before saving it: confirm the edited connection details are usable and the upstream system still answers. Calls POST /1/sources/{sourceID}/validate.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/sources/{{params.sourceID}}/validate.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "test an edit to a connector before saving", "does the upstream still answer with these changes", "verify new settings on an existing feed".

algolia_ingestion.list_tasks_v1

List the Algolia ingestion tasks on the older v1 API: the scheduled jobs that move data from a source into a destination, as the first generation of the endpoint returns them. Calls GET /1/tasks.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/tasks.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the scheduled jobs on the old task api", "list v1 ingestion jobs", "what tasks exist under the first generation endpoint".

algolia_ingestion.create_task_v1

Create an Algolia ingestion task on the older v1 API: schedule a new job that moves data from one source into one destination. Calls POST /1/tasks.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/tasks.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "schedule a job on the v1 task api", "set up an old-style ingestion task", "add a data-moving job under the legacy endpoint".

algolia_ingestion.search_tasks_v1

Search the Algolia ingestion tasks on the older v1 API: filter the scheduled jobs by source, destination, or trigger instead of paging the whole list. Calls POST /1/tasks/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/tasks/search.

Arguments:

Also retrieved by: "filter v1 ingestion jobs", "find an old-style task by its source", "which legacy jobs match this filter".

algolia_ingestion.get_task_v1

Get one Algolia ingestion task on the older v1 API: a single scheduled job, its source, its destination, and its trigger. Calls GET /1/tasks/{taskID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "open one job on the v1 task api", "how is this legacy task configured", "show a single old-style ingestion job".

algolia_ingestion.update_task_v1

Update an Algolia ingestion task on the older v1 API: change a scheduled job's trigger, input, or settings. Calls PATCH /1/tasks/{taskID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /1/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "change the schedule of a v1 job", "edit an old-style ingestion task", "retune a legacy data-moving job".

algolia_ingestion.delete_task_v1

Delete an Algolia ingestion task on the older v1 API: remove a scheduled job so it never runs again. Calls DELETE /1/tasks/{taskID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove a job from the v1 task api", "get rid of an old-style ingestion task", "stop a legacy job running ever again".

algolia_ingestion.disable_task_v1

Pause an Algolia ingestion task on the older v1 API: stop a scheduled job firing while keeping its configuration. Calls PUT /1/tasks/{taskID}/disable.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/tasks/{{params.taskID}}/disable.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "pause a job on the v1 task api", "turn off an old-style scheduled task", "stop a legacy job firing for now".

algolia_ingestion.enable_task_v1

Resume an Algolia ingestion task on the older v1 API: let a paused scheduled job fire on its trigger again. Calls PUT /1/tasks/{taskID}/enable.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/tasks/{{params.taskID}}/enable.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "resume a paused job on the v1 task api", "switch an old-style task back on", "let a legacy job fire again".

algolia_ingestion.run_task_v1

Run an Algolia ingestion task now on the older v1 API: fire a scheduled job immediately instead of waiting for its trigger. Calls POST /1/tasks/{taskID}/run.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/tasks/{{params.taskID}}/run.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "fire a v1 job right now", "run an old-style ingestion task immediately", "trigger a legacy job without waiting".

algolia_ingestion.list_transformations

List the Algolia ingestion transformations: the record-shaping and mapping steps defined to reshape data as it flows through the pipeline. Calls GET /1/transformations.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/transformations.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the record-shaping steps we defined", "list the mapping rules in the pipeline", "what reshaping steps exist".

algolia_ingestion.create_transformation

Create an Algolia ingestion transformation: define a new step that reshapes, maps, or enriches incoming records inside the pipeline. Calls POST /1/transformations.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/transformations.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "define a step that reshapes records", "add a mapping rule to the pipeline", "set up a new data-shaping step".

algolia_ingestion.search_transformations

Search the Algolia ingestion transformations: filter the record-shaping steps by name or code instead of paging the whole list. Calls POST /1/transformations/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/transformations/search.

Arguments:

Also retrieved by: "find a shaping step by name", "which mapping rules match this filter", "filter the record transforms we defined".

algolia_ingestion.try_transformation

Try an Algolia ingestion transformation on a sample: preview how a record-shaping step would change a record before saving the step. Calls POST /1/transformations/try.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/transformations/try.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "preview how a shaping step changes a record", "test a mapping rule before saving it", "dry run a reshaping step on a sample".

algolia_ingestion.get_transformation

Get one Algolia ingestion transformation: a single record-shaping step, its code, and what it does to records passing through. Calls GET /1/transformations/{transformationID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/transformations/{{params.transformationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "open one shaping step by id", "what does this mapping rule do", "show the code of a single transform".

algolia_ingestion.update_transformation

Replace an Algolia ingestion transformation: rewrite the code of a record-shaping step so records are mapped differently from now on. Calls PUT /1/transformations/{transformationID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/transformations/{{params.transformationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "rewrite the code of a shaping step", "change how records are mapped", "update a transform's logic".

algolia_ingestion.delete_transformation

Delete an Algolia ingestion transformation: remove a record-shaping step so records flow through unchanged. Calls DELETE /1/transformations/{transformationID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/transformations/{{params.transformationID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove a shaping step from the pipeline", "stop mapping records through this rule", "drop a transform we no longer need".

algolia_ingestion.try_transformation_before_update

Try a changed Algolia ingestion transformation on a sample record: preview what the edited shaping step would do before saving the change. Calls POST /1/transformations/{transformationID}/try.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/transformations/{{params.transformationID}}/try.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "preview an edit to a shaping step", "what would the new code do to this record", "test a changed mapping rule on a sample".

algolia_ingestion.list_tasks

List the Algolia ingestion tasks: the scheduled jobs that move data from a source into a destination, with their triggers and current state. Calls GET /2/tasks.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /2/tasks.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the scheduled ingestion jobs", "what jobs move data into our indices", "list the pipeline's jobs and triggers".

algolia_ingestion.create_task

Create an Algolia ingestion task: schedule a new job that moves data from one source into one destination on a trigger. Calls POST /2/tasks.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /2/tasks.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "schedule a job to import data", "set up a new pipeline job on a trigger", "add a job that loads a source into an index".

algolia_ingestion.search_tasks

Search the Algolia ingestion tasks: filter the scheduled jobs by source, destination, or trigger instead of paging the whole list. Calls POST /2/tasks/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /2/tasks/search.

Arguments:

Also retrieved by: "find an ingestion job by its source", "which scheduled jobs write to this index", "filter the pipeline's jobs".

algolia_ingestion.get_task

Get one Algolia ingestion task: a single scheduled job, where it reads from, where it writes to, and when it fires. Calls GET /2/tasks/{taskID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /2/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "open one ingestion job by id", "where does this job read and write", "show a single scheduled import".

algolia_ingestion.replace_task

Replace an Algolia ingestion task outright: send the whole job definition, overwriting every field rather than the few being changed. Calls PUT /2/tasks/{taskID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /2/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "overwrite a whole job definition", "send the full config for an import job", "replace every field of a scheduled job".

algolia_ingestion.update_task

Change part of an Algolia ingestion task: send only the fields being edited, such as its trigger, its input, or its notifications. Calls PATCH /2/tasks/{taskID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /2/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "change just the trigger of an import job", "edit one field of a scheduled job", "tweak an ingestion job's settings".

algolia_ingestion.delete_task

Delete an Algolia ingestion task: remove a scheduled job so no more data is moved on its trigger. Calls DELETE /2/tasks/{taskID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /2/tasks/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove a scheduled import job", "stop a job moving data for good", "get rid of a pipeline job".

algolia_ingestion.disable_task

Pause an Algolia ingestion task: stop a scheduled job firing while keeping its definition intact. Calls PUT /2/tasks/{taskID}/disable.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /2/tasks/{{params.taskID}}/disable.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "pause an import job for now", "turn off a scheduled job without deleting it", "stop a pipeline job from firing".

algolia_ingestion.enable_task

Resume an Algolia ingestion task: let a paused job fire on its trigger again. Calls PUT /2/tasks/{taskID}/enable.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /2/tasks/{{params.taskID}}/enable.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "switch a paused import job back on", "let a scheduled job run again", "resume a stopped pipeline job".

algolia_ingestion.push_task

Push records into an Algolia ingestion task: hand a batch of documents to one job so they flow through its transformations into its destination index. Calls POST /2/tasks/{taskID}/push.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /2/tasks/{{params.taskID}}/push.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "hand a batch of documents to one job", "feed records into an existing import job", "send data through a job's transformations".

algolia_ingestion.run_task

Run an Algolia ingestion task now: fire a scheduled job immediately instead of waiting for its trigger. Calls POST /2/tasks/{taskID}/run.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /2/tasks/{{params.taskID}}/run.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "run an import job right now", "fire a scheduled job immediately", "trigger a data load without waiting".

algolia_ingestion.chunked_push

Replace everything in an Algolia index through the ingestion pipeline: split a large batch of records into chunks of a thousand and push them all, swapping out the index's current contents. Calls GET /chunkedPush.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /chunkedPush.

Arguments:

Also retrieved by: "reindex everything from a big batch", "swap out an index's whole contents", "bulk load a large record set in chunks".