Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Chat
- Agents
- Collections
- Documents
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Verification
Answers
Create Answer
Answers
Create Answer
Create a user-generated Answer that contains a question and answer.
POST
/
rest
/
api
/
v1
/
createanswer
from datetime import date
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.answers.create(data={
"question": "Why is the sky blue?",
"body_text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"audience_filters": [
{
"field_name": "type",
"values": [
{
"value": "Spreadsheet",
"relation_type": models.RelationType.EQUALS,
},
{
"value": "Presentation",
"relation_type": models.RelationType.EQUALS,
},
],
},
],
"added_roles": [
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
related_documents=[
models.RelatedDocuments(
query_suggestion=models.QuerySuggestion(
query="app:github type:pull author:mortimer",
search_provider_info=models.SearchProviderInfo(
name="Google",
search_link_url_template="https://www.google.com/search?q={query}&hl=en",
),
label="Mortimer's PRs",
datasource="github",
request_options=models.SearchRequestOptions(
datasource_filter="JIRA",
datasources_filter=[
"JIRA",
],
query_overrides_facet_filters=True,
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_filter_sets=[
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
],
facet_bucket_size=134365,
auth_tokens=[
models.AuthToken(
access_token="123abc",
datasource="gmail",
scope="email profile https://www.googleapis.com/auth/gmail.readonly",
token_type="Bearer",
auth_user="1",
),
],
),
ranges=[
models.TextRange(
start_index=796474,
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"),
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
pins=[
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
),
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
),
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
),
],
collections=[
models.Collection(
name="<value>",
description="fumigate convection though zowie",
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
id=496323,
items=[
models.CollectionItem(
collection_id=782367,
shortcut=models.Shortcut(
input_alias="<value>",
),
item_type=models.CollectionItemItemType.URL,
),
],
),
],
interactions=models.DocumentInteractions(
reacts=[
models.Reaction(),
models.Reaction(),
models.Reaction(),
],
shares=[
models.Share(
num_days_ago=219974,
),
models.Share(
num_days_ago=449221,
),
models.Share(
num_days_ago=427887,
),
],
),
verification=models.Verification(
state=models.State.VERIFIED,
metadata=models.VerificationMetadata(
reminders=[
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
remind_at=491427,
),
],
last_reminder=models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
remind_at=490420,
),
),
),
shortcuts=[
models.Shortcut(
input_alias="<value>",
),
],
custom_data={
"someCustomField": models.CustomDataValue(),
},
),
),
),
],
input_details=models.SearchRequestInputDetails(
has_copy_paste=True,
),
),
results=[
models.SearchResult(
title="title",
url="https://example.com/foo/bar",
native_app_url="slack://foo/bar",
snippets=[
models.SearchResultSnippet(
snippet="snippet",
mime_type="mimeType",
),
],
),
],
),
models.RelatedDocuments(
query_suggestion=models.QuerySuggestion(
query="app:github type:pull author:mortimer",
search_provider_info=models.SearchProviderInfo(
name="Google",
search_link_url_template="https://www.google.com/search?q={query}&hl=en",
),
label="Mortimer's PRs",
datasource="github",
request_options=models.SearchRequestOptions(
datasource_filter="JIRA",
datasources_filter=[
"JIRA",
],
query_overrides_facet_filters=True,
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_filter_sets=[
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
],
facet_bucket_size=129663,
auth_tokens=[
models.AuthToken(
access_token="123abc",
datasource="gmail",
scope="email profile https://www.googleapis.com/auth/gmail.readonly",
token_type="Bearer",
auth_user="1",
),
],
),
input_details=models.SearchRequestInputDetails(
has_copy_paste=True,
),
),
),
],
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
query_suggestions=models.QuerySuggestionList(
suggestions=[
models.QuerySuggestion(
query="app:github type:pull author:mortimer",
label="Mortimer's PRs",
datasource="github",
),
],
),
invite_info=models.InviteInfo(
invites=[
models.ChannelInviteInfo(),
models.ChannelInviteInfo(),
],
),
custom_fields=[
models.CustomFieldData(
label="<value>",
values=[
models.CustomFieldValueStr(),
],
),
models.CustomFieldData(
label="<value>",
values=[],
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.OWNER,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
],
"removed_roles": [
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.OWNER,
),
],
"roles": [
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.OWNER,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
],
"combined_answer_text": {
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
},
})
# Handle response
print(res){
"id": 3,
"docId": "ANSWERS_answer_3",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"combinedAnswerText": {
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structuredList": [
{
"link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
"document": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
},
"text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue."
}
]
},
"likes": {
"likedBy": [
{
"user": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z"
}
],
"likedByUser": true,
"numLikes": 123
},
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"verification": {
"state": "UNVERIFIED",
"metadata": {
"lastVerifier": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"lastVerificationTs": 123,
"expirationTs": 123,
"document": {},
"reminders": [
{
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
}
],
"lastReminder": {
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
},
"visitorCount": [
{
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
],
"candidateVerifiers": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
]
}
},
"board": {
"name": "<string>",
"description": "<string>",
"addedRoles": [
{}
],
"removedRoles": [
{}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"roles": [
{}
]
},
"collections": [
{
"name": "<string>",
"description": "<string>",
"addedRoles": [
{}
],
"removedRoles": [
{}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "<string>",
"adminLocked": true,
"parentId": 123,
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"allowedDatasource": "<string>",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"childCount": 123,
"items": [
{
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{}
],
"removedRoles": [
{}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
}
],
"pinMetadata": {
"existingPins": [
{
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
],
"eligiblePins": [
{
"id": 123,
"target": {
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
}
]
},
"shortcuts": [
"<string>"
],
"children": [
"<any>"
],
"roles": [
{}
]
}
],
"documentCategory": "<string>",
"sourceDocument": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).
Auth type being used to access the endpoint (should be non-empty only for global tokens).
Body
application/json
CreateAnswer request
The body is of type object.
Response
200
application/json
OK
The response is of type object.
from datetime import date
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.answers.create(data={
"question": "Why is the sky blue?",
"body_text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"audience_filters": [
{
"field_name": "type",
"values": [
{
"value": "Spreadsheet",
"relation_type": models.RelationType.EQUALS,
},
{
"value": "Presentation",
"relation_type": models.RelationType.EQUALS,
},
],
},
],
"added_roles": [
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
related_documents=[
models.RelatedDocuments(
query_suggestion=models.QuerySuggestion(
query="app:github type:pull author:mortimer",
search_provider_info=models.SearchProviderInfo(
name="Google",
search_link_url_template="https://www.google.com/search?q={query}&hl=en",
),
label="Mortimer's PRs",
datasource="github",
request_options=models.SearchRequestOptions(
datasource_filter="JIRA",
datasources_filter=[
"JIRA",
],
query_overrides_facet_filters=True,
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_filter_sets=[
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
],
facet_bucket_size=134365,
auth_tokens=[
models.AuthToken(
access_token="123abc",
datasource="gmail",
scope="email profile https://www.googleapis.com/auth/gmail.readonly",
token_type="Bearer",
auth_user="1",
),
],
),
ranges=[
models.TextRange(
start_index=796474,
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"),
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
pins=[
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
),
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
),
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
),
],
collections=[
models.Collection(
name="<value>",
description="fumigate convection though zowie",
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
id=496323,
items=[
models.CollectionItem(
collection_id=782367,
shortcut=models.Shortcut(
input_alias="<value>",
),
item_type=models.CollectionItemItemType.URL,
),
],
),
],
interactions=models.DocumentInteractions(
reacts=[
models.Reaction(),
models.Reaction(),
models.Reaction(),
],
shares=[
models.Share(
num_days_ago=219974,
),
models.Share(
num_days_ago=449221,
),
models.Share(
num_days_ago=427887,
),
],
),
verification=models.Verification(
state=models.State.VERIFIED,
metadata=models.VerificationMetadata(
reminders=[
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
remind_at=491427,
),
],
last_reminder=models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
remind_at=490420,
),
),
),
shortcuts=[
models.Shortcut(
input_alias="<value>",
),
],
custom_data={
"someCustomField": models.CustomDataValue(),
},
),
),
),
],
input_details=models.SearchRequestInputDetails(
has_copy_paste=True,
),
),
results=[
models.SearchResult(
title="title",
url="https://example.com/foo/bar",
native_app_url="slack://foo/bar",
snippets=[
models.SearchResultSnippet(
snippet="snippet",
mime_type="mimeType",
),
],
),
],
),
models.RelatedDocuments(
query_suggestion=models.QuerySuggestion(
query="app:github type:pull author:mortimer",
search_provider_info=models.SearchProviderInfo(
name="Google",
search_link_url_template="https://www.google.com/search?q={query}&hl=en",
),
label="Mortimer's PRs",
datasource="github",
request_options=models.SearchRequestOptions(
datasource_filter="JIRA",
datasources_filter=[
"JIRA",
],
query_overrides_facet_filters=True,
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_filter_sets=[
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
],
facet_bucket_size=129663,
auth_tokens=[
models.AuthToken(
access_token="123abc",
datasource="gmail",
scope="email profile https://www.googleapis.com/auth/gmail.readonly",
token_type="Bearer",
auth_user="1",
),
],
),
input_details=models.SearchRequestInputDetails(
has_copy_paste=True,
),
),
),
],
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
query_suggestions=models.QuerySuggestionList(
suggestions=[
models.QuerySuggestion(
query="app:github type:pull author:mortimer",
label="Mortimer's PRs",
datasource="github",
),
],
),
invite_info=models.InviteInfo(
invites=[
models.ChannelInviteInfo(),
models.ChannelInviteInfo(),
],
),
custom_fields=[
models.CustomFieldData(
label="<value>",
values=[
models.CustomFieldValueStr(),
],
),
models.CustomFieldData(
label="<value>",
values=[],
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.OWNER,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
],
"removed_roles": [
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.OWNER,
),
],
"roles": [
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.OWNER,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
],
"combined_answer_text": {
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
},
})
# Handle response
print(res){
"id": 3,
"docId": "ANSWERS_answer_3",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"combinedAnswerText": {
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structuredList": [
{
"link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
"document": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
},
"text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue."
}
]
},
"likes": {
"likedBy": [
{
"user": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z"
}
],
"likedByUser": true,
"numLikes": 123
},
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"verification": {
"state": "UNVERIFIED",
"metadata": {
"lastVerifier": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"lastVerificationTs": 123,
"expirationTs": 123,
"document": {},
"reminders": [
{
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
}
],
"lastReminder": {
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
},
"visitorCount": [
{
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
],
"candidateVerifiers": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
]
}
},
"board": {
"name": "<string>",
"description": "<string>",
"addedRoles": [
{}
],
"removedRoles": [
{}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"roles": [
{}
]
},
"collections": [
{
"name": "<string>",
"description": "<string>",
"addedRoles": [
{}
],
"removedRoles": [
{}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "<string>",
"adminLocked": true,
"parentId": 123,
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"allowedDatasource": "<string>",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"childCount": 123,
"items": [
{
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{}
],
"removedRoles": [
{}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
}
],
"pinMetadata": {
"existingPins": [
{
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
],
"eligiblePins": [
{
"id": 123,
"target": {
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
}
]
},
"shortcuts": [
"<string>"
],
"children": [
"<any>"
],
"roles": [
{}
]
}
],
"documentCategory": "<string>",
"sourceDocument": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
}
}