API Reference



FlexSearch REST Services

Description of all the REST endpoints exposed by FlexSearch.

Methods

[ Jump to Models ]

List of Operations


Get all analyzers

get /analyzers

Returns all the analyzers present in the system.

Property NameDescription
HTTP Methodget
SDK Method NamegetAllAnalyzers
Return typegetAllAnalyzersResponse
Responses
  • 200 : An array of analyzers
  • 400 : Unexpected error

[ Jump to Methods ]


Get analyzer

get /analyzers/{analyzerName}

Returns an analyzer by name.

Property NameDescription
HTTP Methodget
SDK Method NamegetAnalyzer
Path parameters
  • analyzerName (required) : Analyzer name
Return typegetAnalyzerResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Create or update an analyzer

put /analyzers/{analyzerName}

This service is idempotent.

Property NameDescription
HTTP Methodput
SDK Method NamecreateOrUpdateAnalyzer
Path parameters
  • analyzerName (required) : Analyzer name
Request bodyanalyzer (required)
Return typecreateOrUpdateAnalyzerResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Delete an analyzer

delete /analyzers/{analyzerName}

Deletes an analyzer by name.

Property NameDescription
HTTP Methoddelete
SDK Method NamedeleteAnalyzer
Path parameters
  • analyzerName (required) : Analyzer name
Return typedeleteAnalyzerResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Analyze input text

post /analyzers/{analyzerName}/analyzetext

This endpoint is useful to understand the effect of a particular analyzer on the input text. You can use the service with both custom and built-in analyzers. The returned response contains the tOKenized input.

Property NameDescription
HTTP Methodpost
SDK Method NameanalyzeText
Path parameters
  • analyzerName (required) : Analyzer name
Request bodyanalyzeText (required)
Return typeanalyzeTextResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Get all indices

get /indices

Property NameDescription
HTTP Methodget
SDK Method NamegetAllIndices
Return typegetAllIndicesResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Create a new index

post /indices

Property NameDescription
HTTP Methodpost
SDK Method NamecreateIndex
Request bodyindex (required)
Return typecreateIndexResponse
Responses
  • 200 : OK
  • 400 : Bad Request
  • 409 : Conflict

[ Jump to Methods ]


Returns document by ID

get /indices/{indexId}/documents/{docId}

Property NameDescription
HTTP Methodget
SDK Method NamegetDocument
Path parameters
  • indexId (required) : Index name
  • docId (required) : Document ID
Return typegetDocumentResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Create or update a document

put /indices/{indexId}/documents/{docId}

It is advisable to use create document endpoint when you are sure that the document does not exist in an index. This service will always perform an ID based loOK up to determine if a document already exists. In case of non-unique\nID based index, this will replace all the documents with the currently passed document. This endpoint can be used with concurrency control semantics.

Property NameDescription
HTTP Methodput
SDK Method NamecreateOrUpdateDocument
Path parameters
  • indexId (required) : Index name
  • docId (required) : Document ID
Request bodydocument (required)
Return typecreateOrUpdateDocumentResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Delete a document

delete /indices/{indexId}/documents/{docId}

In case of non-unique ID field, this will delete all the documents associated with that ID.

Property NameDescription
HTTP Methoddelete
SDK Method NamedeleteDocument
Path parameters
  • indexId (required) : Index name
  • docId (required) : Document ID
Return typedeleteDocumentResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Get an index

get /indices/{indexName}

This service will return a status of 404 when index is not present on the server.

Property NameDescription
HTTP Methodget
SDK Method NamegetIndex
Path parameters
  • indexName (required) : Index name
Return typegetIndexResponse
Responses
  • 200 : OK
  • 400 : Bad Request
  • 404 : Not Found

[ Jump to Methods ]


Deletes an index

delete /indices/{indexName}

Index deletion happens in two parts, first the index configuration file is deleted from the configurations folder, then the index is deleted from the data folder. In case any error is encountered the cleanup will be performed on the server restart.

