Provides API endpoints related to custom metadata
Summary
Functions
Remove metadata schema
Retrieve metadata schema
Create or update metadata schema
Remove custom metadata
Add or update custom metadata
Functions
@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.
@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.
@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
@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.
@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