- Firesearch overview
- Live tutorial
- Case studies
- Concepts
- Indexes
- Documents
- Searching
- Guides
- Deployment
- Security
- Access keys
- Solutions
- Cloud Functions
- Developer
- Client libs and SDKs
- API reference
- API Reference
- AccessKeyService
- GenerateKey
- AutocompleteService
- Complete
- CreateIndex
- DeleteDoc
- DeleteIndex
- GetIndex
- GetIndexes
- PutDoc
- GeoIndexService EXP
- CreateIndex
- DeleteDoc
- DeleteIndex
- GetIndex
- GetIndexes
- PutDoc
- Search
- IndexService
- CreateIndex
- DeleteDoc
- DeleteIndex
- GetIndex
- GetIndexes
- PutDoc
- Search
- MetaService
- CheckIndexName
- CheckIndexPath
Doc
Doc describes a document that can be searched.
{
"id": "document-1",
"searchFields": [
{
"key": "description",
"value": "This text can be searched.",
"store": true
}
],
"fields": [
{
"key": "status",
"value": "active"
}
]
}
.id
(string)
ID is the document identifier. .searchFields
(array of SearchField)
SearchFields are the searchable fields for this document. .searchFields[i].key
(string)
Key is the name of the search field.
Cannot begin with an underscore. .searchFields[i].value
(string)
Value is the searchable text field. .searchFields[i].store
(bool)
Store tells Firesearch to store this value
and return it in the search results.
By default, although the field is searchable,
the original value is not stored. .fields
(array of Field)
Fields are the key/value pairs that make up this document.
Fields can be returned in search results, and may be filtered. .fields[i].key
(string)
Key is the name of the field.
Cannot begin with an underscore. .fields[i].value
(any)
Value is the filterable value of this Field. Documentation
- Firesearch overview
- Live tutorial
- Case studies
- Concepts
- Indexes
- Documents
- Searching
- Guides
- Deployment
- Security
- Access keys
- Solutions
- Cloud Functions
- Developer
- Client libs and SDKs
- API reference
- API Reference
- AccessKeyService
- GenerateKey
- AutocompleteService
- Complete
- CreateIndex
- DeleteDoc
- DeleteIndex
- GetIndex
- GetIndexes
- PutDoc
- GeoIndexService EXP
- CreateIndex
- DeleteDoc
- DeleteIndex
- GetIndex
- GetIndexes
- PutDoc
- Search
- IndexService
- CreateIndex
- DeleteDoc
- DeleteIndex
- GetIndex
- GetIndexes
- PutDoc
- Search
- MetaService
- CheckIndexName
- CheckIndexPath