# CollectionSchema


## Properties

Name | Type
------------ | -------------
`name` | string
`fields` | [Array<Field>](Field.md)
`defaultSortingField` | string
`tokenSeparators` | Array<string>
`synonymSets` | Array<string>
`enableNestedFields` | boolean
`symbolsToIndex` | Array<string>
`voiceQueryModel` | [VoiceQueryModelCollectionConfig](VoiceQueryModelCollectionConfig.md)
`metadata` | object

## Example

```typescript
import type { CollectionSchema } from ''

// TODO: Update the object below with actual values
const example = {
  "name": companies,
  "fields": [{"name":"num_employees","type":"int32","facet":false},{"name":"company_name","type":"string","facet":false},{"name":"country","type":"string","facet":true}],
  "defaultSortingField": num_employees,
  "tokenSeparators": null,
  "synonymSets": null,
  "enableNestedFields": true,
  "symbolsToIndex": null,
  "voiceQueryModel": null,
  "metadata": null,
} satisfies CollectionSchema

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as CollectionSchema
console.log(exampleParsed)
```

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)