API облака метаданных | GroupDocs.Metadata

Просмотрите наши продукты

Are you looking for an evaluation version of a product?

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Are you having troubles in downloading?

If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.

Установка
Пакет доступен в PyPI, и его можно установить через pip, выполнив следующую команду:
pip install groupdocs-metadata-cloud

Требования

Python 3.4+
менеджер пакетов pip
Учетные данные GroupDocs Cloud — Client ID и Client Secret из панели управления

Зависимости

SDK автоматически устанавливает следующие пакеты:

Пакет	Ограничение
urllib3	>= 1.15
six	>= 1.10
certifi	—
python-dateutil	—

Быстрый старт

Получите учетные данные API

Чтобы использовать GroupDocs.Metadata Cloud, зарегистрируйтесь на GroupDocs.Cloud Dashboard и получите свой Идентификатор клиента и Секрет клиента.

Инициализируйте API

Используйте следующий код, чтобы начать использовать Cloud SDK GroupDocs.Metadata для Python:

import groupdocs_metadata_cloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create API configuration
configuration = groupdocs_metadata_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"

# Create instance of the Metadata API
metadata_api = groupdocs_metadata_cloud.MetadataApi.from_config(configuration)

Извлечь метаданные из документа

После инициализации используйте этот базовый пример для извлечения метаданных из файла в облачном хранилище:

import groupdocs_metadata_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

metadata_api = groupdocs_metadata_cloud.MetadataApi.from_keys(client_id, client_secret)

options = groupdocs_metadata_cloud.ExtractOptions()
options.file_info = groupdocs_metadata_cloud.FileInfo()
options.file_info.file_path = "documents/sample.docx"

request = groupdocs_metadata_cloud.ExtractRequest(options)
result = metadata_api.extract(request)

print("Metadata extracted successfully")

Благодаря этому краткому руководству вы можете приступить к управлению метаданными с помощью GroupDocs.Metadata Cloud в своих приложениях Python. Для получения более подробной информации посетите документацию.

Получить поддерживаемые форматы файлов

Получите полный список поддерживаемых форматов файлов, доступных через API метаданных.

import groupdocs_metadata_cloud

info_api = groupdocs_metadata_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

result = info_api.get_supported_file_formats()

for fmt in result.formats:
    print("{0} ({1})".format(fmt.file_format, fmt.extension))

Извлечение метаданных по тегу

Извлеките свойства метаданных, соответствующие определенному тегу, из документа.

import groupdocs_metadata_cloud

metadata_api = groupdocs_metadata_cloud.MetadataApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_metadata_cloud.ExtractOptions()
options.file_info = groupdocs_metadata_cloud.FileInfo()
options.file_info.file_path = "documents/sample.docx"
options.search_criteria = groupdocs_metadata_cloud.SearchCriteria(
    tag_options=groupdocs_metadata_cloud.TagOptions(
        exact_tag=groupdocs_metadata_cloud.Tag(
            name="Created",
            category="Time"
        )
    )
)

request = groupdocs_metadata_cloud.ExtractRequest(options)
result = metadata_api.extract(request)

print("Properties found: " + str(len(result.properties)))

Добавить пользовательские метаданные

Добавляйте в документ новые свойства метаданных, используя критерии поиска на основе тегов.

import groupdocs_metadata_cloud

metadata_api = groupdocs_metadata_cloud.MetadataApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_metadata_cloud.AddOptions()
options.file_info = groupdocs_metadata_cloud.FileInfo()
options.file_info.file_path = "documents/sample.docx"

add_property = groupdocs_metadata_cloud.AddProperty(
    value="Test User",
    type="String",
    search_criteria=groupdocs_metadata_cloud.SearchCriteriaWithoutValue(
        tag_options=groupdocs_metadata_cloud.TagOptions(
            exact_tag=groupdocs_metadata_cloud.Tag(
                name="Manager",
                category="Person"
            )
        )
    )
)
options.properties = [add_property]

request = groupdocs_metadata_cloud.AddRequest(options)
result = metadata_api.add(request)

print("Added count: " + str(result.added_count))

Изменить свойства метаданных

Обновите существующие свойства метаданных по критериям поиска тегов, имен или значений.

import groupdocs_metadata_cloud

metadata_api = groupdocs_metadata_cloud.MetadataApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_metadata_cloud.SetOptions()
options.file_info = groupdocs_metadata_cloud.FileInfo()
options.file_info.file_path = "documents/sample.docx"

set_property = groupdocs_metadata_cloud.SetProperty(
    new_value="NewAuthor",
    type="String",
    search_criteria=groupdocs_metadata_cloud.SearchCriteria(
        tag_options=groupdocs_metadata_cloud.TagOptions(
            exact_tag=groupdocs_metadata_cloud.Tag(
                name="Creator",
                category="Person"
            )
        )
    )
)
options.properties = [set_property]

request = groupdocs_metadata_cloud.SetRequest(options)
result = metadata_api.set(request)

print("Set count: " + str(result.set_count))

Удалить свойства метаданных

Удаление свойств метаданных из документа на основе критериев поиска.

import groupdocs_metadata_cloud

metadata_api = groupdocs_metadata_cloud.MetadataApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_metadata_cloud.RemoveOptions()
options.file_info = groupdocs_metadata_cloud.FileInfo()
options.file_info.file_path = "documents/sample.docx"
options.search_criteria = groupdocs_metadata_cloud.SearchCriteria(
    tag_options=groupdocs_metadata_cloud.TagOptions(
        exact_tag=groupdocs_metadata_cloud.Tag(
            name="Created",
            category="Time"
        )
    )
)

request = groupdocs_metadata_cloud.RemoveRequest(options)
result = metadata_api.remove(request)

print("Removed count: " + str(result.removed_count))

Получить информацию о документе

Получите сведения о документе, такие как формат, размер и количество страниц, перед обработкой метаданных.

import groupdocs_metadata_cloud

info_api = groupdocs_metadata_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_metadata_cloud.InfoOptions()
options.file_info = groupdocs_metadata_cloud.FileInfo()
options.file_info.file_path = "documents/sample.pptx"

request = groupdocs_metadata_cloud.GetInfoRequest(options)
result = info_api.get_info(request)

print("Document info retrieved successfully")

Примеры SDK на GitHub

Репозиторий GroupDocs.Metadata Cloud Python SDK включает модульные тесты и примеры использования API в папке test/apis:

Категория	Примеры
Metadata Operations	Extract, add, set, remove metadata by tag, name, or value
Info Operations	Supported file formats, document information
Storage & Files	Storage API, file upload/download, folder management
Authentication	API configuration and authentication

Дополнительные примеры на основе сценариев доступны в репозитории образцов .NET.

Как запустить тесты SDK

Клонируйте репозиторий Python SDK.
Установите зависимости: pip install groupdocs-metadata-cloud
Настройте учетные данные в test/test_settings.py
Запустите тесты из корня репозитория: python -m unittest Discover Test

Для получения более подробной информации посетите Начало работы.