Index a document using an index profile - Lucidworks documentation

Apps

Blobs

Catalog

Collections

Configurations

Connectors Datasources

Connectors History

Connectors Jobs

Connectors Plugins

Connectors Status

Custom Rule

Experiments

Features

Groups

History Id

History

Index Pipeline Templates

Index Pipelines

Index Profiles CRUD

Index Profiles

Index Stages

Introspect

Jobs

License

Messaging

Nodes

Objects

Parser Templates

Parsers

Partitions

Query Pipeline Templates

Query Pipelines

Query Profile Back Compatibility

Query Profiles CRUD

Query Profiles

Query Rewrite

Query Stages

Recommend

Registration

Scheduler

Schema

Search Cluster

Search Logs

Signals

Solr

Solr Admin

Solr Config

Spark

Suggestions Datasources

Swagger

Synonyms Editor

System Autocomplete

System

Tasks

Taxonomy

Usage

Webapps Admin

Webapps Appkit

Webapps

Zookeeper

{
  "docs": [
    {
      "id": "<string>",
      "fields": [
        {
          "name": "<string>",
          "value": {},
          "metadata": {},
          "annotations": [
            {
              "type": "<string>",
              "start": 123,
              "end": 123,
              "features": {},
              "label": "<string>",
              "featureCount": 123
            }
          ]
        }
      ],
      "metadata": {},
      "commands": [
        {
          "name": "<string>",
          "params": {}
        }
      ],
      "hints": {}
    }
  ],
  "stats": {}
}

POST

index

{id}

{
  "docs": [
    {
      "id": "<string>",
      "fields": [
        {
          "name": "<string>",
          "value": {},
          "metadata": {},
          "annotations": [
            {
              "type": "<string>",
              "start": 123,
              "end": 123,
              "features": {},
              "label": "<string>",
              "featureCount": 123
            }
          ]
        }
      ],
      "metadata": {},
      "commands": [
        {
          "name": "<string>",
          "params": {}
        }
      ],
      "hints": {}
    }
  ],
  "stats": {}
}

Path Parameters

string

required

The ID of the index profile to use

Query Parameters

simulate

boolean

default:false

If true, documents are not sent to Solr for indexing; the solr-index stage will be skipped

echo

boolean

default:true

If true, return the list of documents indexed; otherwise no output is returned when the pipeline has finished

echoMaxCount

integer<int32>

default:100

The maximum number of documents to list in the output

stats

boolean

default:false

bufferDocsForSolr

boolean

Body

A PipelineDocument or Solr XML document

The body is of type any.

Response

200 - application/json; qs=1.0

successful operation

docs

object[]

read-only

Show child attributes

stats

object

read-only

Show child attributes