Property NameDescription
HTTP Methoddelete
SDK Method NamedeleteIndex
Path parameters
  • indexName (required) : Index name
Return typedeleteIndexResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Update the configuration of an index

put /indices/{indexName}/configuration

The Index Version cannot be modified.

Property NameDescription
HTTP Methodput
SDK Method NameupdateIndexConfiguration
Path parameters
  • indexName (required) : Index Name
Request bodyindexConfiguration (required)
Return typeupdateIndexConfigurationResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Connector for importing CSV file data into the system.

post /indices/{indexName}/csv

Property NameDescription
HTTP Methodpost
SDK Method Namecsv
Path parameters
  • indexName (required) : Index name
Request bodycsvIndexingRequest (required)
Return typecsvIndexingResponse
Responses
  • 200 : OK
  • 400 : Failure

[ Jump to Methods ]


Returns top 10 document from the index

get /indices/{indexName}/documents

This endpoint is useful to determine the structure of the documents indexed. At times it is quicker to get the count of all the documents present in the index\nusing the service rather then using the search API.

Property NameDescription
HTTP Methodget
SDK Method NamegetDocuments
Path parameters
  • indexName (required) : Index name
Return typegetDocumentsResponse
Responses
  • 200 : OK
  • 400 : Bad Request
  • 404 : Not Found

[ Jump to Methods ]


Create a document

post /indices/{indexName}/documents

Creates a new document. Unlike a database system FlexSearch doesn't impose the requirement of a unique\nID per document. You can add multiple documents by the same ID but this can\nimpose a problem while adding or retrieving them. You can enforce a unique ID\ncheck by using the `timestamp` field. To understand more about ID check and\nconcurrency control, please refer to the article `concurrency control` under\nconcepts section.

Property NameDescription
HTTP Methodpost
SDK Method NamecreateDocument
Path parameters
  • indexName (required) : Index name
Request bodydocument (required)
Return typecreateDocumentResponse
Responses
  • 201 : Created
  • 400 : Bad Request
  • 409 : Conflict

[ Jump to Methods ]


Delete all documents

delete /indices/{indexName}/documents

This will remove all the documents present in an index. This is useful when you want to re-index all the documents.

Property NameDescription
HTTP Methoddelete
SDK Method NamedeleteAllDocuments
Path parameters
  • indexName (required) : Index name
Return typedeleteAllDocumentsResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Duplicate Detection Handler

post /indices/{indexName}/duplicatedetection/{predefinedQueryName}

Property NameDescription
HTTP Methodpost
SDK Method NameduplicateDetection
Path parameters
  • indexName (required) : Index name
  • predefinedQueryName (required) : Predefined query name
Request bodyduplicateDetectionRequest (required)
Return typeduplicateDetectionResponse
Responses
  • 200 : Job ID
  • 400 : Bad Request

[ Jump to Methods ]


Check if an index exists

get /indices/{indexName}/exists

This endpoint can be used to check if an index is present in the system. This endpoint is a lighter alternative to accessing the index by an ID as the response is smaller in size.

Property NameDescription
HTTP Methodget
SDK Method NameindexExists
Path parameters
  • indexName (required) : Index name
Return typeindexExistsResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Update the Index Fields

put /indices/{indexName}/fields

Any analyzer which is to be used as part of an index field should be defined before adding the field to the index. Always re-index the data after a field update, otherwise you may get unexpected results. New fields added as part of fields update will not have any data available for the older records, in such cases if the indexing is not done the engine will use default values for the field type. If an existing field is removed then the data associated with that field will not be accessible even though the data will not be removed from the index itself.

Property NameDescription
HTTP Methodput
SDK Method NameupdateIndexFields
Path parameters
  • indexName (required) : Index Name
Request bodyfieldsUpdateRequest (required)
Return typeupdateIndexFieldsResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Adds or updates a predefined query for the given index

