HTTP interface for Analyzers

The HTTP API for Analyzers lets you create and delete Analyzers, as well as list all or get specific Analyzers with all their settings

The RESTful API for managing ArangoSearch Analyzers is accessible via the /_api/analyzer endpoint.

See the description of Analyzers for an introduction and the available types, properties and features.

Create an Analyzer

post /_db/{database-name}/_api/analyzer

Creates a new Analyzer based on the provided configuration.

Path Parameters

database-name* string
The name of the database.

Query Parameters

HTTP Headers

Request Body application/json

features array of strings
The set of features to set on the Analyzer generated fields. The default value is an empty array.
name* string
The Analyzer name.
properties object
The properties used to configure the specified Analyzer type.
type* string
The Analyzer type.

Responses

200 OK
An Analyzer with a matching name and definition already exists.
201 Created
A new Analyzer definition was successfully created.
400 Bad Request
One or more of the required parameters is missing or one or more of the parameters is not valid.
403 Forbidden
The user does not have permission to create and Analyzer with this configuration.

Examples

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/analyzer' <<'EOF'
{
  "name": "testAnalyzer",
  "type": "identity"
}
EOF

Show output

Get an Analyzer definition

get /_db/{database-name}/_api/analyzer/{analyzer-name}

Retrieves the full definition for the specified Analyzer name. The resulting object contains the following attributes:

name: the Analyzer name
type: the Analyzer type
properties: the properties used to configure the specified type
features: the set of features to set on the Analyzer generated fields

Path Parameters

database-name* string
The name of the database.
analyzer-name* string
The name of the Analyzer to retrieve.

Query Parameters

HTTP Headers

Responses

200 OK
The Analyzer definition was retrieved successfully.
404 Not Found
Such an Analyzer configuration does not exist.

Examples

Retrieve an Analyzer definition:

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/analyzer/testAnalyzer'

Show output

List all Analyzers

get /_db/{database-name}/_api/analyzer

Retrieves a an array of all Analyzer definitions. The resulting array contains objects with the following attributes:

name: the Analyzer name
type: the Analyzer type
properties: the properties used to configure the specified type
features: the set of features to set on the Analyzer generated fields

Path Parameters

database-name* string
The name of the database.

Query Parameters

HTTP Headers

Responses

200 OK
The Analyzer definitions was retrieved successfully.

Examples

Retrieve all Analyzer definitions:

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/analyzer'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 2116
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "error" : false, 
  "code" : 200, 
  "result" : [ 
    { 
      "name" : "text_nl", 
      "type" : "text", 
      "properties" : { 
        "locale" : "nl", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_no", 
      "type" : "text", 
      "properties" : { 
        "locale" : "no", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_sv", 
      "type" : "text", 
      "properties" : { 
        "locale" : "sv", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_ru", 
      "type" : "text", 
      "properties" : { 
        "locale" : "ru", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_es", 
      "type" : "text", 
      "properties" : { 
        "locale" : "es", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_pt", 
      "type" : "text", 
      "properties" : { 
        "locale" : "pt", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_fi", 
      "type" : "text", 
      "properties" : { 
        "locale" : "fi", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_en", 
      "type" : "text", 
      "properties" : { 
        "locale" : "en", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_zh", 
      "type" : "text", 
      "properties" : { 
        "locale" : "zh", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : false 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_fr", 
      "type" : "text", 
      "properties" : { 
        "locale" : "fr", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_it", 
      "type" : "text", 
      "properties" : { 
        "locale" : "it", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "identity", 
      "type" : "identity", 
      "properties" : { 
      }, 
      "features" : [ 
        "frequency", 
        "norm" 
      ] 
    }, 
    { 
      "name" : "text_de", 
      "type" : "text", 
      "properties" : { 
        "locale" : "de", 
        "case" : "lower", 
        "stopwords" : [ ], 
        "accent" : false, 
        "stemming" : true 
      }, 
      "features" : [ 
        "frequency", 
        "position", 
        "norm" 
      ] 
    } 
  ] 
}

Remove an Analyzer

delete /_db/{database-name}/_api/analyzer/{analyzer-name}

Removes an Analyzer configuration identified by analyzer-name.

If the Analyzer definition was successfully dropped, an object is returned with the following attributes:

error: false
name: The name of the removed Analyzer

Path Parameters

database-name* string
The name of the database.
analyzer-name* string
The name of the Analyzer to remove.

Query Parameters

force boolean
The Analyzer configuration should be removed even if it is in-use. The default value is false.

HTTP Headers

Responses

200 OK
The Analyzer configuration was removed successfully.
400 Bad Request
The analyzer-name was not supplied or another request parameter was not valid.
403 Forbidden
The user does not have permission to remove this Analyzer configuration.
404 Not Found
Such an Analyzer configuration does not exist.
409 Conflict
The specified Analyzer configuration is still in use and force was omitted or false specified.

Examples

Removing without force:

curl -X DELETE --header 'accept: application/json' --dump - 'http://localhost:8529/_api/analyzer/testAnalyzer'

Show output

Removing with force:

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/collection' <<'EOF'
{
  "name": "testCollection"
}
EOF

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/view' <<'EOF'
{
  "name": "testView",
  "type": "arangosearch",
  "links": {
    "testCollection": {
      "analyzers": [
        "testAnalyzer"
      ]
    }
  }
}
EOF

curl -X DELETE --header 'accept: application/json' --dump - 'http://localhost:8529/_api/analyzer/testAnalyzer?force=false'

curl -X DELETE --header 'accept: application/json' --dump - 'http://localhost:8529/_api/analyzer/testAnalyzer?force=true'

Show output