Parâmetros CGI

Parâmetros CGI

Pesquisar parâmetros CGI

O código do formulário de pesquisa é fornecido para que você possa copiar e colar no HTML do seu site ( Design > Auto-Complete > Form Source).

Consulte Copiando o código HTML do formulário de pesquisa para o….

Também é possível definir os parâmetros listados no próprio formulário de pesquisa ou a partir de um script. Além dos parâmetros listados abaixo, você também pode usar os parâmetros de pesquisa de backend para controlar a pesquisa.

Consulte Parâmetros CGI de pesquisa de backend.

As solicitações de pesquisa consistem em um URL básico. O URL base indica qual conta o cliente está pesquisando e um conjunto de parâmetros CGI (pares de valores chave) que indicam como retornar os resultados de pesquisa desejados para a conta associada.

O URL de base é associado a uma conta específica e a um ambiente temporário ou ao vivo. Você pode solicitar vários aliases para o URL básico de seu gerente de conta. Por exemplo, uma empresa chamada Megacorp pode ter dois URLs básicos associados à conta: https://search.megacorp.com e https://stage.megacorp.com. O URL anterior pesquisa seu índice ativo e o último URL pesquisa seu índice de preparo.

Há suporte para três formatos de Parâmetros CGI. Por padrão, sua conta é configurada para separar Parâmetros CGI com ponto-e-vírgula, como no exemplo a seguir:

https://search.megacorp.com?q=shoes;page=2

Se preferir, seu gerente de conta pode configurar sua conta para usar o "E" comercial para separar os parâmetros da CGI, como no exemplo a seguir:

https://search.megacorp.com?q=shoes&page=2

Um terceiro formato, chamado de formato SEO, também é suportado, onde uma barra / é usada no lugar do separador e sinal de igual como no exemplo a seguir:

https://search.megacorp.com/q/shoes/page/2

Sempre que o formato SEO for usado para enviar uma solicitação, todos os links de saída serão retornados no mesmo formato.