put /indices/{indexName}/predefinedQuery

Property NameDescription
HTTP Methodput
SDK Method NameupdateIndexPredefinedQuery
Path parameters
  • indexName (required) : Index Name
Request bodysearchQuery (required)
Return typeupdateIndexPredefinedQueryResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Refreshes an index

put /indices/{indexName}/refresh

Refreshes an index so that committed data can be visible when searching.

Property NameDescription
HTTP Methodput
SDK Method NamerefreshIndex
Path parameters
  • indexName (required) : Index name
Return typerefreshIndexResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Search in a index

get /indices/{indexName}/search

Search across the index for documents. Any parameter passed as part of query string takes precedence over the same parameter in the request body. This operation supports both GET & POST verbs.

Property NameDescription
HTTP Methodget
SDK Method NamegetSearch
Path parameters
  • indexName (required) : Index name
Query parameters
  • q : Short hand for 'QueryString'.
  • c : Columns to be retrieved. Use * to retrieve all columns.
  • count : Count parameter. Refer to 'Search Query' properties.
  • skip : Skip parameter. Refer to 'Search Query' properties.
  • orderby : Order by parameter. Refer to 'Search Query' properties.
  • orderbydirection : Order by Direction parameter. Refer to 'Search Query' properties.
Request bodysearchQuery (required)
Return typesearchResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


post /indices/{indexName}/search

Search across the index for documents. Any parameter passed as part of query string takes precedence over the same parameter in the request body. This operation supports both GET & POST verbs.

Property NameDescription
HTTP Methodpost
SDK Method Namesearch
Path parameters
  • indexName (required) : Index name
Query parameters
  • q : Short hand for 'QueryString'.
  • c : Columns to be retrieved. Use * to retrieve all columns.
  • count : Count parameter. Refer to 'Search Query' properties.
  • skip : Skip parameter. Refer to 'Search Query' properties.
  • orderby : Order by parameter. Refer to 'Search Query' properties.
  • orderbydirection : Order by Direction parameter. Refer to 'Search Query' properties.
Request bodysearchQuery (required)
Return typesearchResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Returns the size of an index

get /indices/{indexName}/size

The return size may be higher than the actual size of the documents present in the index. The return value includes the space occupied by the transaction logs and older segment files which are not cleaned up as part of the last comment.

Property NameDescription
HTTP Methodget
SDK Method NamegetIndexSize
Path parameters
  • indexName (required) : Index name
Return typegetIndexSizeResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Connector for importing data from Microsoft SQL into the system.

post /indices/{indexName}/sql

Property NameDescription
HTTP Methodpost
SDK Method Namesql
Path parameters
  • indexName (required) : Index Name
Request bodysqlIndexingRequest (required)
Return typesqlIndexingResponse
Responses
  • 200 : OK
  • 400 : Failure

[ Jump to Methods ]


Returns the status of an index

get /indices/{indexName}/status

This endpoint can be used to determine if an index is online or off-line.

Property NameDescription
HTTP Methodget
SDK Method NamegetIndexStatus
Path parameters
  • indexName (required) : Index Name
Return typegetStatusResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Update the status of an index

put /indices/{indexName}/status/{status}

This endpoint can be used to set an index online or off-line.

Property NameDescription
HTTP Methodput
SDK Method NameupdateIndexStatus
Path parameters
  • indexName (required) : Index Name
  • status (required) : offline / online
Return typeupdateIndexStatusResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Returns job information

get /jobs/{jobId}

Property NameDescription
HTTP Methodget
SDK Method NamegetJob
Path parameters
  • jobId (required) : Job ID
Return typegetJobResponse
Responses
  • 0 : Job

[ Jump to Methods ]


Returns memory used by the server

get /memory

Property NameDescription
HTTP Methodget
SDK Method NamegetServerMemoryDetails
Return typegetServerMemoryDetailsResponse
Responses
  • 200 : OK
  • 400 : Bad Request

