neclimdul/coveo-search-api

Coveo Search API 文档

维护者

详细信息

gitlab.com/neclimdul/coveosearchapi-php

主页

源代码

问题

安装: 3

依赖: 0

建议者: 0

安全: 0

星标: 0

分支: 0

1.1.0 2024-09-24 15:38 UTC

Requires

Requires (Dev)

MIT 281f08203be10114e4b2f481ab93a5a66da30306

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2024-09-24 20:51:29 UTC

README

Coveo Search API 文档

安装与使用

要求

PHP 8.1 及以上。

Composer

要通过 Composer 安装绑定，请在 composer.json 中添加以下内容

composer require neclimdul/coveo-search-api

入门指南

请按照 安装流程 进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use NecLimDul\Coveo\SearchApi\ApiException;

// Configure OAuth2 access token for authorization: oauth2
$config = \NecLimDul\Coveo\SearchApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new \NecLimDul\Coveo\SearchApi\Api\AnalysisV3Api(
    // If you want to use custom http client, pass your client which implements `\GuzzleHttp\ClientInterface`.
    // This is optional, `\GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$parse_query_expression_to_structured_request = new \NecLimDul\Coveo\SearchApi\Model\ParseQueryExpressionToStructuredRequest(); // \NecLimDul\Coveo\SearchApi\Model\ParseQueryExpressionToStructuredRequest | The query expression to parse and convert
$organization_id = mycoveocloudv2organization; // string | The unique identifier of the target Coveo Cloud organization.  Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.

try {
    $result = $apiInstance->parseExpressionToStructured($parse_query_expression_to_structured_request, $organization_id);
    print_r($result);
} catch (ApiException $e) {
    echo 'Exception when calling AnalysisV3Api->parseExpressionToStructured: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都相对于 https://platform.cloud.coveo.com

类方法HTTP 请求描述
AnalysisV3ApiparseExpressionToStructuredPOST /rest/search/v3/analysis/expressions/structured将查询转换为结构化表达式
AnalysisV3ApireplayPOST /rest/search/v3/analysis/inspect/replay使用检查详情重新播放查询
ConditionsApibulkGetConditionsPOST /rest/search/v1/admin/pipelines/statements/bulkGet列出条件语句
ConditionsApicreateConditionPOST /rest/search/v1/admin/pipelines/statements创建条件语句
ConditionsApigetConditionGET /rest/search/v1/admin/pipelines/statements/{statementId}获取条件语句
ConditionsApilistConditionsGET /rest/search/v1/admin/pipelines/statements列出条件语句
ConditionsApiupdateConditionPUT /rest/search/v1/admin/pipelines/statements/{statementId}更新条件语句
ConditionsApivalidatePipelineConditionOperationPOST /rest/search/v1/admin/pipelines/statements/validate验证单个管道条件操作
ConditionsApivalidatePipelineConditionOperationsPOST /rest/search/v1/admin/pipelines/statements/validate/batch验证一批管道条件操作
DebugApidebugExpandedUserIdsGET /rest/search/debug/expandedUserIds获取扩展的用户 ID
FeaturedResultsApibulkGetFeaturedResultsPOST /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules/bulkGet已弃用 - 获取特色结果规则的列表
FeaturedResultsApicreateNewFeaturedResultRulePOST /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules已弃用 - 创建新的特色结果规则
FeaturedResultsApideleteFeaturedResultRuleDELETE /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules/{featuredResultId}已弃用 - 删除特色结果规则
FeaturedResultsApigetFeaturedResultRuleV2GET /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules/{featuredResultId}已弃用 - 获取特色结果规则
FeaturedResultsApilistFeaturedResultRulesV2GET /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules已弃用 - 获取特色结果规则的列表
FeaturedResultsApiupdateFeaturedResultRulePUT /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules/{featuredResultId}已弃用 - 更新特色结果规则
FeaturedResultsApivalidateFeaturedResultsOperationPOST /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules/validate已弃用 - 验证单个特色结果操作
FeaturedResultsApivalidateFeaturedResultsOperationsPOST /rest/search/v2/admin/pipelines/{pipelineId}/featuredResultRules/validate/batch已弃用 - 验证一批特色结果操作
MachineLearningAssociationsApiassociateModelPOST /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations将现有机器学习模型与现有管道关联
MachineLearningAssociationsApibulkGetAssociationsOfPipelinePOST /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/bulkGet列出查询管道的 ML 模型关联
MachineLearningAssociationsApidisassociateDELETE /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}删除查询管道的 ML 模型关联
MachineLearningAssociationsApigetAssociationGET /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}获取机器学习模型关联
MachineLearningAssociationsApilistAssociationsOfPipelineGET /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations列出查询管道的 ML 模型关联
MachineLearningAssociationsApimlVersionGET /rest/search/v2/admin/pipelines/ml/version返回请求组织中支持的机器学习模型版本。
MachineLearningAssociationsApiupdateAssociationPUT /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}更新机器学习模型关联
MachineLearningAssociationsApiupdateAssociationPositionPUT /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}/position更新机器学习模型关联位置
MachineLearningAssociationsApivalidateMlAssociationOperationPOST /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/validate验证单个机器学习模型关联操作。
MachineLearningAssociationsApivalidateMlAssociationOperationsPOST /rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/validate/batch验证一批机器学习模型关联操作。
OrganizationsApiaddTrustedUriPOST /rest/organizations/{organizationId}/authentication/trusteduris添加受信任的搜索页面URI
OrganizationsApicreateSamlAuthenticationPOST /rest/organizations/{organizationId}/authentication/saml在组织中创建新的SAML身份验证
OrganizationsApicreateSharepointAuthenticationProviderPOST /rest/organizations/{organizationId}/authentication/sharepoint创建SharePoint声明身份验证提供程序
OrganizationsApideleteSamlAuthenticationDELETE /rest/organizations/{organizationId}/authentication/saml/{id}从组织中删除SAML身份验证
OrganizationsApideleteSharepointAuthenticationProviderDELETE /rest/organizations/{organizationId}/authentication/sharepoint/{id}删除SharePoint声明身份验证提供程序
OrganizationsApideleteTrustedUriDELETE /rest/organizations/{organizationId}/authentication/trusteduris/{id}删除受信任的搜索页面URI
OrganizationsApigetRecentUntrustedUrisGET /rest/organizations/{organizationId}/authentication/trusteduris/recentuntrusted列出最近看到的未受信任的搜索页面URI。
OrganizationsApigetSharepointAuthenticationProviderGET /rest/organizations/{organizationId}/authentication/sharepoint/{id}获取SharePoint声明身份验证提供程序
OrganizationsApigetTrustedUrisGET /rest/organizations/{organizationId}/authentication/trusteduris列出受信任的搜索页面URI
OrganizationsApilistAuthenticationsGET /rest/organizations/{organizationId}/authentication列出组织中的所有身份验证提供程序
OrganizationsApilistSamlAuthenticationsGET /rest/organizations/{organizationId}/authentication/saml列出组织中的SAML身份验证
OrganizationsApilistSharepointClaimsAuthProviderGET /rest/organizations/{organizationId}/authentication/sharepoint列出SharePoint声明身份验证提供程序
OrganizationsApiloadSamlAuthenticationGET /rest/organizations/{organizationId}/authentication/saml/{id}从组织中加载单个SAML身份验证
OrganizationsApiupdateSamlAuthenticationPUT /rest/organizations/{organizationId}/authentication/saml/{id}更新组织中的SAML身份验证
OrganizationsApiupdateSharepointAuthenticationProviderPUT /rest/organizations/{organizationId}/authentication/sharepoint/{id}更新SharePoint声明身份验证提供程序
PassagesApirestSearchAlphaPassagesRetrievePostPOST /rest/search/alpha/passages/retrieve检索特定查询的段落。（Alpha）
PipelinesApibulkGetPipelinesPOST /rest/search/v1/admin/pipelines/bulkGet列出查询管道
PipelinesApicreateQueryPipelineV1POST /rest/search/v1/admin/pipelines创建查询管道
PipelinesApideleteConditionDELETE /rest/search/v1/admin/pipelines/statements/{statementId}删除条件语句
PipelinesApideleteQueryPipelineDELETE /rest/search/v1/admin/pipelines/{pipelineId}删除查询管道
PipelinesApigetQueryPipelineV1GET /rest/search/v1/admin/pipelines/{pipelineId}获取查询管道
PipelinesApiimportQueryPipelineStatementsPOST /rest/search/v1/admin/pipelines/{pipelineId}/statements/import导入查询管道语句
PipelinesApilistQueryPipelinesV1GET /rest/search/v1/admin/pipelines列出查询管道
PipelinesApiswapQueryPipelineNamesPOST /rest/search/v1/admin/pipelines/{pipelineId}/swap交换查询管道名称
PipelinesApiupdateQueryPipelinePUT /rest/search/v1/admin/pipelines/{pipelineId}更新查询管道
PipelinesApiv1CopyQueryPipelinePOST /rest/search/v1/admin/pipelines/{pipelineId}/duplicate复制查询管道
PipelinesApivalidatePipelineOperationPOST /rest/search/v1/admin/pipelines/validate验证单个管道操作。
PipelinesApivalidatePipelineOperationsPOST /rest/search/v1/admin/pipelines/validate/batch验证批量管道操作。
ResultRankingsApibulkDeleteRankingRulesPOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/bulkDelete从管道中批量删除结果排名规则。
ResultRankingsApibulkGetResultRankingOperationPOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/bulkGet获取结果排名规则的列表。
ResultRankingsApicopyResultRankingRulePOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/copy将结果排名规则复制到管道。
ResultRankingsApicreateResultRankingRulePOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings创建新的结果排名规则。
ResultRankingsApideleteResultRankingRuleDELETE /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/{resultRankingId}删除结果排名规则。
ResultRankingsApiduplicateResultRankingRulePOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/duplicate/{resultRankingId}复制结果排名规则。
ResultRankingsApigetResultRankingRuleGET /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/{resultRankingId}获取结果排名规则。
ResultRankingsApilistResultRankingRulesGET /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings获取结果排名规则的列表。
ResultRankingsApiupdateResultRankingRulePUT /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/{resultRankingId}更新结果排名规则。
ResultRankingsApivalidateResultRankingOperationPOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/validate验证单个结果排名操作。
ResultRankingsApivalidateResultRankingOperationsPOST /rest/search/v2/admin/pipelines/{pipelineId}/resultRankings/validate/batch验证批量结果排名操作。
SearchV2ApidataStreamGET /rest/search/v2/datastream获取项目数据流。
SearchV2ApidocumentGET /rest/search/v2/document以JSON格式获取项目。
SearchV2ApiextensionsGET /rest/search/v2/extensions列出可用的查询扩展。
SearchV2ApifacetSearchPOST /rest/search/v2/facet发送分面搜索请求。
SearchV2ApifieldsGET /rest/search/v2/fields列出所有字段。
SearchV2ApifindFieldsFromExpressionPOST /rest/search/v2/fields/find从查询表达式的结果中查找字段。
SearchV2ApihtmlGetGET /rest/search/v2/html获取HTML项目预览。
SearchV2ApihtmlPostPOST /rest/search/v2/html获取HTML项目预览。
SearchV2ApiloginGET /rest/search/v2/login/{provider}登录到身份验证提供者。
SearchV2ApiloginProviderPostPOST /rest/search/v2/login/{provider}登录到身份验证提供者。
SearchV2ApiplanSearchUsingGetGET /rest/search/v2/plan计划搜索执行。
SearchV2ApiplanSearchUsingPostPOST /rest/search/v2/plan计划搜索执行。
SearchV2ApiquerySuggestGetGET /rest/search/v2/querySuggest请求查询建议。
SearchV2ApiquerySuggestPostPOST /rest/search/v2/querySuggest请求查询建议。
SearchV2ApiratingPOST /rest/search/v2/rating更新用户评分。
SearchV2ApisearchUsingGetGET /rest/search/v2发送搜索请求。
SearchV2ApisearchUsingPostPOST /rest/search/v2发送搜索请求。
SearchV2ApitextGET /rest/search/v2/text以文本格式获取项目。
SearchV2ApitokenPOST /rest/search/v2/token创建搜索令牌。
SearchV2ApivaluesBatchGetGET /rest/search/v2/values/batch获取多个字段的值。
SearchV2ApivaluesBatchPostPOST /rest/search/v2/values/batch获取多个字段的值。
SearchV2ApivaluesGetGET /rest/search/v2/values获取单个字段的值。
SearchV2ApivaluesPostPOST /rest/search/v2/values获取单个字段的值。
SearchV3ApisearchUsingPostV3POST /rest/search/v3发送搜索请求。
StatementGroupsApibulkGetStatementGroupsOperationPOST /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/bulkGet列出管道的语句组。
StatementGroupsApicreateStatementGroupPOST /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups创建新的语句组。
StatementGroupsApideleteAStatementGroupOfAPipelineDELETE /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}删除管道的语句组
StatementGroupsApigetAStatementGroupOfAPipelineGET /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}获取管道的语句组
StatementGroupsApigetFeatureActiveStateGET /rest/search/admin/pipelines/featureActiveState返回所有管道功能和它们是否激活的列表。
StatementGroupsApilistStatementGroupsGET /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups列出管道的语句组。
StatementGroupsApistatementGroupsAssociationsDissociatePOST /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/associations/dissociate解除与组关联的管道规则
StatementGroupsApitoggleAPermanentGroupPATCH /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}切换永久组
StatementGroupsApiupdateAStatementGroupPUT /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}更新语句组
StatementGroupsApiupdateStatementGroupsAssociationsPUT /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}/associations更新与语句组关联的规则
StatementGroupsApivalidateStatementGroupOperationPOST /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/validate验证单个语句组操作。
StatementGroupsApivalidateStatementGroupsOperationsPOST /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/validate/batch验证语句组操作批量。
StatementsV1ApibulkGetStatementsOperationV1POST /rest/search/v1/admin/pipelines/{pipelineId}/statements/bulkGet列出查询管道语句
StatementsV1ApicreateQueryPipelineStatementPOST /rest/search/v1/admin/pipelines/{pipelineId}/statements创建查询管道语句
StatementsV1ApideleteQueryPipelineStatementDELETE /rest/search/v1/admin/pipelines/{pipelineId}/statements/{statementId}删除查询管道语句
StatementsV1ApigetQueryPipelineStatementGET /rest/search/v1/admin/pipelines/{pipelineId}/statements/{statementId}获取查询管道语句
StatementsV1ApilistQueryPipelineStatementsGET /rest/search/v1/admin/pipelines/{pipelineId}/statements列出查询管道语句
StatementsV1ApimoveQueryPipelineStatementPUT /rest/search/v1/admin/pipelines/{pipelineId}/statements/{statementId}/move移动查询管道语句
StatementsV1ApiupdateQueryPipelineStatementV1PUT /rest/search/v1/admin/pipelines/{pipelineId}/statements/{statementId}更新查询管道语句
StatementsV1Apiv1CopyQueryPipelineStatementsPOST /rest/search/v1/admin/pipelines/{pipelineId}/statements/copy复制查询管道语句
StatementsV1Apiv1ExportQueryPipelineStatementsGET /rest/search/v1/admin/pipelines/{pipelineId}/statements/export导出查询管道语句
StatementsV1ApivalidateStatementOperationV1POST /rest/search/v1/admin/pipelines/{pipelineId}/statements/validate验证单个语句操作。
StatementsV1ApivalidateStatementsOperationsV1POST /rest/search/v1/admin/pipelines/{pipelineId}/statements/validate/batch验证语句操作批量。
StatementsV2ApibulkDeleteStatementsPOST /rest/search/v2/admin/pipelines/{pipelineId}/statements/bulkDelete批量删除查询管道语句
StatementsV2ApibulkGetStatementsOperationV2POST /rest/search/v2/admin/pipelines/{pipelineId}/statements/bulkGet列出查询管道语句
StatementsV2ApicopyQueryPipelineStatementsPOST /rest/search/v2/admin/pipelines/{pipelineId}/statements/copy复制查询管道语句
StatementsV2ApicreateQueryPipelineStatementV2POST /rest/search/v2/admin/pipelines/{pipelineId}/statements创建查询管道语句
StatementsV2ApideleteQueryPipelineStatementV2DELETE /rest/search/v2/admin/pipelines/{pipelineId}/statements/{statementId}删除查询管道语句
StatementsV2ApiexportQueryPipelineStatementsGET /rest/search/v2/admin/pipelines/{pipelineId}/statements/export导出查询管道语句
StatementsV2ApigetQueryPipelineStatementV2GET /rest/search/v2/admin/pipelines/{pipelineId}/statements/{statementId}获取查询管道语句
StatementsV2ApiimportQueryPipelineStatementsV2POST /rest/search/v2/admin/pipelines/{pipelineId}/statements/import导入查询管道语句
StatementsV2ApilistQueryPipelineStatementsV2GET /rest/search/v2/admin/pipelines/{pipelineId}/statements列出查询管道语句
StatementsV2ApimoveQueryPipelineStatementV2PUT /rest/search/v2/admin/pipelines/{pipelineId}/statements/{statementId}/move移动查询管道语句
StatementsV2ApiupdateQueryPipelineStatementPUT /rest/search/v2/admin/pipelines/{pipelineId}/statements/{statementId}更新查询管道语句
StatementsV2ApivalidateStatementOperationV2POST /rest/search/v2/admin/pipelines/{pipelineId}/statements/validate验证单个语句操作。
StatementsV2ApivalidateStatementsOperationsV2POST /rest/search/v2/admin/pipelines/{pipelineId}/statements/validate/batch验证语句操作批量。

模型

Authorization

oauth2

  • 类型: OAuth
  • 流程: 隐式
  • 授权URL: https://platform.cloud.coveo.com/oauth/authorize
  • 作用域:
    • 全部: 必要

测试

运行测试，请使用：

composer install
vendor/bin/phpunit

作者：

关于此包：

此PHP包是由OpenAPI Generator项目自动生成的

  • API版本：1.0.0
  • 构建包：org.openapitools.codegen.languages.PhpClientCodegen