Gleanex.Indexing.CustomMetadata (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to custom metadata

Summary

Functions

custom_metadata_schema_group_name_delete(groupName, opts \\ [])

@spec custom_metadata_schema_group_name_delete(
  groupName :: String.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.SuccessResponse.t()} | {:error, Gleanex.Error.t()}

Remove metadata schema

Deletes the schema definition for a metadata group. This does not delete existing metadata values on documents.

custom_metadata_schema_group_name_get(groupName, opts \\ [])

@spec custom_metadata_schema_group_name_get(
  groupName :: String.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.CustomMetadataSchema.t()} | {:error, Gleanex.Error.t()}

Retrieve metadata schema

Retrieves the current schema definition for a metadata group.

custom_metadata_schema_group_name_put(groupName, body, opts \\ [])

@spec custom_metadata_schema_group_name_put(
  groupName :: String.t(),
  body :: Gleanex.Indexing.CustomMetadataSchema.t(),
  opts :: keyword()
) :: {:ok, Gleanex.Indexing.SuccessResponse.t()} | {:error, Gleanex.Error.t()}

Create or update metadata schema

Defines or updates the schema for a metadata group. Schemas should be defined before indexing metadata.

Request Body

Content Types: application/json

document_doc_id_custom_metadata_group_name_delete(docId, groupName, opts \\ [])

@spec document_doc_id_custom_metadata_group_name_delete(
  docId :: String.t(),
  groupName :: String.t(),
  opts :: keyword()
) :: {:ok, Gleanex.Indexing.SuccessResponse.t()} | {:error, Gleanex.Error.t()}

Remove custom metadata

Removes all custom metadata for the specified metadata group from a document.

document_doc_id_custom_metadata_group_name_put(docId, groupName, body, opts \\ [])

@spec document_doc_id_custom_metadata_group_name_put(
  docId :: String.t(),
  groupName :: String.t(),
  body :: Gleanex.Indexing.CustomMetadataPutRequest.t(),
  opts :: keyword()
) :: {:ok, Gleanex.Indexing.SuccessResponse.t()} | {:error, Gleanex.Error.t()}

Add or update custom metadata

Associates custom metadata with a specific document. Custom metadata enables you to enrich documents with additional structured information that can be used for search, filtering, and faceting.

Request Body

Content Types: application/json