[ Jump to Methods ]


Ping server

get /ping

A simple endpoint which can be used to check the server is running. This is useful for checking the status of the server from a load balancer or fire-wall.

Property NameDescription
HTTP Methodget
SDK Method Nameping
Return typepingResponse
Responses
  • 200 : OK

[ Jump to Methods ]


Setup a demo index

put /setupdemo

This endpoint if useful for setting up a demo index which can be used to explore\nthe capabilities of FlexSearch. This is an in memory index which gets wiped out\non server restart.

Property NameDescription
HTTP Methodput
SDK Method NamesetupDemo
Return typesetupDemoResponse
Responses
  • 200 : OK
  • 400 : OK

[ Jump to Methods ]


Models

[ Jump to Methods ]

List of Models


OperationMessage

Represents an operational message returned from the operation. This can be used to represent both success and failure messages.

Property NameDescription

Optional Optional properties : map[String, String]

The list of key value pairs providing information about the operation.

Required message : String

The actual message returned by the operation.

Required operationCode : String

Operation Code associated with the message.

[ Jump to Models ]


CsvIndexingRequest

Represents a request which can be sent to CSV connector to index CSV data.

Property NameDescription

Required indexName : String

The name of the index on which the operation is to be performed.

Required hasHeaderRecord : Boolean

Indicates if the passed CSV file(s) has a header record

Optional Optional headers : array[String]

The headers to be used by each column. This should only be passed when there is no header in the csv file. The first column is always assumed to be id field. Make sure in your array you always offset the column names by 1 position.

Required path : String

The path of the folder or file to be indexed. The service will pick up all files with .csv extension.

[ Jump to Models ]


SqlIndexingRequest

Represents a request which can be sent to SQL connector to index SQL data

Property NameDescription

Required indexName : String

Name of the index

Required query : String

The query to be used to fetch data from SQL server

Required connectionString : String

Connection string used to connect to the server

Optional forceCreate : Boolean

Signifies if all updates to the index are create

Optional createJob : Boolean

Signifies if the connector should create a job for the task and return a jobId which can be used to check the status of the job.

[ Jump to Models ]


DuplicateDetectionRequest

Represents a request to execute dedupe against a given index and predefined query

Property NameDescription

Optional selectionQuery : String

The query that filters the records to include in the duplicate detection

Optional fileName : String

The file path of the CSV to submit for this session

Required displayName : String

The name of the field used to display the results

Optional threadCount : Integer

The number of threads on which to run the duplicate detection.

Required indexName : String

The name of the index on which the operation is to be performed.

Required predefinedQueryName : String

The name of the query used for duplication detection.

Optional maxRecordsToScan : Integer

The maximum number of records to scan for duplication detection

Optional duplicatesCount : Integer

The maximum number of duplicates to include in the result

[ Jump to Models ]


FieldsUpdateRequest

Represents a request to update a field in an index

Property NameDescription

Required Optional fields : array[field]

The list of fields containing the new properties

[ Jump to Models ]


IndexStatusResponse

Represents the response of an Index status request - tells whether an index is online, off-line, opening, etc.

Property NameDescription

Optional indexStatus : String

The status of an index The property is an enum which has the following valid values:

  • Opening
  • Recovering
  • Online
  • OnlineFollower
  • Offline
  • Closing
  • Faulted

[ Jump to Models ]


Tokenizer

Tokenizer breaks up a stream of text into tokens, where each token is a sub-sequence\r\nof the characters in the text. An analyzer is aware of the field it is configured \r\nfor, but a tokenizer is not.

Property NameDescription

Required tokenizerName : String

Name of the tokenizer

Optional Optional parameters : map[String, String]

Key value pair to be used to configure object's properties.

[ Jump to Models ]


Filter

