azureCosmosDBFieldMappingOptions

Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
title_field	string	The name of the index field to use as a title.
url_field	string	The name of the index field to use as a URL.
filepath_field	string	The name of the index field to use as a filepath.
content_fields	array	The names of index fields that should be treated as content.
content_fields_separator	string	The separator pattern that content fields should use.
vector_fields	array	The names of fields that represent vector data.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/azureCosmosDBFieldMappingOptions",
  "title": "azureCosmosDBFieldMappingOptions",
  "required": [
    "content_fields",
    "vector_fields"
  ],
  "type": "object",
  "properties": {
    "title_field": {
      "type": "string",
      "description": "The name of the index field to use as a title."
    },
    "url_field": {
      "type": "string",
      "description": "The name of the index field to use as a URL."
    },
    "filepath_field": {
      "type": "string",
      "description": "The name of the index field to use as a filepath."
    },
    "content_fields": {
      "type": "array",
      "description": "The names of index fields that should be treated as content.",
      "items": {
        "type": "string"
      }
    },
    "content_fields_separator": {
      "type": "string",
      "description": "The separator pattern that content fields should use."
    },
    "vector_fields": {
      "type": "array",
      "description": "The names of fields that represent vector data.",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource."
}