|
A Search Engine for the Semantic Web (BETA) |
 |
|
|
A Search Engine for the Semantic Web (BETA) |
|
Your intelligent software agents interact with Semantic Web Search via a simple web service that is based on the HTTP protocol. Our service is comprised of several methods each one associated with its own URL. Your agents call a method by sending a HTTP GET request to the method's URL with its arguments (if any) encoded as URL query string parameters.
Our service will process the request by executing the method on one of our servers and return the result of the method in the HTTP response. The HTTP status code of the response will indicate the success or failure of the method. A HTTP status code of 200 indicates the method call was successful and the return value (if any) is in the response body. A HTTP status code of 400 indicates the method call failed and the response body contains detailed error information. All information in the response body is described using RDF and by default is encoded using RDF/XML.
The table below lists the web service methods currently supported by Semantic Web Search.
| Method | Description |
| Query | Queries our Semantic Web Index for the documents on the Internet that contain the information described by the query condition. |
| Submit | Submits a URL of a RDF document to be added to our Semantic Web Index. |
If you are developing a Semantic Web agent using RDF Gateway then you can make use of the object-oriented interface in the SWS Library to access our service.
http://www.semanticwebsearch.com/webapi/queryThis method is called by your software agents to locate documents on the Internet that contain information you need. This method will query our Semantic Web Index for documents that contain information described by a specified query condition. The URLs, along with some additional metadata, for any documents matching the query condition are returned to your agents. You can also obtain the concise bounded description of any resources within the documents matching the query (see parameter: match).
Click here to access the human user interface to this method.
Note, any resource descriptions are returned from our cache and may differ from the resource descriptions currently available at their original source. We are not affiliated with the authors of the cached resource description nor responsible for their content.
Parameter:q | |
| Usage: | Required (single value) |
| Description: | A condition expressed in RDFQL, the language of RDF Gateway, that must be met for each document included in the results. Refer to the Query Condition Reference for details on writing query conditions. |
| Example: | {[rdf:type] ?i [rss:item]} and {[rss:description] ?i ?d} and ?d like 'google microsoft yahoo' |
Parameter:match |
|
| Usage: | Optional (single value) |
| Description: |
This parameter is used to obtain the concise bounded descriptions of the resources matched by the query.
This parameter can be used in one of two ways. The value of this parameter can be set to the name of the subject variable
from the query condition. In this usage, the concise bounded descriptions for all the resources with
a URI matching the bound value of that variable when the query is executed on the document are returned.
The value
Alternatively, this parameter can be set to the URI of
the specific resource that you want a concise bounded description of. The URI must be enclosed
in sqaure braces (
In either case, the concise bounded descriptions are returned as an XML literal value in the
|
Parameter:domain | |
| Usage: | Optional (multiple values) |
| Description: | Document must come from the domain(s) specified to be included in the result. If not specified, all domains are allowed in the result. |
| Example: | www.example.org |
Parameter:doc | |
| Usage: | Optional (single values) |
| Description: | Restricts the query to the specified document. |
| Example: | http://kwark.org/XML/foaf-famous.rdf |
Parameter:format | |
| Usage: | Optional (multiple values) |
| Description: | Document must be of the format(s) specified to be included in the result.
If not specified, all formats are allowed in the result. Valid values:
|
| Example: | http://www.intellidimension.com/namespaces/rdffind/Format_RDFXML |
Parameter:maxdate | |
| Usage: | Optional (single value) |
| Description: | Document must have last change date before the specified date to be included in the result. If not specified, there is no maximum date. The date must be specified in W3C date format. |
| Example: | 2003-12-1T12:00:00Z |
Parameter:mindate | |
| Usage: | Optional (single value) |
| Description: | Document must have last change date after the specified date to be included in the result. If not specified, there is no minimum date. The date must be specified in W3C date format. |
| Example: | 2003-12-1T12:00:00Z |
Parameter:rf | |
| Usage: | Optional (single value) |
| Description: | The format in which results will be returned (including error results).
Valid values:
|
Parameter:ps | |
| Usage: | Optional (single value) |
| Description: | The number of results returned per page. The default is 10. |
| Example: | 50 |
Parameter:continue | |
| Usage: | Optional (single value) |
| Description: |
Specifies a page token that can be used to retrieve result pages beyond the first.
If a query matches more documents than are allowed in single result page (see Parameter: ps)
then a page token is returned as part of the result. On the next call to this method, all other
parameters are set to the same values and this parameter is set to the page token
to get next page of documents that the query matched.
|
A successful call with return zero or more resources of type http://www.intellidimension.com/namespaces/rdffind/Document.
The URI of each resource is the URL of the document that contains the information that was specified in the query.
The following table details the metadata that is returned for each document.
| Property * | Description |
cacheDate | The date the document last changed in the cache. |
format | The format of the source document. Possible values include:
|
rank | The rank of the document - the higher the number the higher the rank (i.e. the more documents that reference it in some manner). |
size | The size in bytes of the document. |
tripleCount | The number of triples in the document. |
matches |
The concise bounded description for a resource in the document that was matched in the query. Each resource description is
specified as a separate property value that is encoded as a XML Literal (rdf:parseType="Literal").
|
*All properties in namespace: http://www.intellidimension.com/namespaces/rdffind/ | |
If the query matches more documents than specified by page size parameter
(see Parameter: ps) then no more than that number of documents are returned in the response.
In this case an additional resource http://www.intellidimension.com/namespaces/rdffind/Cookie is included in
the response. The value of its http://www.intellidimension.com/namespaces/rdffind/continue property is a page token. An agent
can call this method again using all the same parameter values along with the page token (see Parameter: continue)
to get the next page of documents matched by the query.
http://www.semanticwebsearch.com/webapi/submitSoftware agents can call this method to submit the URL of a RDF document to our service. The URL will be added to our regular crawling of the Internet and all of the information in the document will be added to our Semantic Web Index. The URLs of any referenced documents will also be crawled and indexed. Once a URL is crawled the information in the document can be located by calling the Query method. The Submit URL page offers a human user interface to this method.
Parameter:url
| |
| Usage: | Required (single value) |
| Description: | The URL of a RDF document to be submitted to Semantic Web Search. |
| Example: |
http://www.semanticwebsearch.com/news/news.rdf
|
The HTTP status code of the response will indicate the success or failure of a method. If a method call
fails then the HTTP status code of the response is set to 400 and a structured error is returned in the
response body using RDF. By default the response body if formatted using RDF/XML.
The structured error is a single resource of type http://www.intellidimension.com/namespaces/rdffind/Error with
properties http://www.intellidimension.com/namespaces/rdffind/number and
http://www.intellidimension.com/namespaces/rdffind/description (see example below).
| Error Number | Description |
| 50000 | No Results. |
| 50001 | Invalid Parameter. |
| 50002 | Required parameter not supplied. |
| 50003 | Too many parameter values supplied. |
| 50004 | Malformed query. |
| 50005 | Query is too unconstrained. |
| 50006 | Request Failed. |