Filters consume input and produce a stream of tokens. In most cases a filter looks \r\nat each token in the stream sequentially and decides whether to pass it along, \r\nreplace it or discard it. A filter may also do more complex analysis by looking \r\nahead to consider multiple tokens at once, although this is less common.

Property NameDescription

Required filterName : String

Name of the filter

Optional Optional parameters : map[String, String]

Key value pair to be used to configure object's properties.

[ Jump to Models ]


Analyzer

An analyzer examines the text of fields and generates a token stream.

Property NameDescription

Required analyzerName : String

Name of the analyzer

Required tokenizer : tokenizer

Optional Optional filters : array[filter]

[ Jump to Models ]


ShardConfiguration

Allows to control various Index Shards related settings.

Property NameDescription

Optional shardCount : Integer

Total number of shards to be present in the given index.

[ Jump to Models ]


IndexConfiguration

Allows to control various Index related settings.

Property NameDescription

Optional commitTimeSeconds : Integer

The amount of time in seconds that FlexSearch should wait before committing changes to the disk. This is only used if no commits have happened in the set time period otherwise CommitEveryNFlushes takes care of commits

Optional deleteLogsOnClose : Boolean

Determines whether to clear all transaction logs before closing an index. This setting is for advance use and should be left to default.

Optional commitOnClose : Boolean

Determines whether to commit first before closing an index

Optional autoCommit : Boolean

Determines whether to enable auto commit functionality or not

Optional directoryType : String

A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing. The property is an enum which has the following valid values:

  • FileSystem
  • MemoryMapped
  • Ram

Optional defaultWriteLockTimeout : Integer

The default maximum time to wait for a write lock (in milliseconds).

Optional ramBufferSizeMb : Integer

Determines the amount of RAM that may be used for buffering added documents and deletions before they are flushed to the Directory.

Optional maxBufferedDocs : Integer

The number of buffered added documents that will trigger a flush if enabled.

Optional refreshTimeMilliseconds : Integer

The amount of time in milliseconds that FlexSearch should wait before reopening index reader. This helps in keeping writing and real time aspects of the engine separate.

Optional autoRefresh : Boolean

Determines whether to enable auto refresh or not

Optional indexVersion : String

Corresponds to Lucene Index version. There will always be a default codec associated with each index version. The property is an enum which has the following valid values:

  • FlexSearch_1A
  • FlexSearch_1B

Optional allowReads : Boolean

Signifies if the index supports reading back of indexed data.

Optional allowWrites : Boolean

Signifies if the index supports modification of data.

[ Jump to Models ]


Field

s\r\nRepresents a group of fields.

Property NameDescription

Optional allowSort : Boolean

Enable sorting for the field

Required fieldName : String

Name of the field

Optional fieldType : String

Type of the field The property is an enum which has the following valid values:

  • Int
  • Double
  • Float
  • Keyword
  • Text
  • Bool
  • Date
  • DateTime
  • Stored
  • Long

Optional indexAnalyzer : String

Analyzer to be used during indexing

Optional searchAnalyzer : String

Analyzer to be used during searching

Optional similarity : String

Similarity defines the components of scoring. Similarity determines how engine weights terms. FlexSearch interacts with Similarity at both index-time and query-time. The property is an enum which has the following valid values:

  • BM25
  • TFIDF

[ Jump to Models ]


HighlightOption

Used for configuring the settings for text highlighting in the search results

Property NameDescription

Optional fragmentsToReturn : Integer

Total number of fragments to return per document

Required Optional highlightedFields : array[String]

The fields to be used for text highlighting

Optional postTag : String

Post tag to represent the ending of the highlighted word

Optional preTag : String

Pre tag to represent the ending of the highlighted word

[ Jump to Models ]


SearchQuery

Search query is used for searching over a FlexSearch index. This provides a consistent syntax to execute various types of queries. The syntax is similar to the SQL syntax. This was done on purpose to reduce the learning curve.

Property NameDescription

Optional queryName : String

Unique name of the query. This is only required if you are setting up a predefined query.

