README

这是一个Laravel服务提供者，用于在Laravel应用程序中轻松集成Alchemy API for PHP。

安装

可以通过在项目的composer.json中要求lexismith/laravel-alchemy包来通过Composer安装Alchemy服务提供者。

	{
		"require": {
			"lexismith/laravel-alchemy": "dev-master"
		}
	}

然后运行composer update

php composer.phar update

要使用Alchemy服务提供者，您必须在启动Laravel应用程序时注册提供者。

在config/app.php中找到providers键并注册服务提供者。

    'providers' => array(
        // ...
    		'LexiSmith\LaravelAlchemy\AlchemyServiceProvider',
    )

在config/app.php中找到aliases键并添加Alchemy外观别名。

    'aliases' => array(
        // ...
        'Alchemy' 	=> 'LexiSmith\LaravelAlchemy\AlchemyFacade',
    )

配置

默认情况下，该包使用以下环境变量来自动配置插件而不做修改

API_KEY
BASE_URL

要自定义配置文件，请使用Artisan发布包配置。

php artisan vendor:publish

在生成的app/config/alchemy.php配置文件中更新您的设置或通过在.env中相应地编辑环境变量。

return [
		'url' => env('ALCHEMY_URL', 'http://access.alchemyapi.com/calls'),
		'key' => env('ALCHEMY_API_KEY')
];

使用方法

所有函数都接受三个参数

1. $flavor用于描述传递的内容类型。对于每个函数，给出了$flavor的选项。
2. $data以$flavor的形式给出。
3. $options指定了每个特定函数的选项，如下所述。

情感

