openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Tests API
description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.
'
version: v63.0
contact:
name: Salesforce Developers
url: https://developer.salesforce.com/
license:
name: Salesforce Developer Terms
url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
description: Salesforce Bulk API 2.0 jobs endpoint
variables:
instance:
default: yourInstance
description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).
'
version:
default: '63.0'
description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.
'
security:
- BearerAuth: []
tags:
- name: Tests
paths:
/data/v64.0/einstein/ai-evaluations/runs:
parameters: []
post:
tags:
- Tests
summary: Salesforce Run Agent Test
description: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
operationId: Runagenttest
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RunagenttestRequest'
- examples:
- aiEvaluationDefinitionName: <YOUR_TEST_API_NAME>
contentMediaType: application/json
example:
aiEvaluationDefinitionName: <YOUR_TEST_API_NAME>
required: true
responses:
'201':
description: Created
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 10 Sep 2025 13:46:14 GMT
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
Connection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: keep-alive
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=183/5000000
Set-Cookie:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:14 GMT; Max-Age=31536000; secure
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Server:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: sfdcedge
X-SFDC-Request-Id:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 543c8913aa732b136328d39c8546b5ac
X-Request-Id:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 543c8913aa732b136328d39c8546b5ac
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Runagenttest'
- examples:
- runId: 4KBAU0000002oK54AI
status: NEW
contentMediaType: application/json
example:
runId: 4KBAU0000002oK54AI
status: NEW
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/einstein/ai-evaluations/runs/{runId}:
parameters: []
get:
tags:
- Tests
summary: Salesforce Get Test Status
description: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
operationId: Getteststatus
parameters:
- name: runId
in: path
description: Evaluation ID
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 10 Sep 2025 13:46:26 GMT
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
Connection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: keep-alive
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Set-Cookie:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:26 GMT; Max-Age=31536000; secure
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=183/5000000
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Server:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: sfdcedge
X-SFDC-Request-Id:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 9c6b1b17f16e5e4b538e836eb8def249
X-Request-Id:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 9c6b1b17f16e5e4b538e836eb8def249
X-SFDC-Edge-Cache:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: MISS
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Getteststatus'
- examples:
- startTime: '2025-09-10T13:46:14.000Z'
status: IN_PROGRESS
contentMediaType: application/json
example:
startTime: '2025-09-10T13:46:14.000Z'
status: IN_PROGRESS
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/einstein/ai-evaluations/runs/{runId}/results:
parameters: []
get:
tags:
- Tests
summary: Salesforce Get Test Results
description: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
operationId: Gettestresults
parameters:
- name: runId
in: path
description: Evaluation ID
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 10 Sep 2025 13:48:41 GMT
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
Connection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: keep-alive
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
Set-Cookie:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:48:38 GMT; Max-Age=31536000; secure
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=185/5000000
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Server:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: sfdcedge
X-SFDC-Request-Id:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 238f419aa5f27f4e5a4cb714c7dfde45
X-Request-Id:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 238f419aa5f27f4e5a4cb714c7dfde45
X-SFDC-Edge-Cache:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: MISS
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Gettestresults'
- examples:
- endTime: '2025-09-10T13:48:31.000Z'
startTime: '2025-09-10T13:46:14.000Z'
status: COMPLETED
subjectName: Employee_agent_tests
testCases:
- endTime: '2025-09-10T13:46:30.000Z'
generatedData:
actionsSequence: '[]'
invokedActions: '[[]]'
outcome: To check the weather forecast at the resort, please provide the date you'd like to check.
sessionId: 019933e0-8597-70de-912b-359082a322b2
topic: Customer_Service_Assistant_16jAU0000003zGf
inputs:
contextVariables: {}
conversationHistory: []
utterance: What's the weather forecast at the resort?
startTime: '2025-09-10T13:46:14.000Z'
status: COMPLETED
testNumber: 1
testResults:
- actualValue: '[]'
endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
expectedValue: '[]'
metricLabel: actions_assertion
name: actions_assertion
result: PASS
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- actualValue: To check the weather forecast at the resort, please provide the date you'd like to check.
endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
expectedValue: Please provide a future date to check the weather forecast.
metricExplainability: The BOT RESPONSE correctly prompts the user for the necessary information (a future date) to provide the weather forecast, aligning well with the EXPECTED RESPONSE. It is clear and does not include irrelevant information.
metricLabel: output_validation
name: output_validation
result: PASS
score: 5
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- actualValue: Customer_Service_Assistant_16jAU0000003zGf
endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
expectedValue: Customer_Service_Assistant
metricLabel: topic_assertion
name: topic_assertion
result: PASS
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
metricExplainability: The answer is incomplete as it does not provide the weather forecast at the resort, instead it asks for the date to check the forecast.
metricLabel: completeness
name: completeness
result: FAILURE
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
metricExplainability: The answer is easy to understand, and it does not contain any significant grammar errors. The answer is also relevant to the question asked.
metricLabel: coherence
name: coherence
result: PASS
score: 4
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
metricLabel: conciseness
name: conciseness
result: PASS
score: 5
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:31.000Z'
errorCode: 0
metricLabel: output_latency_milliseconds
name: output_latency_milliseconds
score: 2352
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:40.000Z'
generatedData:
actionsSequence: '['Check_Weather_179AU00000038U5']'
citations: '[ ]'
invokedActions: '[[{"function":{"name":"Check_Weather_179AU00000038U5","input":{"dateToCheck":"2025-01-01"},"output":{}},"executionLatency":539}]]'
outcome: 'Hmm, it looks like I wasn’t able to retrieve the weather forecast for January 1st, 2025. The system I’d normally use to check this information didn’t respond as expected.
You might want to try checking a weather app or website closer to the date for the most accurate forecast. Let me know if there’s anything else I can help with! (Session ID: 019933e0-858f-7170-9bd7-5564c5e4c85a)'
sessionId: 019933e0-858f-7170-9bd7-5564c5e4c85a
topic: Customer_Service_Assistant_16jAU0000003zGf
inputs:
contextVariables: {}
conversationHistory: []
utterance: What's the weather forecast for Jan 1st, 2025 at the resort?
startTime: '2025-09-10T13:46:14.000Z'
status: COMPLETED
testNumber: 2
testResults:
- actualValue: '['Check_Weather_179AU00000038U5']'
endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
expectedValue: '['Check_Weather']'
metricLabel: actions_assertion
name: actions_assertion
result: PASS
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- actualValue: 'Hmm, it looks like I wasn’t able to retrieve the weather forecast for January 1st, 2025. The system I’d normally use to check this information didn’t respond as expected.
You might want to try checking a weather app or website closer to the date for the most accurate forecast. Let me know if there’s anything else I can help with! (Session ID: 019933e0-858f-7170-9bd7-5564c5e4c85a)'
endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
expectedValue: I can only provide weather forecasts for future dates. Please provide a future date.
metricExplainability: The BOT RESPONSE fails to address the user's QUERY for a specific forecast date and incorrectly states that it cannot retrieve the information. It does not align with the EXPECTED RESPONSE, which simply asks for a future date, indicating a misunderstanding of the user's request.
metricLabel: output_validation
name: output_validation
result: FAILURE
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- actualValue: Customer_Service_Assistant_16jAU0000003zGf
endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
expectedValue: Customer_Service_Assistant
metricLabel: topic_assertion
name: topic_assertion
result: PASS
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
metricExplainability: The answer is very incomplete as it does not provide any information about the weather forecast for Jan 1st, 2025 at the resort, which is the main request. It only mentions that the system did not respond as expected and suggests checking a weather app or website.
metricLabel: completeness
name: completeness
result: FAILURE
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
metricExplainability: The answer is generally understandable, but it contains a few grammar errors and sections that are unclear. The phrase 'The system I’d normally use to check this information didn’t respond as expected' is a bit confusing, and the suggestion to check a weather app or website closer to the date is not directly related to the original question.
metricLabel: coherence
name: coherence
result: PASS
score: 3
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
metricLabel: conciseness
name: conciseness
result: PASS
score: 5
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:42.000Z'
errorCode: 0
metricLabel: output_latency_milliseconds
name: output_latency_milliseconds
score: 11154
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:33.000Z'
generatedData:
actionsSequence: '['Check_Weather_179AU00000038U5']'
citations: '[ ]'
invokedActions: '[[{"function":{"name":"Check_Weather_179AU00000038U5","input":{"dateToCheck":"2025-09-11"},"output":{"weather":{"minTemperatureF":60.4,"minTemperatureC":15.8,"maxTemperatureF":78.3,"maxTemperatureC":25.7,"iconName":"rain","description":"On September 11, temperature will be between 15.8°C (60.4°F) and 25.7°C (78.3°F) at Coral Cloud Reso"}}},"executionLatency":510}]]'
outcome: 'Here's the weather forecast for tomorrow at Coral Cloud Resorts. Let me know if you need anything else!
{minTemperatureF=60.4, minTemperatureC=15.8, maxTemperatureF=78.3, maxTemperatureC=25.7, iconName=rain, description=On September 11, temperature will be between 15.8°C (60.4°F) and 25.7°C (78.3°F) at Coral Cloud Resorts.}'
sessionId: 019933e0-8571-720f-a404-546c9c2af263
topic: Customer_Service_Assistant_16jAU0000003zGf
inputs:
contextVariables: {}
conversationHistory: []
utterance: What's the weather forecast for tomorrow at the resort?
startTime: '2025-09-10T13:46:14.000Z'
status: COMPLETED
testNumber: 3
testResults:
- actualValue: '['Check_Weather_179AU00000038U5']'
endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
expectedValue: '['Check_Weather']'
metricLabel: actions_assertion
name: actions_assertion
result: PASS
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- actualValue: 'Here's the weather forecast for tomorrow at Coral Cloud Resorts. Let me know if you need anything else!
{minTemperatureF=60.4, minTemperatureC=15.8, maxTemperatureF=78.3, maxTemperatureC=25.7, iconName=rain, description=On September 11, temperature will be between 15.8°C (60.4°F) and 25.7°C (78.3°F) at Coral Cloud Resorts.}'
endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
expectedValue: The weather is expected to be sunny with a high of 85°F.
metricExplainability: The BOT RESPONSE provides detailed temperature information and conditions, but it does not align with the EXPECTED RESPONSE, which specifies a sunny forecast with a high of 85°F. The response includes unnecessary details and does not match the expected weather conditions.
metricLabel: output_validation
name: output_validation
result: FAILURE
score: 2
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- actualValue: Customer_Service_Assistant_16jAU0000003zGf
endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
expectedValue: Customer_Service_Assistant
metricLabel: topic_assertion
name: topic_assertion
result: PASS
score: 1
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
metricExplainability: The answer provides the weather forecast for tomorrow at the resort, including the minimum and maximum temperatures in both Celsius and Fahrenheit, as well as the icon name and description. The answer does not miss any important pieces of information, ensuring clarity and accuracy.
metricLabel: completeness
name: completeness
result: PASS
score: 4
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
metricExplainability: The answer is generally understandable, but it contains some sections that are unclear, such as the use of 'Coral Cloud Resorts' twice, and the mention of 'On September 11' which is not relevant to the weather forecast for tomorrow. The answer also contains a few grammar errors, such as the use of 'Let me know if you need anything else!' which is not relevant to the weather forecast.
metricLabel: coherence
name: coherence
result: PASS
score: 3
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
metricLabel: conciseness
name: conciseness
result: PASS
score: 4
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:34.000Z'
errorCode: 0
metricLabel: output_latency_milliseconds
name: output_latency_milliseconds
score: 2788
startTime: '2025-09-10T13:46:16.000Z'
status: COMPLETED
- endTime: '2025-09-10T13:46:32.000Z'
generatedData:
actionsSequence: '['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']'
citations: '[ ]'
invokedActions: '[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"nonexistent@example.com"},"output":{"contactId":null,"contactRecord":null}},"executionLatency":237}]]'
outcome: I couldn't find any contact details associated with the email address "nonexistent@example.com". Let me know if you'd like me to try searching with a different email or membership number!
sessionId: 019933e0-85a6-74d0-bfa4-841e8c8a03d3
topic: Customer_Service_Assistant_16jAU0000003zGf
inputs:
contextVariables: {}
conversationHistory: []
utterance: Can you provide the det
# --- truncated at 32 KB (365 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-tests-api-openapi.yml