Optional Optional columns : array[String]

Columns to be returned as part of results. + * - return all columns + [] - return no columns + [columnName] - return specific column

Optional count : Integer

Count of results to be returned

Optional highlights : highlightOption

Required indexName : String

Name of the index

Optional orderBy : String

Can be used to order the results by score or specific field

Optional orderByDirection : String

Can be used to determine the sort order. The property is an enum which has the following valid values:

  • Ascending
  • Descending

Optional cutOff : Double

Can be used to remove results lower than a certain threshold. This works in conjunction with the score of the top record as all the other records are filtered using the score set by the top scoring record.

Optional distinctBy : String

Can be used to return records with distinct values for the given field. Works in a manner similar to Sql distinct by clause.

Optional skip : Integer

Used to enable paging and skip certain pre-fetched results.

Required queryString : String

Query string to be used for searching

Optional returnScore : Boolean

If true then scores are returned as a part of search result.

Optional preSearchScript : String

Script that is executed before submitting the search to Lucene. It can be used to modify the incoming Variables

Optional overridePredefinedQueryOptions : Boolean

Can be used to override the configuration saved in the predefined query with the one which is passed as the Search Query

Optional returnEmptyStringForNull : Boolean

Returns an empty string for null values saved in the index rather than the null constant

Optional Optional variables : map[String, String]

The mapping between the variable names (the ones prefixed by '@') given in the query string and their actual values

[ Jump to Models ]


Document

A document represents the basic unit of information which can be added or \r\nretrieved from the index. A document consists of several fields. A field represents \r\nthe actual data to be indexed. In database analogy an index can be considered as \r\na table while a document is a row of that table. Like a table a FlexSearch document \r\nrequires a fix schema and all fields should have a field type.

Property NameDescription

Optional Optional fields : map[String, String]

Represents a group of fields.

Required id : String

The unique id of the document

Required indexName : String

The name of the index on which the operation is to be performed.

Optional timeStamp : Long

Represents the time at which the document was last indexed.

Optional modifyIndex : Long

Represents the operation number associated with the operation in the global order of the operations. This allows causal ordering of the events. A documents with a lower ModifyIndex can be assumed to be modified before another with a higher number. ModifyIndex is used for optimistic concurrency control.

Optional Optional highlights : array[String]

Returns any highlighted segments of the document. This will only be returned as a part of Search result.

Optional score : Double

The score associated with the document. This will only be used when documents are returned from a Search Query.

[ Jump to Models ]


Index

Options\r\nControls how much information is stored in the postings lists.

Property NameDescription

Required indexName : String

The name of the index on which the operation is to be performed.

Optional Optional fields : array[field]

Represents a group of fields.

Optional Optional predefinedQueries : array[searchQuery]

Array of Predefined Queries

Optional shardConfiguration : shardConfiguration

Allows to control various Index Shards related settings.

Optional indexConfiguration : indexConfiguration

Allows to control various Index related settings.

Optional active : Boolean

Represents if an Index is active or not?

[ Jump to Models ]


SearchResults

Represents the output of a Search Query

Property NameDescription

Optional Optional documents : array[document]

Array of Documents

Optional recordsReturned : Integer

Total number of records returned as part of the Search Query

Optional bestScore : Float

The highest score returned by any document as part of the search result.

Optional totalAvailable : Integer

The total number of documents available as part of the search query. Note the actual records returned could be lower than the total available in the index.

[ Jump to Models ]


Job

Represents a job which can be scheduled or executed on the server

Property NameDescription

Optional jobId : String

The unique ID associated with the Job

Optional totalItems : Integer

The total number of items to be processed as part of the job.

Optional processedItems : Integer

The total number of items processed so far.

Optional failedItems : Integer

The total number of items which have failed.

Optional jobStatus : String

The current status of the job. The property is an enum which has the following valid values:

  • Initializing
  • Initialized
  • InProgress
  • Completed
  • CompletedWithErrors

