Get Started
Indexing
- Get Started
- Guides
- Authentication
- Datasources
- Documents
- Debugging
- API Reference
- OpenAPI Spec
Client
- Get Started
- Guides
- Search
- Governance
- API Reference
- Activity
- Announcements
- Answers
- Authentication
- Chat
- Agents
- Collections
- Documents
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Verification
- Tools
- Governance
- OpenAPI Spec
Web SDK
- Get Started
- Components
- Guides
Actions
- Get Started
- Examples
Search
Search the index (admin)
Retrieves results for search query without respect for permissions. This is available only to privileged users.
POST
/
rest
/
api
/
v1
/
adminsearch
from glean import Glean, models
from glean.utils import parse_datetime
import os
with Glean(
api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:
res = g_client.client.search.query_as_admin(query="vacation policy", tracking_token="trackingToken", source_document=models.Document(
container_document=models.Document(
parent_document=models.Document(
metadata=models.DocumentMetadata(
datasource="datasource",
object_type="Feature Request",
container="container",
parent_id="JIRA_EN-1337",
mime_type="mimeType",
document_id="documentId",
create_time=parse_datetime("2000-01-23T04:56:07.000Z"),
update_time=parse_datetime("2000-01-23T04:56:07.000Z"),
author=models.Person(
name="name",
obfuscated_id="<id>",
),
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
custom_data={
"someCustomField": models.CustomDataValue(),
},
),
),
),
), page_size=10, max_snippet_size=400, input_details={
"has_copy_paste": True,
}, request_options=models.SearchRequestOptions(
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="article",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="document",
relation_type=models.RelationType.EQUALS,
),
],
),
models.FacetFilter(
field_name="department",
values=[
models.FacetFilterValue(
value="engineering",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_bucket_size=723824,
), timeout_millis=5000, people=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
])
# Handle response
print(res)
{
"trackingToken": "trackingToken",
"suggestedSpellCorrectedQuery": "suggestedSpellCorrectedQuery",
"hasMoreResults": true,
"errorInfo": {
"errorMessages": [
{
"source": "gmail",
"errorMessage": "invalid token"
},
{
"source": "slack",
"errorMessage": "expired token"
}
]
},
"requestID": "5e345ae500ff0befa2b9d1a3ba0001737e7363696f312d323535323137000171756572792d656e64706f696e743a323032303031333074313830343032000100",
"results": [
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://www.example.com/"
},
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://www.example.com/"
}
],
"facetResults": [
{
"buckets": [
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
},
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
}
],
"sourceName": "sourceName",
"operatorName": "operatorName",
"objectType": "objectType"
},
{
"buckets": [
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
},
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
}
],
"sourceName": "sourceName",
"operatorName": "operatorName",
"objectType": "objectType"
}
],
"rewrittenQuery": "rewrittenQuery",
"rewrittenFacetFilters": [
{
"fieldName": "fieldName",
"values": [
"fieldValues",
"fieldValues"
]
},
{
"fieldName": "fieldName",
"values": [
"fieldValues",
"fieldValues"
]
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Admin search request
The body is of type object
.
Response
200
application/json
OK
The response is of type object
.
from glean import Glean, models
from glean.utils import parse_datetime
import os
with Glean(
api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:
res = g_client.client.search.query_as_admin(query="vacation policy", tracking_token="trackingToken", source_document=models.Document(
container_document=models.Document(
parent_document=models.Document(
metadata=models.DocumentMetadata(
datasource="datasource",
object_type="Feature Request",
container="container",
parent_id="JIRA_EN-1337",
mime_type="mimeType",
document_id="documentId",
create_time=parse_datetime("2000-01-23T04:56:07.000Z"),
update_time=parse_datetime("2000-01-23T04:56:07.000Z"),
author=models.Person(
name="name",
obfuscated_id="<id>",
),
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
custom_data={
"someCustomField": models.CustomDataValue(),
},
),
),
),
), page_size=10, max_snippet_size=400, input_details={
"has_copy_paste": True,
}, request_options=models.SearchRequestOptions(
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="article",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="document",
relation_type=models.RelationType.EQUALS,
),
],
),
models.FacetFilter(
field_name="department",
values=[
models.FacetFilterValue(
value="engineering",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_bucket_size=723824,
), timeout_millis=5000, people=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
])
# Handle response
print(res)
{
"trackingToken": "trackingToken",
"suggestedSpellCorrectedQuery": "suggestedSpellCorrectedQuery",
"hasMoreResults": true,
"errorInfo": {
"errorMessages": [
{
"source": "gmail",
"errorMessage": "invalid token"
},
{
"source": "slack",
"errorMessage": "expired token"
}
]
},
"requestID": "5e345ae500ff0befa2b9d1a3ba0001737e7363696f312d323535323137000171756572792d656e64706f696e743a323032303031333074313830343032000100",
"results": [
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://www.example.com/"
},
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://www.example.com/"
}
],
"facetResults": [
{
"buckets": [
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
},
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
}
],
"sourceName": "sourceName",
"operatorName": "operatorName",
"objectType": "objectType"
},
{
"buckets": [
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
},
{
"percentage": 5,
"count": 1,
"value": {
"stringValue": "stringValue",
"integerValue": 5
}
}
],
"sourceName": "sourceName",
"operatorName": "operatorName",
"objectType": "objectType"
}
],
"rewrittenQuery": "rewrittenQuery",
"rewrittenFacetFilters": [
{
"fieldName": "fieldName",
"values": [
"fieldValues",
"fieldValues"
]
},
{
"fieldName": "fieldName",
"values": [
"fieldValues",
"fieldValues"
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.