Metadata

Manage Metadata

Listing fields for RAG search

get

Returns a list of fields that can be used to create embeddings for RAG search.

Required scopes

This endpoint requires the following scopes:

• : Needed to read AI agents.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

typestring · enumRequired

Rag Entity Type.

Possible values:

Responses

200

List of fields for RAG search.

application/json

string[]Optional

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

get

/ai-rag-indexer/{tenant}/{type}/rag-metadata

HTTPcURLJavaScriptPython

GET /ai-rag-indexer/{tenant}/{type}/rag-metadata HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "code",
  "id",
  "labels",
  "labels.description",
  "labels.description.de",
  "labels.description.en",
  "labels.id",
  "labels.name",
  "mixins",
  "mixins.additionalattributes",
  "mixins.additionalattributes.temperature",
  "name",
  "name.de",
  "name.en",
  "published",
  "segmentIds"
]

Listing fields for vector search filtering

get

Retrieves alist of fields which can be used for vector search filtering. Filtering is applied before RAG retrieval stage.

Required scopes

This endpoint requires the following scopes:

• : Needed to read AI agents.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

typestring · enumRequired

Rag Entity Type.

Possible values:

Responses

200

List of fields for vector search filter.

application/json

keystringOptional

Unique identifier of the fields. It contains full field path.

namestringOptional

Name of the field.

descriptionstringOptional

Description of the field.

typestring · enumOptional

Type of the field.

Possible values:

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

get

/ai-rag-indexer/{tenant}/{type}/filter-metadata

HTTPcURLJavaScriptPython

GET /ai-rag-indexer/{tenant}/{type}/filter-metadata HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "key": "code",
    "type": "string"
  },
  {
    "key": "id",
    "type": "string"
  },
  {
    "key": "published",
    "type": "boolean"
  },
  {
    "key": "segmentIds",
    "type": "list"
  }
]