Optional message : String

Any operation message associated with the job.

[ Jump to Models ]


CreationId

Property NameDescription

Required id : String

[ Jump to Models ]


IndexExists

Signifies if an index exists on the server or not?

Property NameDescription

Optional exists : Boolean

Status signifying if the index exists.

[ Jump to Models ]


MemoryDetails

Property NameDescription

Optional usedMemory : Long

Optional totalMemory : Long

Optional usage : Double

[ Jump to Models ]


NoBody

Property NameDescription

[ Jump to Models ]


GetAllAnalyzersResponse

Property NameDescription

Optional Optional data : array[analyzer]

Optional error : operationMessage

[ Jump to Models ]


GetAnalyzerResponse

Property NameDescription

Optional data : analyzer

Optional error : operationMessage

[ Jump to Models ]


CreateOrUpdateAnalyzerResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


DeleteAnalyzerResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


AnalyzeText

A request object which can be used to analyze a text input using an analyzer.

Property NameDescription

Required text : String

The text to be analyzed by the analyzer.

Required analyzerName : String

The name of the analyzer.

[ Jump to Models ]


AnalyzeTextResponse

Property NameDescription

Optional Optional data : array[String]

Optional error : operationMessage

[ Jump to Models ]


GetDocumentResponse

Property NameDescription

Optional data : document

Optional error : operationMessage

[ Jump to Models ]


CreateOrUpdateDocumentResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


DeleteDocumentResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


GetDocumentsResponse

Property NameDescription

Optional data : searchResults

Optional error : operationMessage

[ Jump to Models ]


CreateDocumentResponse

Property NameDescription

Optional data : creationId

Optional error : operationMessage

[ Jump to Models ]


DeleteAllDocumentsResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


SearchResponse

Property NameDescription

Optional data : searchResults

Optional error : operationMessage

[ Jump to Models ]


GetIndexResponse

Property NameDescription

Optional data : index

Optional error : operationMessage

[ Jump to Models ]


DeleteIndexResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


GetAllIndicesResponse

Property NameDescription

Optional Optional data : array[index]

Optional error : operationMessage

[ Jump to Models ]


CreateIndexResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


IndexExistsResponse

Property NameDescription

Optional data : indexExists

Optional error : operationMessage

[ Jump to Models ]


GetIndexSizeResponse

Property NameDescription

Optional data : BigDecimal

Optional error : operationMessage

[ Jump to Models ]


RefreshIndexResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


GetStatusResponse

Property NameDescription

Optional data : indexStatusResponse

Optional error : operationMessage

[ Jump to Models ]


UpdateIndexStatusResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


UpdateIndexConfigurationResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


UpdateIndexFieldsResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


UpdateIndexPredefinedQueryResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


GetJobResponse

Property NameDescription

Optional data : job

Optional error : operationMessage

[ Jump to Models ]


GetServerMemoryDetailsResponse

Property NameDescription

Optional data : memoryDetails

Optional error : operationMessage

[ Jump to Models ]


PingResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


SetupDemoResponse

Property NameDescription

Optional data : Boolean

Optional error : operationMessage

[ Jump to Models ]


DuplicateDetectionResponse

Property NameDescription

Optional data : String

Optional error : operationMessage

[ Jump to Models ]


CsvIndexingResponse

Property NameDescription

Optional data : String

Optional error : operationMessage

[ Jump to Models ]


SqlIndexingResponse

Property NameDescription

Optional data : String

Optional error : operationMessage

[ Jump to Models ]


DataTypes

Data TypeRange
Byte0 .. 255
Integer-2,147,483,648 .. 2,147,483,647
Long-9,223,372,036,854,775,808 .. 9,223,372,036,854,775,807
Float-3.402823e38 .. 3.402823e38
Double-1.79769313486232e308 .. 1.79769313486232e308
StringA string of Unicode characters.
BooleanTrue or False.