为测试、URL或HTML标记概念。有关更多信息，请参阅概述或文档。

	$emotions = Alchemy::emotion($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• maxRetrieve -> 获取的最大概念数（默认：8）
• linkedData -> 包括链接数据，0：禁用，1：启用（默认）
• showSourceText -> 0：禁用（默认），1：启用

实体

提取文本、URL或HTML的实体。有关更多信息，请参阅概述或文档。

	$emotions = Alchemy::entities($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• disambiguate -> 区分实体（即公司Apple与水果apple）。0：禁用，1：启用（默认）
• linkedData -> 在区分的实体上包括链接数据。0：禁用，1：启用（默认）
• coreference -> 解析共指（即对应于命名实体的代词）。0：禁用，1：启用（默认）
• quotations -> 通过实体提取引文。0：禁用（默认），1：启用。
• sentiment -> 分析每个实体的情感。0：禁用（默认），1：启用。启用时需要1个额外的API事务。
• showSourceText -> 0：禁用（默认），1：启用
• maxRetrieve -> 获取的最大实体数（默认：50）

关键词

提取文本、URL或HTML的关键词。有关更多信息，请参阅概述或文档。

	$emotions = Alchemy::keywords($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• keywordExtractMode -> normal（默认），strict
• 情感分析 -> 对每个关键词进行情感分析。0：禁用（默认），1：启用。启用时需要额外1次API事务。
• showSourceText -> 0：禁用（默认），1：启用。
• maxRetrieve -> 返回的关键词最大数量（默认：50）

概念

对文本、URL或HTML中的概念进行标记。更多信息请参阅概述或文档。

	$emotions = Alchemy::keywords($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• maxRetrieve -> 获取的最大概念数（默认：8）
• linkedData -> 包括链接数据，0：禁用，1：启用（默认）
• showSourceText -> 0：禁用（默认），1：启用

情感

对文本、URL或HTML进行情感分析。更多信息请参阅概述或文档。

	$emotions = Alchemy::sentiment($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• showSourceText -> 0：禁用（默认），1：启用

目标情感

通过文本、URL或HTML对目标短语进行情感分析。更多信息请参阅概述或文档。

	$emotions = Alchemy::sentiment_targeted($flavor, $data, $target, $options);

额外输入

• target -> 对进行情感分析的目标单词或短语。

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• showSourceText -> 0：禁用（默认），1：启用

清洁文本

从文本、URL或HTML中提取清洁文本（移除广告、导航等）。更多信息请参阅概述或文档。

	$emotions = Alchemy::text($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• useMetadata -> 利用元描述数据，0：禁用，1：启用（默认）
• extractLinks -> 包含链接，0：禁用（默认），1：启用。

原始文本

从文本、URL或HTML中提取原始文本（包括广告、导航等）。更多信息请参阅概述或文档。

	$emotions = Alchemy::text_raw($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• 无

作者

从URL或HTML中提取作者。更多信息请参阅概述或文档。

	$emotions = Alchemy::author($flavor, $data, $options);

可用口味

• 'html'
• 'url'

可用选项

• 无

语言检测

检测文本、URL或HTML的语言。更多信息请参阅概述或文档。

	$emotions = Alchemy::language($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• 无

标题

提取URL或HTML的标题。更多信息请参阅概述或文档。

	$emotions = Alchemy::title($flavor, $data, $options);

可用口味

• 'html'
• 'url'

可用选项

• useMetadata -> 利用嵌入在元数据中的标题信息，0：禁用，1：启用（默认）

关系

从文本、URL或HTML中提取关系。更多信息请参阅概述或文档。

	$emotions = Alchemy::relations($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• sentiment -> 0：禁用（默认），1：启用。启用时需要额外1次API事务。
• keywords -> 从主语和宾语中提取关键词。0：禁用（默认），1：启用。启用时需要额外1次API事务。
• entities -> 从主语和宾语中提取实体。0：禁用（默认），1：启用。启用时需要额外1次API事务。
• requireEntities -> 仅提取具有实体的关系。0：禁用（默认），1：启用。
• sentimentExcludeEntities -> 在情感分析中排除实体全名。0：禁用，1：启用（默认）
• disambiguate -> 区分实体（即公司Apple与水果apple）。0：禁用，1：启用（默认）
• linkedData -> 包含具有明确实体的链接数据。0：禁用，1：启用（默认）。
• 同义词消解 -> 解析实体同义词。0: 禁用，1: 启用（默认）
• showSourceText -> 0：禁用（默认），1：启用。
• maxRetrieve -> 提取关系的最大数量（默认: 50，最大: 100）

数据源

检测URL或HTML中的RSS/ATOM数据源。更多信息请参考概览或文档。

	$emotions = Alchemy::feeds($flavor, $data, $options);

可用口味

• 'html'
• 'url'

可用选项

• 无

微格式

提取URL或HTML中的微格式。更多信息请参考概览或文档。

	$emotions = Alchemy::microformats($flavor, $data, $options);

可用口味

• 'html'
• 'url'

可用选项

• 无

分类法

对文本、URL或HTML进行分类法分类操作。更多信息请参考概览或文档。

	$emotions = Alchemy::taxonomy($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• showSourceText -> 在API响应中包含提取分类法类别所依据的原始'源文本'。1: 启用，0: 禁用（默认）
• sourceText -> 获取此API调用将处理文本的位置。--* cleaned_or_raw : 启用清理，当清理无文本时回退到原始文本（默认）--* cleaned : 对'清理'网页文本进行操作（启用网页清理）--* raw : 对原始网页文本进行操作（禁用网页清理）--* cquery : 对视觉约束查询的结果进行操作。注意：'cquery' http参数也必须设置为有效的视觉约束查询。--* xpath : 对XPath查询的结果进行操作。注意：'xpath' http参数也必须设置为有效的XPath查询。
• cquery -> 应用到网页的视觉约束查询。
• xpath -> 应用到网页的XPath查询。
• baseUrl -> rel-tag输出的基本http URL（必须进行uri-argument编码）

组合调用

实体、关键词、标题、作者、分类法的组合调用。更多信息请参考概览或文档。

	$emotions = Alchemy::combined($flavor, $data, $options);

可用口味

• 'text'
• 'html'
• 'url'

可用选项

• extract -> 可能的值：实体、关键词、标题、作者、分类法（默认：实体、关键词、分类法、概念）
• disambiguate -> 解析检测到的实体。1: 启用（默认），0: 禁用
• linkedData -> 在解歧实体时包含Linked Data内容链接。1: 启用（默认），0: 禁用
• coreference -> 将he/she等同义词解析为检测到的实体。1: 启用（默认），0: 禁用
• quotations -> 启用引语提取。1: 启用，0: 禁用（默认）
• sentiment -> 启用实体级情感分析。1: 启用，0: 禁用（默认）
• showSourceText -> 在API响应中包含实体提取所依据的原始'源文本'。1: 启用，0: 禁用（默认）
• maxRetrieve -> 提取命名词体的最大数量。默认: 50
• baseUrl -> rel-tag输出的基本http URL

链接

• Alchemy语言
• Alchemy API for PHP
• Laravel网站
• 许可