> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# affinda-search
> Affinda Search - resume and job description search and matching
**Server path:** `/affinda-search` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| [`affinda_search_create_document_from_data`](#affinda_search_create_document_from_data) | Create a document from raw data |
| [`affinda_search_create_index`](#affinda_search_create_index) | Create a new index |
| [`affinda_search_create_index_document`](#affinda_search_create_index_document) | Index a new document |
| [`affinda_search_create_job_description_search`](#affinda_search_create_job_description_search) | Search through parsed job descriptions |
| [`affinda_search_create_job_description_search_embed_url`](#affinda_search_create_job_description_search_embed_url) | Create a signed URL for the embeddable job description search tool |
| [`affinda_search_create_resume_search`](#affinda_search_create_resume_search) | Search through parsed resumes |
| [`affinda_search_create_resume_search_embed_url`](#affinda_search_create_resume_search_embed_url) | Create a signed URL for the embeddable resume search tool |
| [`affinda_search_delete_index`](#affinda_search_delete_index) | Delete an index |
| [`affinda_search_delete_index_document`](#affinda_search_delete_index_document) | Delete an indexed document |
| [`affinda_search_get_all_index_documents`](#affinda_search_get_all_index_documents) | Get indexed documents for a specific index |
| [`affinda_search_get_all_indexes`](#affinda_search_get_all_indexes) | Get list of all indexes |
| [`affinda_search_get_job_description_search_config`](#affinda_search_get_job_description_search_config) | Get the config for the logged in user's embeddable job description search tool |
| [`affinda_search_get_job_description_search_detail`](#affinda_search_get_job_description_search_detail) | Get search result of specific job description |
| [`affinda_search_get_resume_search_config`](#affinda_search_get_resume_search_config) | Get the config for the logged in user's embeddable resume search tool |
| [`affinda_search_get_resume_search_detail`](#affinda_search_get_resume_search_detail) | Get search result of specific resume |
| [`affinda_search_get_resume_search_match`](#affinda_search_get_resume_search_match) | Match a single resume and job description |
| [`affinda_search_get_resume_search_suggestion_job_title`](#affinda_search_get_resume_search_suggestion_job_title) | Get job title suggestions based on provided job title(s) |
| [`affinda_search_get_resume_search_suggestion_skill`](#affinda_search_get_resume_search_suggestion_skill) | Get skill suggestions based on provided skill(s) |
| [`affinda_search_list_occupation_groups`](#affinda_search_list_occupation_groups) | List occupation groups |
| [`affinda_search_re_index_document`](#affinda_search_re_index_document) | Re-index a document |
| [`affinda_search_update_document_data`](#affinda_search_update_document_data) | Update a document's data |
| [`affinda_search_update_job_description_search_config`](#affinda_search_update_job_description_search_config) | Update the config for the logged in user's embeddable job description search tool |
| [`affinda_search_update_resume_search_config`](#affinda_search_update_resume_search_config) | Update the config for the logged in user's embeddable resume search tool |
***
## affinda\_search\_create\_document\_from\_data
Create a document from raw data
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `snake_case` | boolean | No | — | Whether to return the response in snake\_case instead of camelCase. Default is false. |
| `data` | object | Yes | — | Create resume or job description directly from data. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"snake_case": {
"type": "boolean",
"description": "Whether to return the response in snake_case instead of camelCase. Default is false."
},
"data": {
"description": "Create resume or job description directly from data."
}
},
"required": [
"PCID",
"data"
]
}
```
***
## affinda\_search\_create\_index
Create a new index
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------- |
| `docType` | string | No | — | Doc Type |
| `name` | string | Yes | — | Unique index name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docType": {
"type": "string",
"description": "Doc Type",
"enum": [
"resumes",
"job_descriptions"
]
},
"name": {
"type": "string",
"description": "Unique index name"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## affinda\_search\_create\_index\_document
Index a new document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------ |
| `name` | string | Yes | — | Index name |
| `document` | string | No | — | The document value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Index name"
},
"document": {
"type": "string",
"description": "The document value"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## affinda\_search\_create\_job\_description\_search
Search through parsed job descriptions
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------------- | ---------- | -------- | ------- | -------------------------------------------------------------------------- | ---------------------- |
| `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | |
| `limit` | integer | No | — | The numbers of results to return. | |
| `customData` | object\[] | No | — | Custom Data | |
| `degrees` | string\[] | No | — | The degrees value | |
| `degreesRequired` | boolean | No | — | Degrees Required | |
| `degreeTypes` | string\[] | No | — | Degree Types | |
| `degreeTypesRequired` | boolean | No | — | Degree Types Required | |
| `educationWeight` | number | No | — | Education Weight | |
| `indices` | string\[] | Yes | — | The indices value | |
| `jobTitles` | string\[] | No | — | Job Titles | |
| `jobTitlesRequired` | boolean | No | — | Job Titles Required | |
| `jobTitlesWeight` | number | No | — | Job Titles Weight | |
| `languages` | object\[] | No | — | The languages value | |
| `languagesWeight` | number | No | — | Languages Weight | |
| `locations` | object\[] | No | — | The locations value | |
| `locationsRequired` | boolean | No | — | Locations Required | |
| `locationsWeight` | number | No | — | Locations Weight | |
| `managementLevel` | string | null | No | — | Management Level |
| `managementLevelRequired` | boolean | No | — | Management Level Required | |
| `managementLevelWeight` | number | No | — | Management Level Weight | |
| `resume` | string | No | — | A random string that uniquely identify the resource. | |
| `searchExpression` | string | null | No | — | Search Expression |
| `searchExpressionRequired` | boolean | No | — | Search Expression Required | |
| `searchExpressionWeight` | number | No | — | Search Expression Weight | |
| `skills` | object\[] | No | — | The skills value | |
| `skillsWeight` | number | No | — | Skills Weight | |
| `socCodes` | integer\[] | No | — | Soc Codes | |
| `socCodesRequired` | boolean | No | — | Soc Codes Required | |
| `socCodesWeight` | number | No | — | Soc Codes Weight | |
| `totalYearsExperience` | number | null | No | — | Total Years Experience |
| `yearsExperienceRequired` | boolean | No | — | Years Experience Required | |
| `yearsExperienceWeight` | number | No | — | Years Experience Weight | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offset": {
"type": "integer",
"description": "The number of documents to skip before starting to collect the result set."
},
"limit": {
"type": "integer",
"description": "The numbers of results to return."
},
"customData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"filterType": {
"type": "string",
"enum": [
"equals",
"range"
],
"description": "Data points of \"text\" type support only \"equals\" filterType, others support both \"equals\" and \"range\""
},
"dataPoint": {
"type": "string",
"description": "The data point's slug, used for portal v2 (deprecated)"
},
"field": {
"type": "string",
"description": "The field's slug"
},
"query": {
"type": "object",
"description": "\"equals\" searches require the \"value\" key inside the query, and \"range\" searches require at least one of \"gte\" (greater than or equal) and \"lte\" (less than or equal)"
},
"required": {
"type": "boolean",
"description": "The required value"
},
"weight": {
"type": "number",
"description": "The weight value"
}
},
"required": [
"filterType",
"query"
]
},
"description": "Custom Data"
},
"degrees": {
"type": "array",
"items": {
"type": "string"
},
"description": "The degrees value"
},
"degreesRequired": {
"type": "boolean",
"description": "Degrees Required"
},
"degreeTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"school",
"certificate",
"bachelors",
"masters",
"doctoral"
]
},
"description": "Degree Types"
},
"degreeTypesRequired": {
"type": "boolean",
"description": "Degree Types Required"
},
"educationWeight": {
"type": "number",
"description": "Education Weight"
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "The indices value"
},
"jobTitles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job Titles"
},
"jobTitlesRequired": {
"type": "boolean",
"description": "Job Titles Required"
},
"jobTitlesWeight": {
"type": "number",
"description": "Job Titles Weight"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The languages value"
},
"languagesWeight": {
"type": "number",
"description": "Languages Weight"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"coordinates": {
"type": "object",
"description": "The coordinates value"
},
"distance": {
"type": "integer",
"description": "The distance value"
},
"unit": {
"type": "string",
"enum": [
"km",
"mi"
],
"description": "The unit value"
}
}
},
"description": "The locations value"
},
"locationsRequired": {
"type": "boolean",
"description": "Locations Required"
},
"locationsWeight": {
"type": "number",
"description": "Locations Weight"
},
"managementLevel": {
"type": [
"string",
"null"
],
"description": "Management Level",
"enum": [
"None",
"Low",
"Mid",
"Upper"
]
},
"managementLevelRequired": {
"type": "boolean",
"description": "Management Level Required"
},
"managementLevelWeight": {
"type": "number",
"description": "Management Level Weight"
},
"resume": {
"type": "string",
"description": "A random string that uniquely identify the resource."
},
"searchExpression": {
"type": [
"string",
"null"
],
"description": "Search Expression"
},
"searchExpressionRequired": {
"type": "boolean",
"description": "Search Expression Required"
},
"searchExpressionWeight": {
"type": "number",
"description": "Search Expression Weight"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The skills value"
},
"skillsWeight": {
"type": "number",
"description": "Skills Weight"
},
"socCodes": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Soc Codes"
},
"socCodesRequired": {
"type": "boolean",
"description": "Soc Codes Required"
},
"socCodesWeight": {
"type": "number",
"description": "Soc Codes Weight"
},
"totalYearsExperience": {
"type": [
"number",
"null"
],
"description": "Total Years Experience"
},
"yearsExperienceRequired": {
"type": "boolean",
"description": "Years Experience Required"
},
"yearsExperienceWeight": {
"type": "number",
"description": "Years Experience Weight"
}
},
"required": [
"PCID",
"indices"
]
}
```
***
## affinda\_search\_create\_job\_description\_search\_embed\_url
Create a signed URL for the embeddable job description search tool
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | --------------- |
| `configOverride` | object | No | — | Config Override |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"configOverride": {
"type": "object",
"description": "Config Override",
"properties": {
"allowPdfDownload": {
"type": "boolean",
"description": "Allow Pdf Download"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation."
},
"displayJobTitle": {
"type": "boolean",
"description": "Display Job Title"
},
"displayLocation": {
"type": "boolean",
"description": "Display Location"
},
"displayYearsExperience": {
"type": "boolean",
"description": "Display Years Experience"
},
"displayOccupationGroup": {
"type": "boolean",
"description": "Display Occupation Group"
},
"displayEducation": {
"type": "boolean",
"description": "Display Education"
},
"displaySkills": {
"type": "boolean",
"description": "Display Skills"
},
"displayLanguages": {
"type": "boolean",
"description": "Display Languages"
},
"displayManagementLevel": {
"type": "boolean",
"description": "Display Management Level"
},
"displayKeywords": {
"type": "boolean",
"description": "Display Keywords"
},
"weightJobTitle": {
"type": "number",
"description": "Weight Job Title"
},
"weightLocation": {
"type": "number",
"description": "Weight Location"
},
"weightYearsExperience": {
"type": "number",
"description": "Weight Years Experience"
},
"weightOccupationGroup": {
"type": "number",
"description": "Weight Occupation Group"
},
"weightEducation": {
"type": "number",
"description": "Weight Education"
},
"weightSkills": {
"type": "number",
"description": "Weight Skills"
},
"weightLanguages": {
"type": "number",
"description": "Weight Languages"
},
"weightManagementLevel": {
"type": "number",
"description": "Weight Management Level"
},
"weightKeywords": {
"type": "number",
"description": "Weight Keywords"
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of index names."
},
"showIndexDropdown": {
"type": "boolean",
"description": "Controls whether or not the index dropdown is displayed to the user"
},
"searchToolTheme": {
"type": "object",
"description": "Customize the theme of the embeded search tool."
},
"userId": {
"type": "integer",
"description": "ID of the logged in user."
},
"username": {
"type": "string",
"description": "Username of the logged in user."
},
"actions": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of actions to show in the dropdown in the embedded search tool"
},
"hideToolbar": {
"type": "boolean",
"description": "Hide the reset/import toolbar."
},
"hideSidePanel": {
"type": "boolean",
"description": "Hide the entire side panel."
},
"customFieldsConfig": {
"type": "array",
"items": {
"type": "object"
},
"description": "Custom Fields Config"
},
"distanceUnit": {
"type": "string",
"description": "The unit of distance to use for location based searches",
"enum": [
"mi",
"km"
]
}
}
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_create\_resume\_search
Search through parsed resumes
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------------------- | ---------- | -------- | ------- | -------------------------------------------------------------------------- | -------------------------------------- |
| `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | |
| `limit` | integer | No | — | The numbers of results to return. | |
| `customData` | object\[] | No | — | Custom Data | |
| `degrees` | string\[] | No | — | The degrees value | |
| `degreesRequired` | boolean | No | — | Degrees Required | |
| `educationWeight` | number | No | — | Education Weight | |
| `highestDegreeTypes` | string\[] | No | — | Highest Degree Types | |
| `highestDegreeTypesRequired` | boolean | No | — | Highest Degree Types Required | |
| `indices` | string\[] | Yes | — | The indices value | |
| `institutions` | string\[] | No | — | The institutions value | |
| `institutionsRequired` | boolean | No | — | Institutions Required | |
| `isCurrentStudent` | boolean | No | — | Search for student canditates | |
| `isCurrentStudentRequired` | boolean | No | — | Is Current Student Required | |
| `isRecentGraduate` | boolean | No | — | Search for canditates that graduated less than a year ago | |
| `isRecentGraduateRequired` | boolean | No | — | Is Recent Graduate Required | |
| `jobDescription` | string | No | — | A random string that uniquely identify the resource. | |
| `jobTitles` | string\[] | No | — | Job Titles | |
| `jobTitlesCurrentOnly` | boolean | No | — | Search only through the canditate's current job | |
| `jobTitlesRequired` | boolean | No | — | Job Titles Required | |
| `jobTitlesWeight` | number | No | — | Job Titles Weight | |
| `languages` | object\[] | No | — | The languages value | |
| `languagesWeight` | number | No | — | Languages Weight | |
| `locations` | object\[] | No | — | Search by location name or by coordinates | |
| `locationsRequired` | boolean | No | — | Locations Required | |
| `locationsWeight` | number | No | — | Locations Weight | |
| `managementLevel` | string | null | No | — | Management Level |
| `managementLevelRequired` | boolean | No | — | Management Level Required | |
| `managementLevelWeight` | number | No | — | Management Level Weight | |
| `resume` | string | No | — | A random string that uniquely identify the resource. | |
| `searchExpression` | string | null | No | — | Search through resumes' raw text |
| `searchExpressionRequired` | boolean | No | — | Search Expression Required | |
| `searchExpressionWeight` | number | No | — | Search Expression Weight | |
| `skills` | object\[] | No | — | The skills value | |
| `skillsWeight` | number | No | — | Skills Weight | |
| `socCodes` | integer\[] | No | — | Soc Codes | |
| `socCodesRequired` | boolean | No | — | Soc Codes Required | |
| `socCodesWeight` | number | No | — | Soc Codes Weight | |
| `yearsExperienceMax` | integer | null | No | — | Maximum years of total work experience |
| `yearsExperienceMin` | integer | null | No | — | Minimum years of total work experience |
| `yearsExperienceRequired` | boolean | No | — | Years Experience Required | |
| `yearsExperienceWeight` | number | No | — | Years Experience Weight | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offset": {
"type": "integer",
"description": "The number of documents to skip before starting to collect the result set."
},
"limit": {
"type": "integer",
"description": "The numbers of results to return."
},
"customData": {
"type": "array",
"items": {
"type": "object"
},
"description": "Custom Data"
},
"degrees": {
"type": "array",
"items": {
"type": "string"
},
"description": "The degrees value"
},
"degreesRequired": {
"type": "boolean",
"description": "Degrees Required"
},
"educationWeight": {
"type": "number",
"description": "Education Weight"
},
"highestDegreeTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"school",
"certificate",
"bachelors",
"masters",
"doctoral"
]
},
"description": "Highest Degree Types"
},
"highestDegreeTypesRequired": {
"type": "boolean",
"description": "Highest Degree Types Required"
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "The indices value"
},
"institutions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The institutions value"
},
"institutionsRequired": {
"type": "boolean",
"description": "Institutions Required"
},
"isCurrentStudent": {
"type": "boolean",
"description": "Search for student canditates"
},
"isCurrentStudentRequired": {
"type": "boolean",
"description": "Is Current Student Required"
},
"isRecentGraduate": {
"type": "boolean",
"description": "Search for canditates that graduated less than a year ago"
},
"isRecentGraduateRequired": {
"type": "boolean",
"description": "Is Recent Graduate Required"
},
"jobDescription": {
"type": "string",
"description": "A random string that uniquely identify the resource."
},
"jobTitles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job Titles"
},
"jobTitlesCurrentOnly": {
"type": "boolean",
"description": "Search only through the canditate's current job"
},
"jobTitlesRequired": {
"type": "boolean",
"description": "Job Titles Required"
},
"jobTitlesWeight": {
"type": "number",
"description": "Job Titles Weight"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The languages value"
},
"languagesWeight": {
"type": "number",
"description": "Languages Weight"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"coordinates": {
"type": "object",
"description": "The coordinates value"
},
"distance": {
"type": "integer",
"description": "The distance value"
},
"unit": {
"type": "string",
"enum": [
"km",
"mi"
],
"description": "The unit value"
}
}
},
"description": "Search by location name or by coordinates"
},
"locationsRequired": {
"type": "boolean",
"description": "Locations Required"
},
"locationsWeight": {
"type": "number",
"description": "Locations Weight"
},
"managementLevel": {
"type": [
"string",
"null"
],
"description": "Management Level",
"enum": [
"None",
"Low",
"Mid",
"Upper"
]
},
"managementLevelRequired": {
"type": "boolean",
"description": "Management Level Required"
},
"managementLevelWeight": {
"type": "number",
"description": "Management Level Weight"
},
"resume": {
"type": "string",
"description": "A random string that uniquely identify the resource."
},
"searchExpression": {
"type": [
"string",
"null"
],
"description": "Search through resumes' raw text"
},
"searchExpressionRequired": {
"type": "boolean",
"description": "Search Expression Required"
},
"searchExpressionWeight": {
"type": "number",
"description": "Search Expression Weight"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The skills value"
},
"skillsWeight": {
"type": "number",
"description": "Skills Weight"
},
"socCodes": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Soc Codes"
},
"socCodesRequired": {
"type": "boolean",
"description": "Soc Codes Required"
},
"socCodesWeight": {
"type": "number",
"description": "Soc Codes Weight"
},
"yearsExperienceMax": {
"type": [
"integer",
"null"
],
"description": "Maximum years of total work experience"
},
"yearsExperienceMin": {
"type": [
"integer",
"null"
],
"description": "Minimum years of total work experience"
},
"yearsExperienceRequired": {
"type": "boolean",
"description": "Years Experience Required"
},
"yearsExperienceWeight": {
"type": "number",
"description": "Years Experience Weight"
}
},
"required": [
"PCID",
"indices"
]
}
```
***
## affinda\_search\_create\_resume\_search\_embed\_url
Create a signed URL for the embeddable resume search tool
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | --------------- |
| `configOverride` | object | No | — | Config Override |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"configOverride": {
"type": "object",
"description": "Config Override",
"properties": {
"allowPdfDownload": {
"type": "boolean",
"description": "Allow Pdf Download"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation."
},
"displayJobTitle": {
"type": "boolean",
"description": "Display Job Title"
},
"displayLocation": {
"type": "boolean",
"description": "Display Location"
},
"displayYearsExperience": {
"type": "boolean",
"description": "Display Years Experience"
},
"displayOccupationGroup": {
"type": "boolean",
"description": "Display Occupation Group"
},
"displayEducation": {
"type": "boolean",
"description": "Display Education"
},
"displaySkills": {
"type": "boolean",
"description": "Display Skills"
},
"displayLanguages": {
"type": "boolean",
"description": "Display Languages"
},
"displayManagementLevel": {
"type": "boolean",
"description": "Display Management Level"
},
"displayKeywords": {
"type": "boolean",
"description": "Display Keywords"
},
"weightJobTitle": {
"type": "number",
"description": "Weight Job Title"
},
"weightLocation": {
"type": "number",
"description": "Weight Location"
},
"weightYearsExperience": {
"type": "number",
"description": "Weight Years Experience"
},
"weightOccupationGroup": {
"type": "number",
"description": "Weight Occupation Group"
},
"weightEducation": {
"type": "number",
"description": "Weight Education"
},
"weightSkills": {
"type": "number",
"description": "Weight Skills"
},
"weightLanguages": {
"type": "number",
"description": "Weight Languages"
},
"weightManagementLevel": {
"type": "number",
"description": "Weight Management Level"
},
"weightKeywords": {
"type": "number",
"description": "Weight Keywords"
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of index names."
},
"showIndexDropdown": {
"type": "boolean",
"description": "Controls whether or not the index dropdown is displayed to the user"
},
"searchToolTheme": {
"type": "object",
"description": "Customize the theme of the embeded search tool."
},
"userId": {
"type": "integer",
"description": "ID of the logged in user."
},
"username": {
"type": "string",
"description": "Username of the logged in user."
},
"actions": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of actions to show in the dropdown in the embedded search tool"
},
"hideToolbar": {
"type": "boolean",
"description": "Hide the reset/import toolbar."
},
"hideSidePanel": {
"type": "boolean",
"description": "Hide the entire side panel."
},
"customFieldsConfig": {
"type": "array",
"items": {
"type": "object"
},
"description": "Custom Fields Config"
},
"distanceUnit": {
"type": "string",
"description": "The unit of distance to use for location based searches",
"enum": [
"mi",
"km"
]
}
}
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_delete\_index
Delete an index
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `name` | string | Yes | — | Index name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Index name"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## affinda\_search\_delete\_index\_document
Delete an indexed document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------- |
| `name` | string | Yes | — | Index name |
| `identifier` | string | Yes | — | Document identifier |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Index name"
},
"identifier": {
"type": "string",
"description": "Document identifier"
}
},
"required": [
"PCID",
"name",
"identifier"
]
}
```
***
## affinda\_search\_get\_all\_index\_documents
Get indexed documents for a specific index
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | -------------------------------------------------------------------------- |
| `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. |
| `limit` | integer | No | — | The numbers of results to return. |
| `name` | string | Yes | — | Index name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offset": {
"type": "integer",
"description": "The number of documents to skip before starting to collect the result set."
},
"limit": {
"type": "integer",
"description": "The numbers of results to return."
},
"name": {
"type": "string",
"description": "Index name"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## affinda\_search\_get\_all\_indexes
Get list of all indexes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- |
| `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. |
| `limit` | integer | No | — | The numbers of results to return. |
| `document_type` | string | No | — | Filter indices by a document type |
| `name` | string | No | — | Filter indices by name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offset": {
"type": "integer",
"description": "The number of documents to skip before starting to collect the result set."
},
"limit": {
"type": "integer",
"description": "The numbers of results to return."
},
"document_type": {
"type": "string",
"description": "Filter indices by a document type",
"enum": [
"resumes",
"job_descriptions"
]
},
"name": {
"type": "string",
"description": "Filter indices by name"
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_get\_job\_description\_search\_config
Get the config for the logged in user's embeddable job description search tool
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_get\_job\_description\_search\_detail
Get search result of specific job description
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------------- | ---------- | -------- | ------- | ---------------------------------------------------- | ---------------------- |
| `identifier` | string | Yes | — | Job Description identifier | |
| `customData` | object\[] | No | — | Custom Data | |
| `degrees` | string\[] | No | — | The degrees value | |
| `degreesRequired` | boolean | No | — | Degrees Required | |
| `degreeTypes` | string\[] | No | — | Degree Types | |
| `degreeTypesRequired` | boolean | No | — | Degree Types Required | |
| `educationWeight` | number | No | — | Education Weight | |
| `indices` | string\[] | Yes | — | The indices value | |
| `jobTitles` | string\[] | No | — | Job Titles | |
| `jobTitlesRequired` | boolean | No | — | Job Titles Required | |
| `jobTitlesWeight` | number | No | — | Job Titles Weight | |
| `languages` | object\[] | No | — | The languages value | |
| `languagesWeight` | number | No | — | Languages Weight | |
| `locations` | object\[] | No | — | The locations value | |
| `locationsRequired` | boolean | No | — | Locations Required | |
| `locationsWeight` | number | No | — | Locations Weight | |
| `managementLevel` | string | null | No | — | Management Level |
| `managementLevelRequired` | boolean | No | — | Management Level Required | |
| `managementLevelWeight` | number | No | — | Management Level Weight | |
| `resume` | string | No | — | A random string that uniquely identify the resource. | |
| `searchExpression` | string | null | No | — | Search Expression |
| `searchExpressionRequired` | boolean | No | — | Search Expression Required | |
| `searchExpressionWeight` | number | No | — | Search Expression Weight | |
| `skills` | object\[] | No | — | The skills value | |
| `skillsWeight` | number | No | — | Skills Weight | |
| `socCodes` | integer\[] | No | — | Soc Codes | |
| `socCodesRequired` | boolean | No | — | Soc Codes Required | |
| `socCodesWeight` | number | No | — | Soc Codes Weight | |
| `totalYearsExperience` | number | null | No | — | Total Years Experience |
| `yearsExperienceRequired` | boolean | No | — | Years Experience Required | |
| `yearsExperienceWeight` | number | No | — | Years Experience Weight | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Job Description identifier"
},
"customData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"filterType": {
"type": "string",
"enum": [
"equals",
"range"
],
"description": "Data points of \"text\" type support only \"equals\" filterType, others support both \"equals\" and \"range\""
},
"dataPoint": {
"type": "string",
"description": "The data point's slug, used for portal v2 (deprecated)"
},
"field": {
"type": "string",
"description": "The field's slug"
},
"query": {
"type": "object",
"description": "\"equals\" searches require the \"value\" key inside the query, and \"range\" searches require at least one of \"gte\" (greater than or equal) and \"lte\" (less than or equal)"
},
"required": {
"type": "boolean",
"description": "The required value"
},
"weight": {
"type": "number",
"description": "The weight value"
}
},
"required": [
"filterType",
"query"
]
},
"description": "Custom Data"
},
"degrees": {
"type": "array",
"items": {
"type": "string"
},
"description": "The degrees value"
},
"degreesRequired": {
"type": "boolean",
"description": "Degrees Required"
},
"degreeTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"school",
"certificate",
"bachelors",
"masters",
"doctoral"
]
},
"description": "Degree Types"
},
"degreeTypesRequired": {
"type": "boolean",
"description": "Degree Types Required"
},
"educationWeight": {
"type": "number",
"description": "Education Weight"
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "The indices value"
},
"jobTitles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job Titles"
},
"jobTitlesRequired": {
"type": "boolean",
"description": "Job Titles Required"
},
"jobTitlesWeight": {
"type": "number",
"description": "Job Titles Weight"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The languages value"
},
"languagesWeight": {
"type": "number",
"description": "Languages Weight"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"coordinates": {
"type": "object",
"description": "The coordinates value"
},
"distance": {
"type": "integer",
"description": "The distance value"
},
"unit": {
"type": "string",
"enum": [
"km",
"mi"
],
"description": "The unit value"
}
}
},
"description": "The locations value"
},
"locationsRequired": {
"type": "boolean",
"description": "Locations Required"
},
"locationsWeight": {
"type": "number",
"description": "Locations Weight"
},
"managementLevel": {
"type": [
"string",
"null"
],
"description": "Management Level",
"enum": [
"None",
"Low",
"Mid",
"Upper"
]
},
"managementLevelRequired": {
"type": "boolean",
"description": "Management Level Required"
},
"managementLevelWeight": {
"type": "number",
"description": "Management Level Weight"
},
"resume": {
"type": "string",
"description": "A random string that uniquely identify the resource."
},
"searchExpression": {
"type": [
"string",
"null"
],
"description": "Search Expression"
},
"searchExpressionRequired": {
"type": "boolean",
"description": "Search Expression Required"
},
"searchExpressionWeight": {
"type": "number",
"description": "Search Expression Weight"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The skills value"
},
"skillsWeight": {
"type": "number",
"description": "Skills Weight"
},
"socCodes": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Soc Codes"
},
"socCodesRequired": {
"type": "boolean",
"description": "Soc Codes Required"
},
"socCodesWeight": {
"type": "number",
"description": "Soc Codes Weight"
},
"totalYearsExperience": {
"type": [
"number",
"null"
],
"description": "Total Years Experience"
},
"yearsExperienceRequired": {
"type": "boolean",
"description": "Years Experience Required"
},
"yearsExperienceWeight": {
"type": "number",
"description": "Years Experience Weight"
}
},
"required": [
"PCID",
"identifier",
"indices"
]
}
```
***
## affinda\_search\_get\_resume\_search\_config
Get the config for the logged in user's embeddable resume search tool
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_get\_resume\_search\_detail
Get search result of specific resume
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------------------- | ---------- | -------- | ------- | --------------------------------------------------------- | -------------------------------------- |
| `identifier` | string | Yes | — | Resume identifier | |
| `customData` | object\[] | No | — | Custom Data | |
| `degrees` | string\[] | No | — | The degrees value | |
| `degreesRequired` | boolean | No | — | Degrees Required | |
| `educationWeight` | number | No | — | Education Weight | |
| `highestDegreeTypes` | string\[] | No | — | Highest Degree Types | |
| `highestDegreeTypesRequired` | boolean | No | — | Highest Degree Types Required | |
| `indices` | string\[] | Yes | — | The indices value | |
| `institutions` | string\[] | No | — | The institutions value | |
| `institutionsRequired` | boolean | No | — | Institutions Required | |
| `isCurrentStudent` | boolean | No | — | Search for student canditates | |
| `isCurrentStudentRequired` | boolean | No | — | Is Current Student Required | |
| `isRecentGraduate` | boolean | No | — | Search for canditates that graduated less than a year ago | |
| `isRecentGraduateRequired` | boolean | No | — | Is Recent Graduate Required | |
| `jobDescription` | string | No | — | A random string that uniquely identify the resource. | |
| `jobTitles` | string\[] | No | — | Job Titles | |
| `jobTitlesCurrentOnly` | boolean | No | — | Search only through the canditate's current job | |
| `jobTitlesRequired` | boolean | No | — | Job Titles Required | |
| `jobTitlesWeight` | number | No | — | Job Titles Weight | |
| `languages` | object\[] | No | — | The languages value | |
| `languagesWeight` | number | No | — | Languages Weight | |
| `locations` | object\[] | No | — | Search by location name or by coordinates | |
| `locationsRequired` | boolean | No | — | Locations Required | |
| `locationsWeight` | number | No | — | Locations Weight | |
| `managementLevel` | string | null | No | — | Management Level |
| `managementLevelRequired` | boolean | No | — | Management Level Required | |
| `managementLevelWeight` | number | No | — | Management Level Weight | |
| `resume` | string | No | — | A random string that uniquely identify the resource. | |
| `searchExpression` | string | null | No | — | Search through resumes' raw text |
| `searchExpressionRequired` | boolean | No | — | Search Expression Required | |
| `searchExpressionWeight` | number | No | — | Search Expression Weight | |
| `skills` | object\[] | No | — | The skills value | |
| `skillsWeight` | number | No | — | Skills Weight | |
| `socCodes` | integer\[] | No | — | Soc Codes | |
| `socCodesRequired` | boolean | No | — | Soc Codes Required | |
| `socCodesWeight` | number | No | — | Soc Codes Weight | |
| `yearsExperienceMax` | integer | null | No | — | Maximum years of total work experience |
| `yearsExperienceMin` | integer | null | No | — | Minimum years of total work experience |
| `yearsExperienceRequired` | boolean | No | — | Years Experience Required | |
| `yearsExperienceWeight` | number | No | — | Years Experience Weight | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Resume identifier"
},
"customData": {
"type": "array",
"items": {
"type": "object"
},
"description": "Custom Data"
},
"degrees": {
"type": "array",
"items": {
"type": "string"
},
"description": "The degrees value"
},
"degreesRequired": {
"type": "boolean",
"description": "Degrees Required"
},
"educationWeight": {
"type": "number",
"description": "Education Weight"
},
"highestDegreeTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"school",
"certificate",
"bachelors",
"masters",
"doctoral"
]
},
"description": "Highest Degree Types"
},
"highestDegreeTypesRequired": {
"type": "boolean",
"description": "Highest Degree Types Required"
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "The indices value"
},
"institutions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The institutions value"
},
"institutionsRequired": {
"type": "boolean",
"description": "Institutions Required"
},
"isCurrentStudent": {
"type": "boolean",
"description": "Search for student canditates"
},
"isCurrentStudentRequired": {
"type": "boolean",
"description": "Is Current Student Required"
},
"isRecentGraduate": {
"type": "boolean",
"description": "Search for canditates that graduated less than a year ago"
},
"isRecentGraduateRequired": {
"type": "boolean",
"description": "Is Recent Graduate Required"
},
"jobDescription": {
"type": "string",
"description": "A random string that uniquely identify the resource."
},
"jobTitles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job Titles"
},
"jobTitlesCurrentOnly": {
"type": "boolean",
"description": "Search only through the canditate's current job"
},
"jobTitlesRequired": {
"type": "boolean",
"description": "Job Titles Required"
},
"jobTitlesWeight": {
"type": "number",
"description": "Job Titles Weight"
},
"languages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The languages value"
},
"languagesWeight": {
"type": "number",
"description": "Languages Weight"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"coordinates": {
"type": "object",
"description": "The coordinates value"
},
"distance": {
"type": "integer",
"description": "The distance value"
},
"unit": {
"type": "string",
"enum": [
"km",
"mi"
],
"description": "The unit value"
}
}
},
"description": "Search by location name or by coordinates"
},
"locationsRequired": {
"type": "boolean",
"description": "Locations Required"
},
"locationsWeight": {
"type": "number",
"description": "Locations Weight"
},
"managementLevel": {
"type": [
"string",
"null"
],
"description": "Management Level",
"enum": [
"None",
"Low",
"Mid",
"Upper"
]
},
"managementLevelRequired": {
"type": "boolean",
"description": "Management Level Required"
},
"managementLevelWeight": {
"type": "number",
"description": "Management Level Weight"
},
"resume": {
"type": "string",
"description": "A random string that uniquely identify the resource."
},
"searchExpression": {
"type": [
"string",
"null"
],
"description": "Search through resumes' raw text"
},
"searchExpressionRequired": {
"type": "boolean",
"description": "Search Expression Required"
},
"searchExpressionWeight": {
"type": "number",
"description": "Search Expression Weight"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"required": {
"type": "boolean",
"description": "The required value"
}
}
},
"description": "The skills value"
},
"skillsWeight": {
"type": "number",
"description": "Skills Weight"
},
"socCodes": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Soc Codes"
},
"socCodesRequired": {
"type": "boolean",
"description": "Soc Codes Required"
},
"socCodesWeight": {
"type": "number",
"description": "Soc Codes Weight"
},
"yearsExperienceMax": {
"type": [
"integer",
"null"
],
"description": "Maximum years of total work experience"
},
"yearsExperienceMin": {
"type": [
"integer",
"null"
],
"description": "Minimum years of total work experience"
},
"yearsExperienceRequired": {
"type": "boolean",
"description": "Years Experience Required"
},
"yearsExperienceWeight": {
"type": "number",
"description": "Years Experience Weight"
}
},
"required": [
"PCID",
"identifier",
"indices"
]
}
```
***
## affinda\_search\_get\_resume\_search\_match
Match a single resume and job description
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `resume` | string | Yes | — | Identify the resume to match. |
| `job_description` | string | Yes | — | Identify the job description to match. |
| `index` | string | No | — | Optionally, specify an index to search in. If not specified, will search in all indexes. |
| `search_expression` | string | No | — | Add keywords to the search criteria. |
| `job_titles_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `years_experience_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `locations_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `languages_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `skills_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `education_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `search_expression_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `soc_codes_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
| `management_level_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"resume": {
"type": "string",
"description": "Identify the resume to match."
},
"job_description": {
"type": "string",
"description": "Identify the job description to match."
},
"index": {
"type": "string",
"description": "Optionally, specify an index to search in. If not specified, will search in all indexes."
},
"search_expression": {
"type": "string",
"description": "Add keywords to the search criteria."
},
"job_titles_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"years_experience_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"locations_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"languages_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"skills_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"education_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"search_expression_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"soc_codes_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
},
"management_level_weight": {
"type": "number",
"description": "How important is this criteria to the matching score, range from 0 to 1."
}
},
"required": [
"PCID",
"resume",
"job_description"
]
}
```
***
## affinda\_search\_get\_resume\_search\_suggestion\_job\_title
Get job title suggestions based on provided job title(s)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ---------------------------------- |
| `job_titles` | string\[] | Yes | — | Job title to query suggestions for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"job_titles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job title to query suggestions for"
}
},
"required": [
"PCID",
"job_titles"
]
}
```
***
## affinda\_search\_get\_resume\_search\_suggestion\_skill
Get skill suggestions based on provided skill(s)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------ |
| `skills` | string\[] | Yes | — | Skill to query suggestions for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Skill to query suggestions for"
}
},
"required": [
"PCID",
"skills"
]
}
```
***
## affinda\_search\_list\_occupation\_groups
List occupation groups
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_re\_index\_document
Re-index a document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------- |
| `name` | string | Yes | — | Index name |
| `identifier` | string | Yes | — | Document identifier |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Index name"
},
"identifier": {
"type": "string",
"description": "Document identifier"
}
},
"required": [
"PCID",
"name",
"identifier"
]
}
```
***
## affinda\_search\_update\_document\_data
Update a document's data
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------ |
| `identifier` | string | Yes | — | Resume or Job Description identifier |
| `body` | object | Yes | — | Resume data to update |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Resume or Job Description identifier"
},
"body": {
"description": "Resume data to update"
}
},
"required": [
"PCID",
"identifier",
"body"
]
}
```
***
## affinda\_search\_update\_job\_description\_search\_config
Update the config for the logged in user's embeddable job description search tool
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `actions` | object\[] | No | — | A list of actions to show in the dropdown in the embedded search tool | |
| `allowPdfDownload` | boolean | No | — | Allow Pdf Download | |
| `customFieldsConfig` | object\[] | No | — | Custom Fields Config | |
| `displayEducation` | boolean | No | — | Display Education | |
| `displayJobTitle` | boolean | No | — | Display Job Title | |
| `displayKeywords` | boolean | No | — | Display Keywords | |
| `displayLanguages` | boolean | No | — | Display Languages | |
| `displayLocation` | boolean | No | — | Display Location | |
| `displayManagementLevel` | boolean | No | — | Display Management Level | |
| `displayOccupationGroup` | boolean | No | — | Display Occupation Group | |
| `displaySkills` | boolean | No | — | Display Skills | |
| `displayYearsExperience` | boolean | No | — | Display Years Experience | |
| `distanceUnit` | string | No | — | The unit of distance to use for location based searches | |
| `hideSidePanel` | boolean | No | — | Hide the entire side panel. | |
| `hideToolbar` | boolean | No | — | Hide the reset/import toolbar. | |
| `indices` | string\[] | No | — | List of index names. | |
| `maxResults` | integer | null | No | — | Maximum number of results that can be returned. Setting to "null" means no limitation. |
| `searchToolTheme` | object | No | — | Customize the theme of the embeded search tool. | |
| `showIndexDropdown` | boolean | null | No | — | Controls whether or not the index dropdown is displayed to the user |
| `userId` | integer | No | — | ID of the logged in user. | |
| `username` | string | No | — | Username of the logged in user. | |
| `weightEducation` | number | No | — | Weight Education | |
| `weightJobTitle` | number | No | — | Weight Job Title | |
| `weightKeywords` | number | No | — | Weight Keywords | |
| `weightLanguages` | number | No | — | Weight Languages | |
| `weightLocation` | number | No | — | Weight Location | |
| `weightManagementLevel` | number | No | — | Weight Management Level | |
| `weightOccupationGroup` | number | No | — | Weight Occupation Group | |
| `weightSkills` | number | No | — | Weight Skills | |
| `weightYearsExperience` | number | No | — | Weight Years Experience | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Human readable label to display in the UI"
},
"eventName": {
"type": "string",
"description": "Name of the event to be triggered"
}
},
"required": [
"label",
"eventName"
]
},
"description": "A list of actions to show in the dropdown in the embedded search tool"
},
"allowPdfDownload": {
"type": "boolean",
"description": "Allow Pdf Download"
},
"customFieldsConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataPoint": {
"type": "string",
"description": "Data point identifier."
},
"weight": {
"type": "number",
"description": "The weight value"
}
},
"required": [
"dataPoint",
"weight"
]
},
"description": "Custom Fields Config"
},
"displayEducation": {
"type": "boolean",
"description": "Display Education"
},
"displayJobTitle": {
"type": "boolean",
"description": "Display Job Title"
},
"displayKeywords": {
"type": "boolean",
"description": "Display Keywords"
},
"displayLanguages": {
"type": "boolean",
"description": "Display Languages"
},
"displayLocation": {
"type": "boolean",
"description": "Display Location"
},
"displayManagementLevel": {
"type": "boolean",
"description": "Display Management Level"
},
"displayOccupationGroup": {
"type": "boolean",
"description": "Display Occupation Group"
},
"displaySkills": {
"type": "boolean",
"description": "Display Skills"
},
"displayYearsExperience": {
"type": "boolean",
"description": "Display Years Experience"
},
"distanceUnit": {
"type": "string",
"description": "The unit of distance to use for location based searches",
"enum": [
"mi",
"km"
]
},
"hideSidePanel": {
"type": "boolean",
"description": "Hide the entire side panel."
},
"hideToolbar": {
"type": "boolean",
"description": "Hide the reset/import toolbar."
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of index names."
},
"maxResults": {
"type": [
"integer",
"null"
],
"description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation."
},
"searchToolTheme": {
"type": "object",
"description": "Customize the theme of the embeded search tool."
},
"showIndexDropdown": {
"type": [
"boolean",
"null"
],
"description": "Controls whether or not the index dropdown is displayed to the user"
},
"userId": {
"type": "integer",
"description": "ID of the logged in user."
},
"username": {
"type": "string",
"description": "Username of the logged in user."
},
"weightEducation": {
"type": "number",
"description": "Weight Education"
},
"weightJobTitle": {
"type": "number",
"description": "Weight Job Title"
},
"weightKeywords": {
"type": "number",
"description": "Weight Keywords"
},
"weightLanguages": {
"type": "number",
"description": "Weight Languages"
},
"weightLocation": {
"type": "number",
"description": "Weight Location"
},
"weightManagementLevel": {
"type": "number",
"description": "Weight Management Level"
},
"weightOccupationGroup": {
"type": "number",
"description": "Weight Occupation Group"
},
"weightSkills": {
"type": "number",
"description": "Weight Skills"
},
"weightYearsExperience": {
"type": "number",
"description": "Weight Years Experience"
}
},
"required": [
"PCID"
]
}
```
***
## affinda\_search\_update\_resume\_search\_config
Update the config for the logged in user's embeddable resume search tool
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `actions` | object\[] | No | — | A list of actions to show in the dropdown in the embedded search tool | |
| `allowPdfDownload` | boolean | No | — | Allow Pdf Download | |
| `customFieldsConfig` | object\[] | No | — | Custom Fields Config | |
| `displayEducation` | boolean | No | — | Display Education | |
| `displayJobTitle` | boolean | No | — | Display Job Title | |
| `displayKeywords` | boolean | No | — | Display Keywords | |
| `displayLanguages` | boolean | No | — | Display Languages | |
| `displayLocation` | boolean | No | — | Display Location | |
| `displayManagementLevel` | boolean | No | — | Display Management Level | |
| `displayOccupationGroup` | boolean | No | — | Display Occupation Group | |
| `displaySkills` | boolean | No | — | Display Skills | |
| `displayYearsExperience` | boolean | No | — | Display Years Experience | |
| `distanceUnit` | string | No | — | The unit of distance to use for location based searches | |
| `hideSidePanel` | boolean | No | — | Hide the entire side panel. | |
| `hideToolbar` | boolean | No | — | Hide the reset/import toolbar. | |
| `indices` | string\[] | No | — | List of index names. | |
| `maxResults` | integer | null | No | — | Maximum number of results that can be returned. Setting to "null" means no limitation. |
| `searchToolTheme` | object | No | — | Customize the theme of the embeded search tool. | |
| `showIndexDropdown` | boolean | null | No | — | Controls whether or not the index dropdown is displayed to the user |
| `userId` | integer | No | — | ID of the logged in user. | |
| `username` | string | No | — | Username of the logged in user. | |
| `weightEducation` | number | No | — | Weight Education | |
| `weightJobTitle` | number | No | — | Weight Job Title | |
| `weightKeywords` | number | No | — | Weight Keywords | |
| `weightLanguages` | number | No | — | Weight Languages | |
| `weightLocation` | number | No | — | Weight Location | |
| `weightManagementLevel` | number | No | — | Weight Management Level | |
| `weightOccupationGroup` | number | No | — | Weight Occupation Group | |
| `weightSkills` | number | No | — | Weight Skills | |
| `weightYearsExperience` | number | No | — | Weight Years Experience | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Human readable label to display in the UI"
},
"eventName": {
"type": "string",
"description": "Name of the event to be triggered"
}
},
"required": [
"label",
"eventName"
]
},
"description": "A list of actions to show in the dropdown in the embedded search tool"
},
"allowPdfDownload": {
"type": "boolean",
"description": "Allow Pdf Download"
},
"customFieldsConfig": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataPoint": {
"type": "string",
"description": "Data point identifier."
},
"weight": {
"type": "number",
"description": "The weight value"
}
},
"required": [
"dataPoint",
"weight"
]
},
"description": "Custom Fields Config"
},
"displayEducation": {
"type": "boolean",
"description": "Display Education"
},
"displayJobTitle": {
"type": "boolean",
"description": "Display Job Title"
},
"displayKeywords": {
"type": "boolean",
"description": "Display Keywords"
},
"displayLanguages": {
"type": "boolean",
"description": "Display Languages"
},
"displayLocation": {
"type": "boolean",
"description": "Display Location"
},
"displayManagementLevel": {
"type": "boolean",
"description": "Display Management Level"
},
"displayOccupationGroup": {
"type": "boolean",
"description": "Display Occupation Group"
},
"displaySkills": {
"type": "boolean",
"description": "Display Skills"
},
"displayYearsExperience": {
"type": "boolean",
"description": "Display Years Experience"
},
"distanceUnit": {
"type": "string",
"description": "The unit of distance to use for location based searches",
"enum": [
"mi",
"km"
]
},
"hideSidePanel": {
"type": "boolean",
"description": "Hide the entire side panel."
},
"hideToolbar": {
"type": "boolean",
"description": "Hide the reset/import toolbar."
},
"indices": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of index names."
},
"maxResults": {
"type": [
"integer",
"null"
],
"description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation."
},
"searchToolTheme": {
"type": "object",
"description": "Customize the theme of the embeded search tool."
},
"showIndexDropdown": {
"type": [
"boolean",
"null"
],
"description": "Controls whether or not the index dropdown is displayed to the user"
},
"userId": {
"type": "integer",
"description": "ID of the logged in user."
},
"username": {
"type": "string",
"description": "Username of the logged in user."
},
"weightEducation": {
"type": "number",
"description": "Weight Education"
},
"weightJobTitle": {
"type": "number",
"description": "Weight Job Title"
},
"weightKeywords": {
"type": "number",
"description": "Weight Keywords"
},
"weightLanguages": {
"type": "number",
"description": "Weight Languages"
},
"weightLocation": {
"type": "number",
"description": "Weight Location"
},
"weightManagementLevel": {
"type": "number",
"description": "Weight Management Level"
},
"weightOccupationGroup": {
"type": "number",
"description": "Weight Occupation Group"
},
"weightSkills": {
"type": "number",
"description": "Weight Skills"
},
"weightYearsExperience": {
"type": "number",
"description": "Weight Years Experience"
}
},
"required": [
"PCID"
]
}
```