Parâmetro de pesquisa guiada Exemplo Descrição
q q=string Especifica a sequência de consulta para a pesquisa. Esse parâmetro mapeia para o parâmetro de pesquisa de backend sp_q. Consulte Parâmetros CGI de pesquisa de backend.
q# q#=string A faceta (pesquisa em um determinado campo) é feita por meio de parâmetros q e x numerados. O parâmetro q define o termo que você está procurando na faceta, como denotado pelo parâmetro x numerado correspondente.
Por exemplo, se você tiver duas facetas nomeadas de tamanho e cor, poderá ter algo como q1=small;x1=size;q2=red;x2=color. Esse parâmetro mapeia para os parâmetros de pesquisa de backend sp_q_exact_#.
Consulte Parâmetros CGI da pesquisa de backend.
x# q#=string A faceta (pesquisa em um determinado campo) é feita por meio de parâmetros q e x numerados. O parâmetro q define o termo que você está procurando na faceta, como denotado pelo parâmetro x numerado correspondente.
Por exemplo, se você tiver duas facetas nomeadas de tamanho e cor, poderá ter algo como q1=small;x1=size;q2=red;x2=color. Esse parâmetro mapeia para os parâmetros de pesquisa de backend sp_x_#.
Consulte Parâmetros CGI da pesquisa de backend.
coleção collection=string Especifica a coleção a ser usada para a pesquisa. Esse parâmetro mapeia para o parâmetro de pesquisa de backend sp_k. Consulte Parâmetros CGI de pesquisa de backend.
count count=number Especifica a contagem total de resultados mostrados. O padrão é definido em Settings > Searching > Searches. . Esse parâmetro mapeia para o parâmetro de pesquisa de backend sp_c. Consulte Parâmetros CGI de pesquisa de backend.
página page=number Especifica a página de resultados que são retornados.
classificação rank=field Especifica o campo de classificação a ser usado para classificação estática. O campo deve ser um campo do tipo Classificação com relevância maior que 0. Esse parâmetro mapeia para o parâmetro de back-end sp_sr. Consulte Parâmetros CGI de pesquisa de backend.
sort sort=number Especifica a ordem de classificação.
"0" é o padrão e classifica por pontuação de relevância; "1" ordena por data; "-1" não classifica. Os usuários podem especificar um nome de campo para o valor do parâmetro sp_s . Por exemplo, sp_s=title classifica os resultados de acordo com os valores contidos no campo de título. Quando um nome de campo é usado para o valor de um parâmetro sp_s , os resultados são classificados por esse campo e depois subclassificados por relevância. Para ativar este recurso, clique em Settings > Metadata > Definitions. Na página Definições , clique em Add New Field ou em Edit para obter um nome de campo específico. Na lista suspensa Sorting, selecione Ascending ou Descending. Esse parâmetro mapeia para o parâmetro de pesquisa de backend sp_s.
Consulte Parâmetros CGI [da pesquisa de backend].(/docs/search-promote/using/appendices/c-cgiparameters.html?lang=pt-BR#reference_582E85C3886740C98FE88CA9DF7918E8).

Parâmetros CGI de pesquisa de backend

Normalmente, os clientes interagem com uma camada de apresentação chamada Pesquisa guiada. No entanto, é teoricamente possível ignorar a camada de Pesquisa guiada e interagir com a pesquisa principal de backend diretamente usando os parâmetros CGI descritos nesta página.

Você pode selecionar parâmetros CGI de pesquisa de backend na tabela a seguir:

Suporte a query única

Suporte a várias consultas

Exemplos

Descrição

1

sp_a

sp_a= string

Especifica a string do número da conta. Esse parâmetro é necessário e deve ser uma string válida de número de conta. Você pode encontrar a string do número da conta em Configurações > Opções da conta > Configurações da conta .

2

sp_advanced

sp_advanced= 0 or 1

Se sp_advanced=1 for enviado com uma consulta, todo o código entre a tag <search-if-advanced> e a tag </search-if-advanced> no modelo de pesquisa será usado para o formulário de pesquisa. Todos os códigos entre a tag <search-if-not-advanced> e a tag </search-if-not-advanced> são ignorados. Se sp_advanced=0 (ou qualquer outro valor) for enviado, o bloco de modelo <search-if-advanced> será ignorado e o bloco de modelo <search-if-not-advanced> será usado.

3

sp_c

sp_c= number

Especifica a contagem total de resultados a serem mostrados. O padrão é 10.

4

sp_context_field

sp_context_field= field

Coleta informações contextuais para o campo especificado. As informações coletadas são geradas nos resultados da pesquisa por meio da tag do modelo <search-context> . O valor padrão é body .

5

sp_d

sp_d= type

Especifica o tipo de intervalo de datas que deve ser executado. Valores possíveis para o tipo são qualquer, o que significa que não executa pesquisa por intervalo de datas, personalizado, que indica que o valor de sp_date_range deve ser usado para determinar as datas para pesquisa, e específico, que indica que os valores em sp_start_day , sp_start_month , sp_start_year , sp_end_day , sp_end_month e sp_end_year são usados para determinar o intervalo de datas a ser pesquisado. sp_d só é necessário se o formulário de pesquisa contiver a opção de pesquisar por um intervalo personalizado (por meio de sp_date_range ) ou por um intervalo de datas inicial e final específico.

6

sp_d_#

sp_d_#= type

Especifica o tipo de pesquisa de intervalo de datas a ser executada para a consulta sp_q_# correspondente. O "#" é substituído por um número entre 1 e 16 (por exemplo, sp_d_8 , se aplica à consulta numerada sp_q_8 ).

Você pode definir type como qualquer, o que significa que não executa pesquisa por intervalo de datas, personalizado, o que indica que o valor de sp_date_range_# é usado para determinar as datas a serem pesquisadas, e específico, que indica que os valores em sp_q_min_day_# , sp_q_min_month_# , sp_q_min_year_# , sp_q_max_day_# , sp_q_max_month_# devem ser usados para determinar o intervalo de datas. sp_q_max_year_# O uso de sp_d_# só é necessário se o formulário de pesquisa contiver a opção para pesquisar por um intervalo personalizado (por meio de sp_date_range_# ) ou por um intervalo de datas inicial e final específico.

7

sp_date_range

sp_date_range= number

Especifica um intervalo de datas predefinido a ser aplicado à pesquisa. Valores maiores ou iguais a zero especificam o número de dias para pesquisa antes de hoje — por exemplo, um valor "0" especifica "hoje", um valor "1" especifica "hoje e ontem", um valor "30" especifica "nos últimos 30 dias" e assim por diante.

Os valores abaixo de zero especificam um intervalo personalizado da seguinte maneira:

-1 = "Nenhum", o mesmo que especificar nenhum intervalo de datas.

-2 = "Esta semana", que pesquisa de domingo a sábado da semana atual.

-3 = "Última semana", que pesquisa de domingo a sábado da semana anterior à semana atual.

-4 = "Este mês", que pesquisa datas dentro do mês atual.

-5 = "Último mês", que pesquisa datas dentro do mês anterior ao mês atual.

-6 = "Este ano", que pesquisa datas dentro do ano atual.

-7 = "Ano passado", que pesquisa datas no ano anterior ao ano atual.

8

sp_date_range_#

sp_date_range_#= number

Especifica um intervalo de datas predefinido a ser aplicado à consulta sp_q_# correspondente. O "#" é substituído por um número entre 1 e 16 (por exemplo, sp_date_range_8 , se aplica à consulta numerada sp_q_8 ).

Valores maiores ou iguais a zero especificam o número de dias para pesquisa antes de hoje. Por exemplo, um valor 0 especifica hoje; um valor de 1 especifica hoje e ontem; um valor de 30 especifica nos últimos 30 dias e assim por diante.

Os valores abaixo de zero especificam um intervalo personalizado da seguinte maneira:

-1 = "Nenhum", o mesmo que especificar nenhum intervalo de datas.

-2 = "Esta semana", que pesquisa de domingo a sábado da semana atual.

-3 = "Última semana", que pesquisa de domingo a sábado da semana anterior à semana atual.

-4 = "Este mês", que pesquisa datas dentro do mês atual.

-5 = "Último mês", que pesquisa datas dentro do mês anterior ao mês atual.

-6 = "Este ano", que pesquisa datas dentro do ano atual.

-7 = "Ano passado", que pesquisa datas no ano anterior ao ano atual.

9

sp_dedupe_field

sp_dedupe_field= fieldname

Especifica um único campo no qual os resultados da pesquisa serão deduplicados. Todos os resultados duplicados nesse campo são removidos dos resultados da pesquisa. Por exemplo, se para sp_dedupe_field=title , somente o resultado superior de um determinado título é exibido nos resultados da pesquisa (nenhum dos dois resultados terá conteúdo de campo de título idêntico). Para campos de tipo com vários valores (lista de permissões), todo o conteúdo do campo é usado para comparação. É possível especificar apenas um campo. Um "qualificador de tabela" não é permitido no nome do campo.

10

sp_e

sp_e= number

Especifica que a expansão automática de curinga deve ocorrer para qualquer palavra da string de consulta com mais de caracteres numéricos. Em outras palavras, sp_e=5 especifica que palavras com 5 ou mais caracteres, como "query" ou "número", devem ser expandidas com o caractere curinga '*', tornando a pesquisa equivalente a uma pesquisa por "query*" ou "número*". Palavras com menos caracteres não são expandidas, portanto, uma pesquisa por "palavra" não teria expansão automática de curinga.

11

sp_e_#

sp_e_#= number

Especifica que a expansão automática de curinga ocorre para qualquer palavra da sequência de consulta sp_q_# correspondente com mais de caracteres numéricos. Em outras palavras, sp_e_2=5 especifica que as palavras com cinco ou mais caracteres na sequência de consulta sp_q_2 , como "query" ou "número", devem ser expandidas com o caractere curinga ' * ', tornando a pesquisa equivalente a uma pesquisa por "query*" ou "number*". Palavras com menos caracteres não são expandidas, portanto, uma pesquisa por "palavra" em sp_q_2 não teria expansão automática de curinga.

12

sp_end_day, sp_end_month, sp_end_year

sp_end_day= number,sp_end_month= number, sp_end_year= number

Esse triplet de valores especifica o intervalo de datas final para a pesquisa e deve ser fornecido como um conjunto.

13

sp_f

sp_f= string

Especifica o conjunto de caracteres das sequências de parâmetro de consulta (como sp_q ). Essa sequência sempre deve corresponder ao conjunto de caracteres da página que contém o formulário de pesquisa.

14

sp_field_table

sp_field_ table=table: field,field...

Define uma tabela de dados lógica que consiste em determinados campos. Por exemplo, uma tabela chamada "itens" que consiste nos campos "cor", "tamanho" e "preço" seria definida como a seguinte:

sp_field_table=items:color,size,price

As tabelas lógicas são mais úteis em conjunto com campos que têm "Listas de permissões" marcadas (em Configurações > Metadados > Definições ). Todos os parâmetros CGI e tags de modelo que assumem um nome de campo como valor podem especificar opcionalmente um nome de tabela seguido por um "." antes do nome do campo (por exemplo, sp_x_1=tablename.fieldname ).

Por exemplo, para realizar uma pesquisa por documentos que contenham um ou mais itens "vermelhos" de tamanho "grande" (onde os itens são representados como linhas paralelas de metadados), você pode usar o seguinte:

sp_q_exact_1=red&sp_x_1=items.color& sp_q_exact_2=large&sp_x_2=items.size&sp_field_table=items:color,size,price

15

sp_i

sp_i=1 sp_i=2

sp_k= string

sp_l= string

sp_q string

sp_literal= 0 or 1

sp_literal=1

sp_literal=0

sp_m= number

sp_n= number

sp_not_found_page= url

sp_p= any/all/phrase

any all phrase

phrase all sp_p

sp_p

sp_p_#= any/all/phrase

sp_q_# sp_p_8 sp_q_8 any all phrase

all phrase sp_p_# any

sp_pt= exact/equivalent/compatible

exact equivalent compatible sp_p exact sp_p all phrase equivalent sp_pt compatible

sp_pt_#= exact/equivalent/compatible

sp_q_# sp_p_8 sp_q_8 exact equivalent exact compatible sp_p_# exact sp_p_# equivalent sp_pt_# compatible

sp_q= string

sp_q_#= text

sp_q_# sp_q_1 sp_q_16

Search for: <input type="text" name="sp_q" value="great"> Search for: <input type="text" name="sp_q_1" value="books">

sp_q_day= integer value

sp_q_month= integer value

sp_q_year= integer value

sp_q_day_#= integer value

sp_q_month_#= integer value

sp_q_year_#= integer value

sp_q_day sp_q_month sp_q_year sp_q

# sp_q_day_6 sp_q_6

PublishDate

<input type="hidden" name="sp_x_1" value="PublishDate"> Search for: <input type="text" name="sp_q" value="orange">On : <input type="text" name="sp_q_day_1" size="2" value="1"> Day<input type="text" name="sp_q_month_1" size="2" value="1"> Month <input type="text" name="sp_q_year_1" size="4" value="2000"> Year 

sp_q_location=latitude/longitude OR areacode OR zipcode

sp_q_location_#= latitude/longitude OR areacode OR zipcode

sp_q_location sp_q_location_# #

sp_q_max_relevant_distance= value

sp_q_max_relevant_distance_#= value

sp_q_max_relevant_distance sp_q_max_relevant_distance_# #

sp_q_max_relevant_distance

sp_q_max_relevant_distance_#

sp_q_min_day=integer value

sp_q_min_month=integer value

sp_q_min_year=integer value

sp_q_max_day=integer value

sp_q_max_month=integer value

sp_q_max_year=integer value

sp_q_min_day_#=integer value

sp_q_min_month_#=integer value

sp_q_min_year_#=integer value

sp_q_max_day_#=integer value

sp_q_max_month_#=integer value

sp_q_max_year_#=integer value

sp_q_min_day sp_q_min_month sp_q_min_year sp_q_max_day sp_q_max_month sp_q

# sp_q_min_day_6 sp_q_6

PublishDate

<input type="hidden" name="sp_x_1" value="PublishDate">Search for: <input type="text" name="sp_q" value="orange">Between: <input type="text" name="sp_q_min_day_1" size="2" value="1"> Start Day<input type="text" name="sp_q_min_month_1" size="2" value="1"> Start Month <input type="text" name="sp_q_min_year_1" size="4" value="2000"> Start Year And: <input type="text" name="sp_q_max_day_1" size="2" value="31"> End Day <input type="text" name="sp_q_max_month_1" size="2" value="12"> End Month <input type="text" name="sp_q_max_year_1" size="4" value="2000"> End Year

sp_q_min= value

sp_q_max= value

sp_q_min_#= value

sp_q_max_#= value

sp_q_exact_#=value

sp_q_min sp_q_max sp_q_exact sp_q

# sp_q_min_8 sp_q_8

sp_q_exact_# sp_q_min_# sp_q_max_# sp_q_exact_# sp_q_min_# sp_q_max_#

sp_q_min_# sp_q_max_# sp_q_exact_# ...&sp_q_exact_1=green|red&sp_x_1=color

sp_q_nocp= 1 or 0

sp_q_nocp_#= 1 or 0

0

1

sp_q_nocp sp_q # sp_q_nocp_8 sp_q_8

sp_q_required= 1 or 0 or -1

sp_q_required_#= 1 or 0 or -1

sp_q_required sp_q

# sp_q_required_8 sp_q_8

<input type="hidden" name="sp_x_1" value="platform"> Search for: <input type="text" name="sp_q" value="calc"> Exclude: <input type="text" name="sp_q_1" value="mac win all"> <input type="hidden" name="sp_q_required_1" value="-1">

sp_redirect_ if_one_result= 0 or 1

sp_referrer= url

ro

sp_ro=body:10

sp_ro=body:9|title:9

sp_ro=title:10 title sp_ro sp_ro

sp_s= number

sp_s sp_s=title sp_s

sp_s

<input type="hidden" name="sp_s" value="artist"> <input type="hidden" name="sp_s" value="album"> <input type="hidden" name="sp_s" value="track"> Search for: <input type="text" name="sp_q" value="Music Search">

sp_field_table

sp_sr= field

sp_sr

sp_sr <input type="hidden" name="sp_sr" value="">

sp_sfvl_field= string

search-field-value-list

sp_sfvl_field

search-field-value-list

dynamic-facet-field-count dynamic-facet-field-count

sp_sfvl_df_count dynamic-facet-field-count sp_sfvl_df_count sp_sfvl_df_count

sp_sfvl_df_count sp_sfvl_df_include sp_sfvl_df_include sp_sfvl_df_count

sp_staged= 0 or 1

sp_staged=1

sp_start_day= number

sp_start_month= number

sp_start_year= number

sp_suggest_q= number

sp_suggest_q sp_q[_#]

sp_suggest_q sp_q

sp_suggest_q=1 sp_q_1

sp_t= string

sp_trace= 0 or 1

sp_stage=1

sp_w= sound-alike-enable

sp_w_control=sound-alike-control

sp_w_control

sp_w_control=0 sp_w

<input type=hidden name="sp_w_control" value="0"><input type=checkbox name="sp_w" value="exact">No Sound-Alike matching

sp_w_control=1 sp_w

<input type=hidden name="sp_w_control" value="1"><input type=checkbox name="sp_w" value="alike">Sound-Alike matching

sp_w_control sp_w

sp_x= field

sp_q sp_x

sp_x

sp_x=any sp_x

sp_x

<input type="hidden" name="sp_x" value="title"><input type="hidden" name="sp_x" value="author">Search for: <input type="text" name="sp_q" value="Great Books">

sp_x_#= field-name

sp_q_# # sp_x_8

sp_x_#

Search for: <input type="text" name="sp_q" value="great"><input type="hidden" name="sp_x_1" value="author">Search only documents written by: <input type="text" name="sp_q_1" value="Fitzgerald">

sp_x sp_x_#

<input type="hidden" name="sp_x_1" value="body"><input type="hidden" name="sp_x_1" value="keys">Search for: <input type="text" name="sp_q_1" value="flower">

Um exemplo típico de uso de parâmetros CGI de pesquisa de backend

As seguintes consultas de link iniciam uma pesquisa usando "Música" como consulta de pesquisa e usam todos os parâmetros padrão. Observe que o URL é dividido entre duas linhas para facilitar a leitura. No seu HTML, esse link deve estar em uma linha.

<a href="https://search.atomz.com/search/?sp_q=Music&sp_a=sp99999999"> 
Testing...</a>

A mesma funcionalidade geralmente é definida com um formulário:

<form action="https://search.atomz.com/search/"> 
<input size=12 name="sp_q" value="Music"><br> 
<input type=hidden name="sp_a" value="sp99999999"> 
<input type=submit value="Search"><br> 
</form>

Normalmente, você deve usar parâmetros padrão ao iniciar uma pesquisa. Dessa forma, a primeira página é mostrada, classificada por relevância, e permite que o cliente escolha outras páginas e outras opções. Se o formulário de pesquisa do site incluir opções para coleções, passe o nome da coleção como parâmetro.

Um exemplo detalhado do uso de parâmetros CGI de pesquisa de backend

As consultas de formulário a seguir exibem 25 resultados iniciando em result 10. Os resumos não são mostrados, a ordem de classificação é por data e a coleção chamada support é usada. Somente os documentos datados dos últimos 30 dias são retornados.

<form action="https://search.atomz.com/search/"> 
<input size=12 name="sp_q"><br> 
<input type=hidden name="sp_a" value="sp99999999"> 
<input type=submit value="Search"><br> 
<input type=hidden name=sp_n value=10> 
<input type=hidden name=sp_c value=25> 
<input type=hidden name=sp_m value=0> 
<input type=hidden name=sp_s value=1> 
<input type=hidden name=sp_k value="support"> 
<input type=hidden name=sp_date_range value=30> 
</form>

Nesta página